利用node检查git commit的文件名是否规范

最新推荐文章于 2024-08-29 07:51:09 发布

原创最新推荐文章于 2024-08-29 07:51:09 发布 · 1.1k 阅读

0 ·

CC 4.0 BY-SA版权

前端杂事专栏收录该内容

205 篇文章

订阅专栏

本文探讨了如何利用Husky在前端项目中优化Git工作流程，通过定义预提交钩子检查文件名规范，确保代码质量。介绍了如何在package.json中配置Husky，以及使用Node.js脚本来实现文件名校验。

hooks

利用git的hooks来触发文件名校验，了解到husky能够很好的帮助我们在前端工程项目里在hooks中执行相关命令，因此安装husky依赖，并在package.json中定义：

  "husky": {
    "hooks": {
      "pre-commit": "node scripts/check-git-files",
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },

shell or node?

本来是有思考采用shell还是node来写代码的，不过根据本人技术栈还是选择了node了，毕竟是fe嘛。
直接写shell的话适合修改.git/hooks文件中的pre-commit文件，这样就不依赖husky了，可以迁移到任何项目中。

how to check? rule?

实现思路：

获取提交的文件名 git diff --cached --name-only

const {execSync} = require('child_process');
const getCommandRetVal = command => {
    return execSync(command).toString('utf8').trim();
};
// 获取到待提交文件名列表
const filenames = getCommandRetVal('git diff --cached --name-only').split('\n');

设置待检测的文件夹列表 – 同时需要豁免test,mock文件
收集命名不规范的文件路径
判断badFileNames数组是否为空
退出

const exitPreCommit = (...reason) => {
    reason && console.error(...reason);
    // 退出pre-commit, 非0代表异常退出 0 会继续进入后续程序
    // https://nodejs.org/api/process.html#process_process_exit_code
    process.exit(-1);
};