npm 包 eslint-config-goodcity 使用教程

什么是 eslint-config-goodcity？

eslint-config-goodcity 是一个遵循 eslint 规则的 npm 包，该包预先为你的 JavaScript 代码提供了一个可靠的代码风格。该包使用 AirBnb 规则集，并根据 Node.js，React 和 ES6 提供了相应的配置。使用 eslint-config-goodcity，可以模板化代码风格，彻底规范化代码质量，提高代码可读性以及维护性。

使用步骤

安装

在项目根目录下，使用以下命令安装 eslint，eslint-config-airbnb-base，eslint-config-react 和 eslint-config-prettier：

npm install eslint eslint-config-airbnb-base eslint-config-react eslint-config-prettier --save-dev

然后，安装 eslint-config-goodcity：

npm install eslint-config-goodcity --save-dev

配置

eslint 的配置文件是 .eslintrc.js，如果你还没有创建配置文件，可以使用以下命令初始化配置文件：

./node_modules/.bin/eslint --init

在初始化配置文件的交互式命令行中，你可以选择 eslint 配置选项，接下来再根据你的项目选择以下配置项：

module.exports = {
  extends: ["goodcity"],
  rules: {
    // additional rules
  },
};

extends: ["goodcity"] 指向了我们现有的 eslint 配置项，并提供了一个覆盖或扩展这些配置项的位置。

使用

一旦你已经安装了 eslint-config-goodcity 并对你的 eslint 配置文件进行了修改，你就可以继续使用 eslint 检查代码了。

在命令行中输入以下命令：

./node_modules/.bin/eslint yourfile.js

或者，你也可以将命令绑定到 NPM 脚本中：

"scripts": {
  "lint": "eslint yourfile.js"
},

然后运行：

npm run lint

示例代码

以下是一个使用 eslint 和 eslint-config-goodcity 的示例代码：

-- -------------------- ---- -------
------ ------ - --------- - ---- --------

----- ----------- ------- --------- -
  ------------------ -
    -------------

    ---------- - -
      -------- --
    --
  -

  ----------- - -- -- -
    ----------------------- -- --
      -------- ----------------- - --
    ----
  --

  -------- -
    ----- - ------- - - -----------

    ------ -
      -----
        --------- -------------
        ------- ---------------------------------------------
      ------
    --
  -
-

------ ------- ------------

以上代码遵循了 eslint-config-airbnb 的 JavaScript 和 React 风格规则，并使用了 eslint-config-goodcity 进行了配置。在你的项目中使用 eslint-config-goodcity 可以规范化和提高代码质量，以及代码可维护性。

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