Husky 和 Lint-Staged 入门指南：实现 Git 提交的自动代码检查和格式化

2023-10-19 08:40:26

Husky 与 Lint-Staged 入门指南：自动化 Git 提交代码检查和格式化

欢迎各位开发者！在当今快速发展的软件开发领域，维护代码质量至关重要。为了确保代码库的健壮性和一致性，我们必须制定有效的措施，在提交代码时自动执行代码检查和格式化。这就是 Husky 和 Lint-Staged 登场的时候了！

Husky 是一个 Git 钩子管理器，它允许您在特定的 Git 事件（例如提交和推送）触发自定义脚本。这使得您可以轻松地执行任务，例如在提交代码时运行代码检查或格式化工具。

Lint-Staged 是一种 Git 预提交钩子，专门用于在暂存（staged）的文件上运行代码检查和格式化命令。与 Husky 一起使用时，它使您能够在提交前对代码进行快速而有效的验证，从而避免不必要的提交错误。

要使用 Husky 和 Lint-Staged，请按照以下步骤操作：

安装 Husky 和 Lint-Staged
- 在您的项目目录中，使用 npm 安装 Husky 和 Lint-Staged：
```
npm install husky lint-staged --dev
```
创建 Husky 配置文件
- 在项目根目录中创建一个名为 .huskyrc.js 的文件，其中包含以下内容：
```
module.exports = {
  hooks: {
    'pre-commit': 'lint-staged',
  },
};
```
创建 Lint-Staged 配置文件
- 在项目根目录中创建一个名为 .lintstagedrc.js 的文件，其中包含以下内容：
```
module.exports = {
  '*': ['eslint --fix', 'prettier --write'],
};
```