@paraview/lint
v0.1.7
Published
para 代码风格统一脚手架
Downloads
25
Readme
版本: 2.0.1
@paraview/[email protected] 发布
【eslint】修改eslint配置,增加eslint进度条,增加ts项目配置选择
【package.json】修改eslint全局校验命令
eslint+stylelint+prettier cli工具
旨在统一公司代码风格,减少语法错误和代码阅读困难的问题,通过husky来严格控制提交代码的一致性
安装
npm i -g @paraview/lint
npm i -D @paraview/lint
使用
- 全局安装
使用paraLint init初始化
- 项目安装
使用命令npx paraLint init初始化
查看cli命令
paraLint --help
安装成功后,可执行
npm run lint //可查看和自动修复一些lint问题
vscode配置
vscode编辑器保存时根据eslint规则自动格式化
- 安装eslint插件,并启用
- 安装prettier插件,并启用
- 在设置中添加以下配置(或在.vscode/settings.json文件中)
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
其他编辑器同理
提示与建议
第一次开启eslint的项目,为避免历史代码报错较多,无法及时修复,影响日常开发进度,建议在当前最新代码分支切出一个分支进行安装,安装成功后,预估修复时间,修复完成后再合并主分支
本工具尽量做到通用,lint命令覆盖范围因项目结构不同可能有覆盖不到,可以在package.json中scripts字段手动修改lint命令。如:
"lint:script": "git diff --name-only --diff-filter=d | grep -E '(.ts$|.tsx$|.jsx$)' | xargs eslint --fix",//只校验本次工作区js的修改
"lint:style": "git diff --name-only --diff-filter=d | grep -E '(.css$|.scss$)' | xargs stylelint --fix", //只校验本次工作区的css修改
"lint": "npm run lint:script && npm run lint:style", // 校验工作区css和js
"lint:script-all": "eslint --ext .js,.jsx,.ts,.tsx --fix src" //校验整个项目JS
"lint:style-all": "stylelint 'src/**/*.{css,scss}' --fix", //校验整个项目CSS
"lint:all":"npm run lint:script-all && npm run lint:style-all"
- 一些特殊的全局变量需自行注册在.eslintrc文件中global内
{
"globals": {
// 允许全局 NodeJS 和 NodeListOf变量
"NodeJS": "writable",
"NodeListOf": "writable"
}
}
帮用户写入的配置文件中包括命令已经排除了一些文件的修改,如果还需要忽略检查某些文件,请自行新建修改.eslintignore文件
如果规则有问题,或者比较严格的地方,可以提出来一起讨论是否修改规则或者放宽,原则上不要自己修改。
欢迎对本工具提出建议和意见。