npm 包 eslint-config-airtame 使用教程

介绍

eslint-config-airtame 是一个可重复使用的 ESLint 配置，它包含一组规则，这些规则被 Airtame 前端团队用于他们的项目中，并且经过了长时间的实践和调试。

使用这个包可以使 ESLint 配置更加简单、清晰，而且可以节省很多时间。本篇文章就是为了介绍如何在项目中使用 eslint-config-airtame。

安装

在项目的根目录下执行以下命令安装 eslint 及相关的依赖：

npm install eslint eslint-plugin-import eslint-plugin-jest eslint-plugin-jsx-a11y eslint-plugin-react eslint-config-airtame --save-dev

配置

在项目的根目录下创建 .eslintrc.js 文件，并添加以下内容：

module.exports = {
  "extends": "airtame",
  // 这里可以增加你需要的规则
  "rules": {
  }
}

extends 属性指定要继承的规则，对应的值为 "airtame"，表示直接继承 eslint-config-airtame 中的所有规则。

rules 属性可以用来增加或覆盖某些规则，例如：

module.exports = {
  "extends": "airtame",
  // 禁止将变量重新赋值
  "rules": {
    "no-param-reassign": ["error", {"props": false}]
  }
}

代码审查

ESLint 使用以下命令来检查代码：

npx eslint --ext .js,.jsx src/

其中，--ext .js,.jsx 选项指定要检查的文件后缀名为 .js 或 .jsx，src/ 表示要检查的源代码目录。

结论

使用 eslint-config-airtame 可以使代码规范更加一致，减少代码错误和排查的时间。不断地学习和掌握这个包，可以使我们的前端项目质量更加优越。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005670981e8991b448e349d