pre-commit插件的使用：配合git提交代码之前代码注释规范的检测

1、插件介绍

    pre-commit 是一个用于管理代码提交前自动运行代码检查格式化工具。它可以帮助团队在提交代码前自动运行各种检查，其中包括检测注释规范的使用。
    pre-commit 官网地址：pre-commit.com/

2、使用说明

    要在前端项目中使用 pre-commit 来检测注释规范的使用，你可以配置 pre-commit 钩子来运行相应的代码检查工具，比如 ESLint 或者 Prettier。这些工具可以帮助你定义注释的规范，并在提交代码前自动检查是否符合规范。
    具体来说，你可以在项目中的 .pre-commit-config.yaml 文件中配置相应的钩子，比如使用 eslint 或 prettier 插件来检测注释规范的使用。例如：

-   repo: https://github.com/pre-commit/mirrors-eslint

    rev: v7.32.0

    hooks:

-   id: eslint

    这样配置之后，每次在提交代码前 pre-commit 都会自动运行 ESLint 来检测代码中的注释规范是否符合定义。

3、使用步骤

    在前端项目中使用 pre-commit 来检测注释规范的使用，你可以按照以下步骤进行：

3.1、安装 pre-commit：首先，在你的前端项目中，确保已经安装了 pre-commit。你可以通过在命令行中执行 npm install pre-commit 来安装 pre-commit。

3.2、创建 .pre-commit-config.yaml 文件：在项目根目录下创建一个名为 .pre-commit-config.yaml 的文件。这个文件将包含 pre-commit 钩子的配置信息。

3.3、配置注释规范检测钩子：在 .pre-commit-config.yaml 文件中，添加一个或多个钩子来运行用于检测注释规范的工具，比如 ESLint 或者 Prettier。

3.4、在命令行中执行 pre-commit install 命令，这将会根据 .pre-commit-config.yaml 中的配置安装相应的钩子。

3.5、运行 pre-commit 安装：在命令行中执行 pre-commit install 命令，这将会根据 .pre-commit-config.yaml 中的配置安装相应的钩子

4、提交代码

     pre-commit 安装完成，每次你在提交代码前，pre-commit 都会自动运行配置的钩子来检测代码中的注释规范是否符合定义。
    通过以上步骤，你就可以在前端项目中使用 pre-commit 来检测注释规范的使用了。

5、常用注释规范的配置

5.1 在 ESLint 的配置文件中，通过配置相关的规则来检测代码中是否添加了注释：

具体配置如下：

module.exports = {

  // ... 其他配置

  rules: {

    'require-jsdoc': ['error', {

      require: {

        FunctionDeclaration: true,

        MethodDefinition: true,

        ClassDeclaration: true,

      },

    }],

    // 其他规则

  }

};

    上面的配置中，’require-jsdoc’ 规则用于强制要求在函数声明、方法定义和类声明中添加注释。如果代码中缺少相应的注释，ESLint 将会发出相应的错误或警告。
通过配置类似的规则，你可以使用 ESLint 来检测代码中是否添加了注释。

5.2 配置 ESLint 来检测代码是否在 TypeScript 的类型定义时添加了注释。

    首先，你需要确保你的项目中安装了 @typescript-eslint/eslint-plugin 和 @typescript-eslint/parser 这两个包。然后，在 ESLint 的配置文件中，你可以使用 @typescript-eslint/eslint-plugin 提供的规则来检测类型定义时的注释情况。
    以下是一个示例 ESLint 配置文件，用于检测 TypeScript 类型定义时是否添加了注释：

module.exports = {

  // ... 其他配置

 

  plugins: ['@typescript-eslint'],

  parser: '@typescript-eslint/parser',

  parserOptions: {

    ecmaVersion: 2021,

    sourceType: 'module',

  },

  extends: [

    'plugin:@typescript-eslint/recommended',

    // 其他扩展

  ],

  rules: {

    '@typescript-eslint/no-unused-vars': 'error',

    '@typescript-eslint/explicit-module-boundary-types': 'off',

    '@typescript-eslint/no-explicit-any': 'off',

// 规则用于检测 TypeScript 类型定义中的 // @ts- 注释，你可以根据实际需求添加其他相关的规则来检测类型定义时的注释情况

    '@typescript-eslint/ban-ts-comment': 'warn', 

    // 其他规则

  }

};

    通过配置类似的规则，你可以使用 ESLint 来检测 TypeScript 类型定义时是否添加了注释。

    当然我们可以根据项目需求定制化配置来满足团队的要求。

原文链接：https://juejin.cn/post/7337112282575667210 作者：伸个大懒腰