npm 包 eslint-config-seregpie 使用教程

简介

eslint-config-seregpie 是一个可共享的 eslint 配置包，让你在项目中继承其配置，以利用其内置的规则，也可以自行扩展其规则，从而使你的代码更加一致和符合JavaScript最佳实践。

安装

eslint-config-seregpie 是一个细化的规则包装，所以你需要安装 eslint。你可以使用 npm 或 yarn 安装。

npm install --save-dev eslint-config-seregpie eslint

或者使用 yarn 安装

yarn add -D eslint-config-seregpie eslint

使用

1. 在你的项目的根目录创建一个 .eslintrc.js 文件，然后在文件中添加如下代码:

   module.exports = {
     extends: 'eslint-config-seregpie'
   };

   在这个配置里，你将使用 eslint-config-seregpie 作为你的父节点，集成 eslint 的默认规则，完全遵循 JavaScript 编码规范。

   你也可以在你的 .eslintrc.js 文件中将之扩展：

   module.exports = {
     extends: [
       'eslint-config-seregpie',
       // 你自己的扩展规则
     ]
   };

2. 根据引入的不同 eslint 派生，你可能需要在项目中配置额外的生命周期方法和特性选项。

   比如，在新建 React 项目脚手架时，你需要安装 eslint-plugin-react 和 eslint-plugin-react-hooks 来修复 React 生命周期方法和标准关联架构。

   • 使用 npm ：

     npm install --save-dev eslint-plugin-react eslint-plugin-react-hooks

   • 或 yarn ：

     yarn add -D eslint-plugin-react eslint-plugin-react-hooks

3. 当安装并配置 eslint 方案 后，你可以使用 npm scripts 来运行 eslint 指令，检测所有未知文件夹中的 JavasScript。可以使用 --fix 模式，来自动修复拼写错误和其它格式化问题。

   {
     "lint": "eslint --ignore-path .gitignore ."
   }

   运行 npm run lint 或 yarn lint 启动 eslint 脚本命令。

示例代码

module.exports = {
  extends: ['eslint-config-seregpie'],

  rules: {
    // 你可以覆盖或补充配置
    'global-require': 0
  }
};

结论

使用 eslint-config-seregpie 包装你的代码，可以大大提高代码规范的一致性和可读性，使得开发过程变得更加易于维护。如果你喜欢这种共享配置的方式，请使用这种方式来规范你的代码，并且跟随着项目的成长来不间断地更新和优化它的配置规则。

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