npm 包 eslint-config-javascript 使用教程

简介

eslint-config-javascript 是一个 ESLint 配置包，它包括了一系列的规则，可以帮助前端开发者在编写 JavaScript 代码的时候规范代码风格，提高代码质量。

安装

安装 eslint-config-javascript 非常简单：

npm install --save-dev eslint eslint-config-javascript

使用

然后，在你的工程目录下新建一个 .eslintrc.js 文件，在其中进行配置。

module.exports = {
  extends: [
    'eslint-config-javascript',
  ],
};

然后，在执行 eslint 命令时，就可以用 --ext js 参数指定要检测的 JavaScript 文件的后缀名，例如：

eslint --ext js .

这个命令将会检测当前目录下的所有 .js 文件是否符合 eslint-config-javascript 规定的规则。

规则

eslint-config-javascript 预定义了一些规则，这些规则被称作 extends，可以通过 .eslintrc.js 文件的 extends 属性来引入这些规则。

以下是 eslint-config-javascript 预定义的规则：

• eslint:recommended
• plugin:import/errors
• plugin:import/warnings
• plugin:jest/recommended
• plugin:react/recommended

其中，eslint:recommended 是 ESLint 官方推荐的规则，其他规则则是与 JavaScript 开发相关的插件，例如 plugin:jest/recommended 是一个 Jest 测试框架相关的规则插件。

示例

以下是一些在使用 eslint-config-javascript 时需要注意的事项：

禁止使用 var

在 eslint-config-javascript 中有一个规则叫做 no-var，它禁止使用 var 关键字定义变量，需要使用 let 或 const 来代替。

// Good
const x = 1;
let y = 2;

// Bad
var x = 1;

禁止使用未定义的变量

在 eslint-config-javascript 中有一个规则叫做 no-undef，它禁止使用未定义的变量。

// Bad
console.log(x);

// Good
const x = 1;
console.log(x);

强制使用模板字符串

在 eslint-config-javascript 中有一个规则叫做 prefer-template，它强制使用模板字符串来拼接字符串。

// Good
const name = 'Alice';
console.log(`Hello, ${name}!`);

// Bad
const name = 'Alice';
console.log('Hello, ' + name + '!');

优先使用解构赋值

在 eslint-config-javascript 中有一个规则叫做 prefer-destructuring，它优先使用解构赋值来获取变量。

// Good
const { x, y } = obj;

// Bad
const x = obj.x;
const y = obj.y;

总结

在本文中，我们介绍了 eslint-config-javascript 包的使用方法和一些常见的规则，这些规则可以帮助我们在 JavaScript 开发中提高代码质量和规范代码风格。希望本文对您有所帮助。

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