14.2.标准化大厂编程规范解决方案之 ESLint + Git Hooks1.配置tsup 执行pnpm i tsup

标准化大厂编程规范解决方案之 ESLint + Git Hooks

1. `eslint`创建

zh-hans.eslint.org/docs/latest…

1.配置

npm init @eslint/config

打开 VSCode 的设置（File > Preferences > Settings 或按 Ctrl + ,）。
搜索 ESLint，找到以下设置并启用： _ ESLint: Enable：确保此选项已启用。 _ ESLint: Validate：选择需要验证的文件类型（如 JavaScript、TypeScript）。
- ESLint: Auto Fix On Save（可选）：启用此选项后，保存文件时会自动修复一些 ESLint 错误。

配置根目录文件 .prettierrc

{
  "semi": true,
  "singleQuote": false,
  "trailingComma": "none"
}

解决.prettierrc和eslint.config.mts冲突兼容 pnpm install --save-dev eslint-config-prettier eslint-plugin-prettier 配置根目录文件 .eslintrc.cjs

import js from "@eslint/js";
import globals from "globals";
import tseslint from "typescript-eslint";
import pluginVue from "eslint-plugin-vue";
// import json from "@eslint/json";
// import markdown from "@eslint/markdown";
import { defineConfig } from "eslint/config";

export default defineConfig([
  {
    files: ["packages/**/*.{js,mjs,cjs,ts,mts,cts,vue}"],
    plugins: { js },
    extends: [
      "js/recommended",
      "plugin:prettier/recommended" // 解决eslint-config-prettier冲突
    ],
    languageOptions: { globals: { ...globals.browser, ...globals.node } },
    rules: {
      // "no-console": "error",
      quotes: "error"
    }
    //只校验packages目录下的代码
    // ignores: ["!packages/**", "node_modules/**", "dist/**"],
  },
  tseslint.configs.recommended,
  pluginVue.configs["flat/essential"],
  {
    files: ["**/*.vue"],
    languageOptions: { parserOptions: { parser: tseslint.parser } }
  }
  // {
  //   files: ["**/*.json"],
  //   plugins: { json },
  //   language: "json/json",
  //   extends: ["json/recommended"],
  // },
  // {
  //   files: ["**/*.jsonc"],
  //   plugins: { json },
  //   language: "json/jsonc",
  //   extends: ["json/recommended"],
  // },
  // {
  //   files: ["**/*.json5"],
  //   plugins: { json },
  //   language: "json/json5",
  //   extends: ["json/recommended"],
  // },
  // {
  //   files: ["**/*.md"],
  //   plugins: { markdown },
  //   language: "markdown/commonmark",
  //   extends: ["markdown/recommended"],
  // },
]);

配置.vscode/settings.json

{
  "files.autoSave": "onWindowChange",
  "editor.formatOnSave": true
}

2.使用 husky + commitlint 检查提交描述是否符合规范要求

1.commitlint

安装依赖：

npm install --save-dev @commitlint/config-conventional @commitlint/cli

创建 commitlint.config.js 文件

echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

打开 commitlint.config.js ，增加配置项（ config-conventional 默认配置点击可查看）：

module.exports = {
  // 继承的规则
  extends: ["@commitlint/config-conventional"],
  // 定义规则类型
  rules: {
    // type 类型定义，表示 git 提交的 type 必须在以下类型范围内
    "type-enum": [
      2,
      "always",
      [
        "feat", // 新功能 feature
        "fix", // 修复 bug
        "docs", // 文档注释
        "style", // 代码格式(不影响代码运行的变动)
        "refactor", // 重构(既不增加新功能，也不是修复bug)
        "perf", // 性能优化
        "test", // 增加测试
        "chore", // 构建过程或辅助工具的变动
        "revert", // 回退
        "build" // 打包
      ]
    ],
    // subject 大小写不做校验
    "subject-case": [0]
  }
};

注意：确保保存为 UTF-8 的编码格式，否则可能会出现错误：

2.husky

安装依赖：
```
npm install husky --save-dev
```
启动 hooks ，生成 .husky 文件夹

npx husky install
在 package.json 中生成 prepare 指令（ 需要 npm > 7.0 版本 ）

npm set-script prepare "husky install"
执行 prepare 指令

npm run prepare
执行成功，提示
添加 commitlint 的 hook 到 husky中，并指令在 commit-msg 的 hooks 下执行 npx --no-install commitlint --edit "$1" 指令
```
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
```
此时的 .husky 的文件结构 ![image-20210710120228931]( 第二章：标准化大厂编程规范解决方案之 ESLint + Git Hooks .assets/image-20210710120228931.png)

至此，不符合规范的 commit 将不再可提交：

3.通过 pre-commit 检测提交时代码规范

在 ESLint 与 Prettier 配合解决代码格式问题 的章节中，我们讲解了如何处理 本地！代码格式问题。

但是这样的一个格式处理问题，他只能够在本地进行处理，并且我们还需要 手动在 VSCode 中配置自动保存 才可以。那么这样就会存在一个问题，要是有人忘记配置这个东西了怎么办呢？他把代码写的乱七八糟的直接就提交了怎么办呢？

所以我们就需要有一种方式来规避这种风险。

那么想要完成这么一个操作就需要使用 husky 配合 eslint 才可以实现。

我们期望通过 husky 监测 pre-commit 钩子，在该钩子下执行 npx eslint --ext .js,.vue src 指令来去进行相关检测：

执行 npx husky add .husky/pre-commit "npx eslint --ext .js,.vue packages" 添加 commit 时的 hook （npx eslint --ext .js,.vue src 会在执行到该 hook 时运行）
该操作会生成对应文件 pre-commit： ![image-20210906204043915](第二章：标准化大厂编程规范解决方案之 ESLint + Git Hooks .assets/image-20210906204043915.png)
关闭 VSCode 的自动保存操作
修改一处代码，使其不符合 ESLint 校验规则

执行 提交操作 会发现，抛出一系列的错误，代码无法提交

PS F:\xxxxxxxxxxxxxxxxxxx\imooc-admin> git commit -m 'test'

F:\xxxxxxxxxxxxxxxx\imooc-admin\src\views\Home.vue
  13:9  error  Strings must use singlequote  quotes

✖ 1 problem (1 error, 0 warnings)
  1 error and 0 warnings potentially fixable with the `--fix` option.

husky - pre-commit hook exited with code 1 (error)

想要提交代码，必须处理完成所有的错误信息

那么到这里位置，我们已经通过 pre-commit 检测到了代码的提交规范问题。

4. lint-staged 自动修复格式错误

在上一章中我们通过 pre-commit 处理了 检测代码的提交规范问题，当我们进行代码提交时，会检测所有的代码格式规范 。

但是这样会存在两个问题：

我们只修改了个别的文件，没有必要检测所有的文件代码格式
它只能给我们提示出对应的错误，我们还需要手动的进行代码修改

那么这一小节，我们就需要处理这两个问题

那么想要处理这两个问题，就需要使用另外一个插件 lint-staged ！

lint-staged 可以让你当前的代码检查 只检查本次修改更新的代码，并在出现错误的时候，自动修复并且推送 pnpm i lint-staged -D lint-staged 无需单独安装，我们生成项目时，vue-cli 已经帮助我们安装过了，所以我们直接使用就可以了

修改 package.json 配置

"lint-staged": {
    "src/**/*.{js,vue}": [
      "eslint --fix",
      "git add"
    ]
  }

如上配置，每次它只会在你本地 commit 之前，校验你提交的内容是否符合你本地配置的 eslint规则(这个见文档 ESLint )，校验会出现两种结果：
1. 如果符合规则：则会提交成功。
2. 如果不符合规则：它会自动执行 eslint --fix 尝试帮你自动修复，如果修复成功则会帮你把修复好的代码提交，如果失败，则会提示你错误，让你修好这个错误之后才能允许你提交代码。

修改 .husky/pre-commit 文件

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged

再次执行提交代码
发现 暂存区中 不符合 ESlint 的内容，被自动修复

14.2.标准化大厂编程规范解决方案之 ESLint + Git Hooks