使用 ESLint 做代码规范检查

ESLint 是一款十分流行的 JavaScript 代码规范检查工具，它可以帮助我们避免一些常见的代码错误，统一团队的编码风格，提高代码的质量和可维护性。

安装

npm install eslint --save-dev

配置

ESLint 的配置文件为 .eslintrc.js，可以放在项目的根目录下，也可以放在子目录中。配置文件可以配置 规则、插件 和 扩展 等属性。

下面是一个简单的配置示例：

// .eslintrc.js
module.exports = {
  root: true, // ESLint 将会停止在父级目录中查找 .eslintrc.* 文件
  env: {
    node: true, // 启用 Node.js 全局变量和 Node.js 作用域
    es2021: true // 启用 ES2021 全局变量和 ES2021 作用域
  },
  extends: ['eslint:recommended'], // 使用 ESLint 推荐的规则
  parserOptions: {
    ecmaVersion: 12, // 指定 ECMAScript 版本为 12
    sourceType: 'module' // 指定模块化代码
  },
  rules: {
    // 自定义规则
    'no-console': 'off', // 允许使用 console
    'no-unused-vars': 'warn' // 警告未使用的变量
  }
}

运行

在终端中运行以下命令即可对指定的文件或目录进行代码检查：

npx eslint 文件或目录

也可以将其添加到 package.json 中的 scripts 字段中以便简化命令：

{
  "scripts": {
    "lint": "eslint 文件或目录"
  }
}

返回的代码片段如下：

```js
// .eslintrc.js
module.exports = {
  root: true, // ESLint 将会停止在父级目录中查找 .eslintrc.* 文件
  env: {
    node: true, // 启用 Node.js 全局变量和 Node.js 作用域
    es2021: true // 启用 ES2021 全局变量和 ES2021 作用域
  },
  extends: ['eslint:recommended'], // 使用 ESLint 推荐的规则
  parserOptions: {
    ecmaVersion: 12, // 指定 ECMAScript 版本为 12
    sourceType: 'module' // 指定模块化代码
  },
  rules: {
    // 自定义规则
    'no-console': 'off', // 允许使用 console
    'no-unused-vars': 'warn' // 警告未使用的变量
  }
}