前端开发必备：使用Husky与Lint-Staged规范Git提交信息

前端

2023-04-04 03:33:29

使用 Husky 和 Lint-Staged 提升 Git 提交规范

在前端项目开发中，代码提交是不可或缺的环节。为了确保代码库的整洁和可维护性，规范 Git 提交信息至关重要。而 Husky 和 Lint-Staged 就是两款强有力的工具，可以轻松实现这一目标。

Husky：Git 钩子利器

Husky 是一个 Git 钩子工具，它可以在提交代码前后执行特定的任务。通过 Husky，我们可以轻松实现代码检查、格式化和测试等功能，确保代码质量。

Lint-Staged：代码检查哨兵

Lint-Staged 是一个 Git 预提交钩子，它会在代码提交前对暂存区中的文件进行检查。它可以帮助我们确保代码符合编码规范、风格一致，并满足一定的测试覆盖率要求。

Husky 和 Lint-Staged 协同作战

将 Husky 和 Lint-Staged 结合使用，可以发挥出更强大的 Git 提交规范能力。我们可以通过以下步骤进行配置：

安装 Husky 和 Lint-Staged

npm install husky lint-staged --save-dev

配置 Husky
```
npx husky install
```
配置 Lint-Staged
```
npx lint-staged
```

添加提交前钩子

husky add .husky/pre-commit "lint-staged"

添加提交前检查脚本

npx lint-staged --config .lintstagedrc.js

代码示例

以下是 Husky 和 Lint-Staged 结合使用的一个示例代码：

/.husky/pre-commit

#!/bin/sh

# Check code style
npx lint-staged

# Check test coverage
npx jest --coverage

# Exit with an error if any of the checks fail
if [ $? -ne 0 ]; then
  exit 1
fi

/.lintstagedrc.js

module.exports = {
  # Lint all JavaScript files
  "*.js": [
    "eslint --fix",
  ],

  # Format all Markdown files
  "*.md": [
    "prettier --write",
  ],
};

优势和意义

使用 Husky 和 Lint-Staged 规范 Git 提交信息，可以带来诸多优势：