Weex ESLint Rules
Rules Detail:https://weexteam.github.io/eslint-config-weex/
配置原则
我们依据以下三条原则,研读了 ESLint 所有的配置项,定制出适合 Weex 开发的 ESLint 配置。
- 能够帮助发现代码错误的规则,全部开启
- 配置不应该依赖于某个具体项目,而应尽可能的合理
- 帮助保持团队的代码风格统一,而不是限制开发体验
配置解读
我们对每一条配置,都有详尽的注释,这样不仅方便了我们自己查阅某项配置的意义和原因,也使大家更容易配置出自己心目中的规则:
- 每一条配置都有注释说明此配置的用途
- 对于理解困难的配置,都在注释中有举例
- 对于有争议的配置,都在注释中说明了为什么要这么配置的原因
- 对于关闭掉的配置,都在注释中有对应的原因说明,以及
@off
的标识 - 对于能够 autofix 的配置,都在注释中有标注
@autofix
Usage
Standard
安装:
npm install --save-dev eslint babel-eslint eslint-config-weex
在你的项目根目录下创建 .eslintrc.js
,并将以下内容复制到文件中:
module.exports = {
extends: [
'eslint-config-weex',
],
globals: {
},
rules: {
}
};
Vue
安装:
npm install --save-dev eslint babel-eslint eslint-plugin-weex eslint-config-weex
在你的项目根目录下创建 .eslintrc.js
,并将以下内容复制到文件中:
module.exports = {
extends: [
'eslint-config-weex/vue',
],
globals: {
},
rules: {
}
};
Testing
npm test
参考