eslint - 985ch/egg-sachikawa GitHub Wiki

在团队开发中，代码检查和代码风格的统一是至关重要的一件事，不规范的代码和风格各异的代码风格都会给项目维护带来额外的困难。为了避免这些问题，我们强烈建议开发者在开发过程中持续的使用eslint在每次代码提交前进行代码检查。

eslint的安装

使用egg.js脚手架创建的项目

使用egg.js脚手架创建的项目默认会安装好eslint并且完成命令配置，因此不需要再额外安装eslint

人工创建的项目

  1. 执行命令安装eslint和对应配置
$ npm i eslint --save-dev
$ npm i eslint-config-egg --save-dev
  1. 在package.json里面添加脚本配置
"scripts": {
  "lint": "eslint ."
}
  1. 在项目根目录下创建.eslintrc文件（注意句点），文件内容如下
{
  "extends": "eslint-config-egg"
}
  1. 在项目根目录下创建.eslintignore文件（注意句点），文件内容如下
coverage
  1. 完成

eslint的使用

人工执行eslint

在项目根目录下执行以下命令行即可完成eslint校验

$ npm run lint

开发环境配置自动执行eslint

部分编译器可以通过配置插件在保存文件时实现自动执行eslint来规范代码，并随时标记不符合eslint规则的代码位置，这会给开发带来极大的便利。例如在vscode中，通过Eslint插件就能实现保存时同步执行eslint命令来规范代码。