lint-staged 使用教程

lint-staged 使用教程

lint-staged项目地址:https://gitcode.com/gh_mirrors/lin/lint-staged

项目介绍

lint-staged 是一个在 Git 暂存文件上运行 linters 的工具。它可以帮助开发者在提交代码前自动执行代码格式化和检查，确保代码质量。lint-staged 通常与 husky 结合使用，以便在 Git 提交前自动触发 lint 检查。

项目快速启动

以下是快速启动 lint-staged 的步骤：

1. 安装依赖：

   npm install --save-dev lint-staged husky
   

2. 配置 package.json：

   {
     "husky": {
       "hooks": {
         "pre-commit": "lint-staged"
       }
     },
     "lint-staged": {
       "*.js": ["eslint --fix", "prettier --write"]
     }
   }
   

3. 初始化 husky：

   npx husky install
   

4. 测试配置： 修改一些文件并暂存它们：

   git add .
   git commit -m "Test lint-staged"
   

应用案例和最佳实践

应用案例

假设你有一个 JavaScript 项目，使用 ESLint 进行代码检查，使用 Prettier 进行代码格式化。你可以配置 lint-staged 在每次提交前自动修复和格式化代码。

最佳实践

• 配置文件：使用 lint-staged 字段在 package.json 中配置，或者使用独立的配置文件如 .lintstagedrc。
• 并行任务：通过 --concurrent 选项控制任务的并行执行。
• 忽略文件：在任务本身中配置忽略文件，例如在 Prettier 的 .prettierignore 文件中添加需要忽略的目录。

典型生态项目

lint-staged 通常与以下项目结合使用：

• husky：用于管理 Git hooks，确保在特定 Git 事件（如提交、推送）时执行脚本。
• ESLint：JavaScript 代码检查工具。
• Prettier：代码格式化工具。

通过这些工具的结合使用，可以有效提升代码质量和开发效率。

lint-staged项目地址:https://gitcode.com/gh_mirrors/lin/lint-staged