eslint-config-ais

本文介绍了如何使用eslint-config-ais配置ESLint,包括安装步骤、创建.eslintrc文件、IDE配置、修改配置文件及常用命令。此外,还提到了与Airbnb编码规范的差异和本包的定制化部分。
摘要由CSDN通过智能技术生成

首先声明,本文转载自:eslint-config-ais
这里只是记录:

eslint-config-ais

Usage

1.在项目根目录下安装 eslint-config-ais:

npm install –save-dev eslint-config-ais

ps1. 安装本包会同时安装eslint、eslint-plugin-import、eslint-plugin-react这三个依赖包。因为这三个包需要安到根目录的node_modules下,所以peerDependencies和dependencies中都写了这三个包,保证npm2和npm3都可以把他们安到根目录的node_modules下。
ps2. 对于以前安过 eslint-config-ais 包(0.0.11之前的版本)的工程,需要先执行下面命令清一下旧的包:npm uninstall eslint-config-ais eslint eslint-config-airbnb eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react –save-dev
2.在项目根目录创建.eslintrc文件,这是一个json格式的eslint配置文件,向其中添加”extends”: “eslint-config-ais”

对ES6项目

{
“extends”:”eslint-config-ais”,
}
对ES5项目

{
“extends”:”eslint-config-ais/es5”,
}
对react项目(es6环境)

{
“extends”:”eslint-config-ais/react”,
}
3.配置IDE

webstrom: 在Preferences里搜索eslint,按下图配置:
这里写图片描述
EsLint package要选当前项目目录下node_modules中的eslint。
Atom: Atom是各IDE里对eslint支持最好的,需安装插件linter和linter-eslint,配色好看,报错的规则有链接,可直接点过去看,推荐使用:

这里写图片描述
配置完成后,编辑器即可实时显示eslint报错信息。 其他编辑器的配置请看官网的integrations

4.可以根据项目情况修改.eslintrc,下面是一份完整的.eslintrc文件示例:

{
“extends”:”eslint-config-ais”,
“parser”:”babel-eslint”,
“env”:{
“mocha”:true
},
“globals”:{
“AK_GLOBAL”:true
},
“rules”:{
“max-len”:0//关闭最大长度限制
}
}
配置文件参数解释:

parser: 使用babel-eslint解析器代替eslint默认的解析器espree,推荐在使用babel的项目中使用。npm install babel-eslint –save-dev
env: 说明代码的环境,不同环境下eslint会允许使用不同的全局变量,eslint-config-ais默认已开启browser,node,jquery环境
globals: 在这里写上项目中用到全局变量,在这里设置后再代码中就不会报no-undef
rules: 规则设置,对某条规则不满,可以在这里修改,然后告诉我补充到公共的eslint-config-ais里
更多参数说明请看官网的configuring

5.几条常用的eslint命令,可以将这3条命令写在package.json的script中:

// package.json
{

“scripts”:{
“eslint”:”node_modules/.bin/eslint src/”,
“eslint-output”:”node_modules/.bin/eslint -f html src/ > eslint-result.html”,
“eslint-fix”:”node_modules/.bin/eslint –fix src/”
},

}
eslint src/ 对src目录下的文件执行eslint,可以使用–quiet参数只输出error不输出warn
eslint –fix src/ 对src目录下的文件可修复的lint错误进行修复,可修复的属性见 这里,后面有小扳手的都是修复的属性。注意:修复缩进时可能会有问题(如空格、tab混用时),所以建议每次使用–fix命令后diff一下文件确认是否有问题。
eslint -f html src/ > eslint-result.html 对src目录下的文件执行eslint,并将结果格式化为html输出到当前目录的eslint-result.html,此命令可以查看项目整体的eslint报错情况,线上也将使用此命令进行扫描
注意:eslint命令默认只处理后缀为.js的文件,其他后缀的文件需要用命令行的–ext参数指定,目前不支持在配置文件中设置扩展名,只能在命令行中使用–ext参数指定,比如对于使用.jsx做后缀的项目上面三条命令要变为:
eslint –ext .jsx,.js src/
eslint –fix –ext .jsx,.js src/
eslint -f html –ext .jsx,.js src/ > eslint-result.html
注意:由于npm install本包后会将eslint安装到工程目录,上面命令中的eslint需要替换成node_modules/.bin/eslint。或者可以npm install -g eslint-config-ais安装到全局,可直接使用eslint命令。但是写在package.json中的还是建议写成node_modules/.bin/eslint,因为无法保证其他人全局安装了eslint和相关的config。
其他命令行操作请看官网的command-line-interface

关于eslint更多的介绍 请看官网,报错的属性在官网搜索,即可看到详细的解释。 如果遇到接受不了的报错,可以先在.eslintrc的rules里修改,之后告知我补充到公共的eslint-config-ais里:》

代码规范和本包的介绍

本包以『Airbnb编码规范』 作为规范,在它的基础上了做一层自己的修改。

包的结构如下图:

这里写图片描述
r

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值