ESLint 规范代码

一、代码规范的重要性

1. 增加代码的可读性；
2. 提升开发效率；
3. 减少代码中bug出现的可能性；
4. 有利于后期代码的维护和迭代。

二、安装和初始化

首先使用npm命令全局安装插件（如有权限问题使用sudo命令）。

npm i eslint -g

进入项目目录初始化，根据提示选择初始化方式。

eslint --init

三、配置

初始化完成后，根目录根据配置生成.eslintrc文件，这里选择的是生成js配置文件，在这个文件中可以配置ESLint的相关配置，也可以配置代码规则。

module.exports = {
  env: {
    browser: true,
    node: true,
    commonjs: true,
    es6: true
  },
  extends: 'eslint:recommended',
  globals: {
    Atomics: 'readonly',
    SharedArrayBuffer: 'readonly'
  },
  parserOptions: {
    ecmaVersion: '2018'
  },
  rules: {}
}

默认情况下，ESLint 在当前工作目录下查找.eslintignore，这个文件可以告诉ESLint去忽略掉不需要检查的文件或目录，你也可以直接在package.json中配置需要忽略的文件。

四、使用

命令行使用方式：

// 检查指定文件
eslint index.js main.js

// 检查指定目录下的所有文件
eslint src

其他命令可以通过运行eslint -h查看所有选项。

有一些babel语法没有被eslint支持，那么需要修改默认解析器为babel-eslint。

首先安装必要依赖：

npm i eslint babel-eslint -D

然后修改.eslintrc文件：

module.exports = {
  ...
  parser: 'babel-eslint',
  ...
}