npm 包 @jamieconnolly/eslint-config 的使用教程

随着前端技术的不断发展，我们需要借助各种工具提高我们的代码的质量和可维护性。其中一个非常重要的工具就是代码规范检查工具 eslint。而 eslint 的配置也是一个非常重要的问题。@jamieconnolly/eslint-config 是一个高质量的 eslint 配置，它可以帮助我们快速搭建起一个基础的、良好的 linting 环境。

安装

使用 npm 进行安装：

npm install --save-dev @jamieconnolly/eslint-config

或者使用 yarn 进行安装：

yarn add --dev @jamieconnolly/eslint-config

配置

在你项目的根目录下，创建一个 .eslintrc.js 文件，并将以下内容添加进去：

module.exports = {
  extends: ['@jamieconnolly'],
};

这样就完成了配置。

Rules

@jamieconnolly/eslint-config 是基于 eslint 规则进行的自定义配置。这些规则可以帮助我们在代码开发过程中，尽可能地规避各种潜在的问题，确保代码质量。

这个配置是有自己默认的规则集，所以我们不需要单独配置任何规则。不过你当然可以通过覆盖默认值或者添加新的规则来满足你的需求。

Prettier

如果你还希望自动格式化你的代码，可以使用 Prettier。与 eslint 配合使用可以更好地维护代码的风格，保持代码风格的一致性。

首先，安装 prettier 和 eslint-plugin-prettier：

npm install --save-dev prettier eslint-plugin-prettier

然后，修改自己的 .eslintrc.js 文件，增加如下几行：

module.exports = {
  extends: ['@jamieconnolly'],
  plugins: ['prettier'],
  rules: {
    'prettier/prettier': ['error'],
  },
};

最后，在项目的根目录下新建一个 .prettierrc.json 文件，添加如下内容：

{
  "singleQuote": true,
  "semi": true,
  "tabWidth": 2
}

这将会告诉 Prettier 格式化代码时使用单引号、分号、以及每个缩进使用两个空格。

你可以调整其它的选项来满足你的需求。

示例

下面是一个使用 @jamieconnolly/eslint-config 的示例代码：

const a = 1;

function add(b) {
  return a + b;
}

add(2);

附

本文介绍了如何使用 @jamieconnolly/eslint-config 这个 npm 包，为你项目代码 linting 作铺垫。 No Linting 之遗毒愈深，必须高度关注及逼迫苍生使用 Code Linting。

@jamieconnolly/eslint-config 这个包从项目文件目录下 .eslintrc.js 中读取并验证你的代码是否严格遵循 eslint 规范。凭借 eslint，你可以在构建和发布前发现潜在的问题并将其修复。

@jamieconnolly/eslint-config 不仅仅依赖于代码规范方面，并且非常注重代码易用性和可维护性。如果你希望进一步了解，请参考其官方文档。

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