para-eslint
v1.0.1
Published
统一的初始化eslint
Downloads
2
Readme
eslint cli工具
旨在统一公司代码风格,减少语法错误,提高开发效率
安装
npm i -g para-eslint
使用
初始化安装
eslint-init
安装成功后,可执行
npm run lint //可查看和自动修复一些lint问题
vscode配置
vscode编辑器保存时根据eslint规则自动格式化
- 安装eslint插件,并启用
- 在设置中添加以下配置(或在.vscode/settings.json文件中)
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
其他编辑器同理
提示与建议
第一次开启eslint的项目,为避免历史代码报错较多,无法及时修复,影响日常开发进度,建议在当前最新代码分支切出一个分支进行安装,安装成功后,预估修复时间,修复完成后再合并主分支
本工具尽量做到通用,lint命令覆盖范围因项目结构不同可能有覆盖不到,可以在package.json中scripts字段手动修改lint命令。如:
"lint": "eslint --fix --ext .js,.jsx,.ts,.tsx ./src ./config ./scripts ./kernel ./static"
手动添加需要lint的目录或文件
- 一些特殊的全局变量需自行注册在.eslintrc文件中global内
{
"globals": {
"Jquery": 'off' //'off'|'writeable'|'readable'
}
}
如果要忽略检查某些文件,请自行新建修改.eslintignore文件
如果规则有问题,或者比较严格的地方,可以提出来一起讨论是否修改规则或者放宽,原则上不要自己修改。
欢迎对本工具提出建议和意见。