使用 ESLint 自动化校验

104 阅读1分钟

在团队协作开发中,代码的一致性对提高项目的可维护性和协作效率很重要。

每个开发者的编码习惯可能不同,比如缩进、空格、换行等,导致代码风格不统一。为了避免这些问题,我们可以使用自动化工具来强制执行统一的编码规范,ESLint 和 Stylelint 就是其中非常常用的两款工具。

(以下以 ESlint 为例)

1. 安装 ESLint 插件

首先,我们需要在编译器中安装 ESLint 插件。以 VSCode 为例,可以通过以下步骤进行安装:

  1. 打开编译器的插件管理页面。
  2. 搜索 ESLint 插件并点击安装

image.png

2. 配置 ESLint 规则

安装插件后,我们需要配置 ESLint 规则,以便在编写代码时自动进行检查。打开 VSCode 设置,按照以下步骤操作:

  1. 进入 Code → Preferences → Settings

  2. 在搜索框中输入“eslint”。

    image.png

  3. 在设置中加入或修改以下内容:

    {
        "editor.codeActionsOnSave": {
            "source.fixAll.eslint": "explicit",
            "source.organizeImports": "explicit",
            "source.fixAll.stylelint": true
        },
        "eslint.format.enable": true,
        "eslint.validate": [
            "javascript",
            "typescript"
        ],
        "eslint.codeActionsOnSave.rules": [
            "*"
        ],
        "editor.formatOnSave": false,
        "stylelint.enable": true,
        "stylelint.validate": ["css", "scss"]
    }
    

配置完成后,每次保存 .js.ts 文件时,ESLint 就会自动校验并应用项目中的代码规范。类似地,Stylelint 也可以配置检查 CSS 或 SCSS 文件。

3. 保存并重启编译器

完成配置后,记得保存配置文件并重启编译器。下一次编辑并保存对应文件时,ESLint 会根据配置的规则自动进行代码检查和修复,确保代码规范统一。