Hasky超级大保姆，教你用git commit搞定eslint校验

告别代码质量难题：使用 Husky 自动化 ESLint 检查

背景

作为开发者，我们深知 ESLint 检查对于保证代码质量至关重要。然而，在实际开发中，我们往往会忘记在提交代码前运行 ESLint，导致提交了不合格的代码。

解决方案：Husky 的自动化力量

Husky 是一个强大的 Git 钩子工具，可以帮助我们解决这一问题。它允许我们自动在提交代码前执行特定的命令，比如 ESLint 检查。

步骤：使用 Husky 实现自动化 ESLint 检查

1. 安装 Husky

   使用以下命令安装 Husky：

   npm install husky --save-dev
   

2. 配置 Husky

   在项目根目录下创建 .husky/ 文件夹，并在其中创建 .git/hooks/ 文件。

   cd <project-root>
   mkdir .husky
   touch .husky/pre-commit
   

3. 编辑 .husky/pre-commit 文件

   在 .husky/pre-commit 文件中，添加以下内容：

   #!/bin/sh
   npx eslint --fix
   
   if [ $? -ne 0 ]; then
     exit 1
   fi
   

4. 测试 Husky

   执行以下命令测试 Husky：

   git commit -m "feat: add new feature"
   

   预期结果：

   • 代码通过 ESLint 检查：

     > npx eslint --fix
     
     ✨  Done in 0.19s.
     ✔  Passed linting tests for 10 files.
     

   • 代码未通过 ESLint 检查：

     > npx eslint --fix
     
     ✖  Failed linting tests for 10 files.
     1:1  error  'console' is not defined  no-console
     

好处：

通过使用 Husky 自动化 ESLint 检查，我们可以享受以下好处：

• 无缝集成： Husky 无缝集成到 Git 工作流中，无需手动操作。
• 强制代码质量： 它强制我们在提交代码前解决 ESLint 错误，确保代码质量。
• 节省时间： 它省去了在提交前手动运行 ESLint 的时间，提高了开发效率。
• 团队一致性： 它确保团队中的所有开发者都遵守相同的代码风格和规则。

结论

Husky 是一个强大的工具，可以帮助我们实现自动化 ESLint 检查。通过整合到 Git 工作流中，它可以显著提高代码质量，节省时间，并促进团队一致性。拥抱 Husky 的力量，释放代码的真正潜力！

常见问题解答

1. 为什么要使用 Husky，而不是在提交前手动运行 ESLint？
   Husky 自动化了 ESLint 检查过程，无需手动操作，确保一致性和效率。

2. 为什么需要 --fix 选项？
   --fix 选项自动修复可修复的 ESLint 错误，节省时间和精力。

3. 是否可以自定义 .husky/pre-commit 文件？
   是的，你可以自定义该文件以执行其他任务，比如运行其他 linter 或测试脚本。

4. 如果提交了不合格的代码怎么办？
   Husky 将阻止提交，并提示你解决 ESLint 错误。

5. 是否可以在多个项目中使用 Husky？
   是的，可以在多个项目中使用 Husky，只需按照上述步骤为每个项目配置即可。