复制代码 代码如下:
yarn add --dev eslint-config-standard eslint-config-standard-react eslint-plugin-standard eslint-plugin-promise eslint-plugin-import eslint-plugin-node eslint-plugin-react
注:这里包含了上一小节提到的eslint-plugin-react是为了支持eslint-config-standard-react配置包。
然后在.eslintrc配置文件中添加拓展:
{ "extends": [ "standard", "standard-react" ] }
若不想使用这类集成语法检测规则,可以移除配置文件中内容并移除依赖:
复制代码 代码如下:
yarn remove eslint-config-standard eslint-config-standard-react eslint-plugin-standard eslint-plugin-promise eslint-plugin-import eslint-plugin-node eslint-plugin-react
语法规则(rules)
要添加语法规则,只需要声明在rules属性对象中,如:
{ "rules": { "strict": 0, "semi": 2, // 强制语句末尾添加符号,否则报错 "quotes": [ 1, "single" ], } }
规则结构
当声明语法检测规则时,需要设置规则 ID为以下值之一:
- "off" 或 0 – 关闭规则
- "warn" 或 1 – 开启规则,使用警告级别的错误:warn (不会导致程序退出)
- "error" 或 2 – 开启规则,使用错误级别的错误:error (当被触发的时候,程序会退出)
{ "rules": { eqeqeq: 0, // or "off" curly: 2 // or "error" } }
某些规则还可能有额外的配置选项,可以使用数组指定,如:
{ "rules": { "eqeqeq": "off", "curly": "error", "quotes": ["warn", "single"] // 开启使用单引号,若使用双引号将发出警告 } }
指令
要执行语法检测,只需要执行./node_modules/.bin/eslint src(项目本地安装eslint,而非全局安装,则需要指定执令脚本路径),将会遍历检查src目录下的所有源码文件语法并输出结果,当然我们最终需要将指令根据npm scripts规范插入package.json文件:
{ "scripts": { "lint": "eslint --cache --fix src" } }
使用npm scripts执行指令时,无论项目本地安装还是全局安装,都可以省略指令脚本路径,因为npm将自动匹配可用路径。
文档
一个优秀的项目当然少不了文档,文档可以帮助其他开发者快速了解整个项目内容及进度,也有助于bug修复时查找内容,追踪溯源,所以文档是有必要的,于是通过调研发现了JSdoc和documentation.js帮助自动化产出API文档。