最近在学习工程化，记录一下，不然后面又要忘了~~~
lint 工具链分为以下几个部分：
- 代码规范 ： ESLint + Prettier + Stylelint
- Git 提交工作流 ：husky + lint-staged
- 提交规范 ： Commitlint
ps：推荐使用 pnpm
ok，直接进入正题~
一、代码规范
注：ESLint，Prettier，styleint 在 vscode 中使用，需选装相关插件。后面不再赘述。（可在开发中提示相关错误）
1、ESLint
- 安装
pnpm i eslint -D
- 初始化 .eslintrc.js
npx eslint --init
运行安装后，选相应的配置
如果插件安装失败，手动install~
pnpm i eslint-plugin-react@latest @typescript-eslint/eslint-plugin@latest @typescript-eslint/parser@latest -D
然后会生成一个 .eslintrc.js 文件
module.exports = {
env: {
browser: true,
es2021: true,
node: true
},
extends: [
'standard-with-typescript',
'plugin:vue/vue3-essential'
],
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module'
},
plugins: [
'vue'
],
rules: {
}
}
2、Prettier
- 安装
npm i prettier -D
- 配置
在项目跟目录下新建 .prettierrc.js 配置文件，内容如下：
module.exports = {
// 一行最多 120 字符
printWidth: 180,
// 使用 2 个空格缩进
tabWidth: 2,
// 不使用缩进符，而使用空格
useTabs: false,
// 行尾需要有分号
semi: true,
// 使用单引号
singleQuote: true,
// 对象的 key 仅在必要时用引号
quoteProps: 'as-needed',
// jsx 不使用单引号，而使用双引号
jsxSingleQuote: false,
// 末尾需要有逗号
trailingComma: 'all',
// 大括号内的首尾需要空格
bracketSpacing: true,
// jsx 标签的反尖括号需要换行
jsxBracketSameLine: false,
// 箭头函数，只有一个参数的时候，也需要括号
arrowParens: 'always',
// 每个文件格式化的范围是文件的全部内容
rangeStart: 0,
rangeEnd: Infinity,
// 不需要写文件开头的 @prettier
requirePragma: false,
// 不需要自动在文件开头插入 @prettier
insertPragma: false,
// 使用默认的折行标准
proseWrap: 'preserve',
// 根据显示样式决定 html 要不要折行
htmlWhitespaceSensitivity: 'css',
// vue 文件中的 script 和 style 内不用缩进
vueIndentScriptAndStyle: false,
// 换行符使用 lf
endOfLine: 'lf',
// 格式化内嵌代码
embeddedLanguageFormatting: 'auto',
// 控制是否 prettier 格式的引用代码嵌入在文件中。
eslintIntegration: true,
};
注：可以根据自己项目要求或喜好配置。
- 集成
pnpm i eslint-config-prettier eslint-plugin-prettier -D
安装这两个插件，主要解决 ESLint 和 Prettier 的冲突问题。
// .eslintrc.js
...
extends: [
'standard-with-typescript',
'plugin:vue/vue3-essential',
'plugin:prettier/recommended', // 添加 prettier 插件
],
...
注：重启vscode。（关闭所有）。
- 最终
// .eslintrc.cjs 这里文件名后缀改成 cjs，或者把 package.json 的type改了， 'type':'module'。不然会报错。
module.exports = {
// 运行环境
env: {
browser: true,
es2021: true,
node: true,
},
// 继承配置
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'standard-with-typescript',
'plugin:vue/vue3-essential',
'plugin:prettier/recommended', // 添加 prettier 插件
],
// 解析器
parser: '@typescript-eslint/parser',
// 解析器选项
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
},
// 重写 解决 pnpm run lint 报错问题
overrides: [
{
files: ['*.ts', '*.tsx'], // Your TypeScript files extension
extends: ['plugin:@typescript-eslint/recommended'],
parserOptions: {
project: ['./tsconfig.json'], // Specify it only for TypeScript files
},
},
],
// 插件
plugins: ['vue', '@typescript-eslint'],
// 具体代码规则
rules: {
'vue/html-self-closing': 'off',
'vue/singleline-html-element-content-newline': 'off',
'vue/multi-word-component-names': 'off',
'vue/prefer-import-from-vue': 'off',
'vue/no-unused-vars': 'error',
// 'no-alert': 0, //禁止使用alert confirm prompt
// 'no-array-constructor': 2, //禁止使用数组构造器
// 'no-bitwise': 0, //禁止使用按位运算符
// 'no-caller': 1, //禁止使用arguments.caller或arguments.callee
// 'no-catch-shadow': 2, //禁止catch子句参数与外部作用域变量同名
// 'no-class-assign': 2, //禁止给类赋值
// 'no-cond-assign': 2, //禁止在条件表达式中使用赋值语句
// 'no-console': 2, //禁止使用console
// 'no-const-assign': 2, //禁止修改const声明的变量
// 'no-constant-condition': 2, //禁止在条件中使用常量表达式 if(true) if(1)
// 'no-continue': 0, //禁止使用continue
// 'no-control-regex': 2, //禁止在正则表达式中使用控制字符
// 'no-debugger': 2, //禁止使用debugger
// 'no-delete-var': 2, //不能对var声明的变量使用delete操作符
// 'no-div-regex': 1, //不能使用看起来像除法的正则表达式/=foo/
// 'no-dupe-keys': 2, //在创建对象字面量时不允许键重复 {a:1,a:1}
// 'no-dupe-args': 2, //函数参数不能重复
// 'no-duplicate-case': 2, //switch中的case标签不能重复
// 'no-else-return': 2, //如果if语句里面有return,后面不能跟else语句
// 'no-empty': 2, //块语句中的内容不能为空
// 'no-empty-character-class': 2, //正则表达式中的[]内容不能为空
// 'no-empty-label': 2, //禁止使用空label
// 'no-eq-null': 2, //禁止对null使用==或!=运算符
// 'no-eval': 1, //禁止使用eval
// 'no-ex-assign': 2, //禁止给catch语句中的异常参数赋值
// 'no-extend-native': 2, //禁止扩展native对象
// 'no-extra-bind': 2, //禁止不必要的函数绑定
// 'no-extra-boolean-cast': 2, //禁止不必要的bool转换
// 'no-extra-parens': 2, //禁止非必要的括号
// 'no-extra-semi': 2, //禁止多余的冒号
// 'no-fallthrough': 1, //禁止switch穿透
// 'no-floating-decimal': 2, //禁止省略浮点数中的0 .5 3.
// 'no-func-assign': 2, //禁止重复的函数声明
// 'no-implicit-coercion': 1, //禁止隐式转换
// 'no-implied-eval': 2, //禁止使用隐式eval
// 'no-inline-comments': 0, //禁止行内备注
// 'no-inner-declarations': [2, 'functions'], //禁止在块语句中使用声明（变量或函数）
// 'no-invalid-regexp': 2, //禁止无效的正则表达式
// 'no-invalid-this': 2, //禁止无效的this，只能用在构造器，类，对象字面量
// 'no-irregular-whitespace': 2, //不能有不规则的空格
// 'no-iterator': 2, //禁止使用__iterator__ 属性
// 'no-label-var': 2, //label名不能与var声明的变量名相同
// 'no-labels': 2, //禁止标签声明
// 'no-lone-blocks': 2, //禁止不必要的嵌套块
// 'no-lonely-if': 2, //禁止else语句内只有if语句
// 'no-loop-func': 1, //禁止在循环中使用函数（如果没有引用外部变量不形成闭包就可以）
// 'no-mixed-requires': [0, false], //声明时不能混用声明类型
// 'no-mixed-spaces-and-tabs': [2, false], //禁止混用tab和空格
// 'linebreak-style': [0, 'windows'], //换行风格
// 'no-multi-spaces': 1, //不能用多余的空格
// 'no-multi-str': 2, //字符串不能用换行
// 'no-multiple-empty-lines': [1, { max: 2 }], //空行最多不能超过2行
// 'no-native-reassign': 2, //不能重写native对象
// 'no-negated-in-lhs': 2, //in 操作符的左边不能有!
// 'no-nested-ternary': 0, //禁止使用嵌套的三目运算
// 'no-new': 1, //禁止在使用new构造一个实例后不赋值
// 'no-new-func': 1, //禁止使用new Function
// 'no-new-object': 2, //禁止使用new Object()
// 'no-new-require': 2, //禁止使用new require
// 'no-new-wrappers': 2, //禁止使用new创建包装实例，new String new Boolean new Number
// 'no-obj-calls': 2, //不能调用内置的全局对象，比如Math() JSON()
// 'no-octal': 2, //禁止使用八进制数字
// 'no-octal-escape': 2, //禁止使用八进制转义序列
// 'no-param-reassign': 2, //禁止给参数重新赋值
// 'no-path-concat': 0, //node中不能使用__dirname或__filename做路径拼接
// 'no-plusplus': 0, //禁止使用++，--
// 'no-process-env': 0, //禁止使用process.env
// 'no-process-exit': 0, //禁止使用process.exit()
// 'no-proto': 2, //禁止使用__proto__属性
// 'no-redeclare': 2, //禁止重复声明变量
// 'no-regex-spaces': 2, //禁止在正则表达式字面量中使用多个空格 /foo bar/
// 'no-restricted-modules': 0, //如果禁用了指定模块，使用就会报错
// 'no-return-assign': 1, //return 语句中不能有赋值表达式
// 'no-script-url': 0, //禁止使用javascript:void(0)
// 'no-self-compare': 2, //不能比较自身
// 'no-sequences': 0, //禁止使用逗号运算符
// 'no-shadow': 2, //外部作用域中的变量不能与它所包含的作用域中的变量或参数同名
// 'no-shadow-restricted-names': 2, //严格模式中规定的限制标识符不能作为声明时的变量名使用
// 'no-spaced-func': 2, //函数调用时 函数名与()之间不能有空格
// 'no-sparse-arrays': 2, //禁止稀疏数组， [1,,2]
// 'no-sync': 0, //nodejs 禁止同步方法
// 'no-ternary': 0, //禁止使用三目运算符
// 'no-trailing-spaces': 1, //一行结束后面不要有空格
// 'no-this-before-super': 0, //在调用super()之前不能使用this或super
// 'no-throw-literal': 2, //禁止抛出字面量错误 throw "error";
// 'no-undef': 1, //不能有未定义的变量
// 'no-undef-init': 2, //变量初始化时不能直接给它赋值为undefined
// 'no-undefined': 2, //不能使用undefined
// 'no-unexpected-multiline': 2, //避免多行表达式
// 'no-underscore-dangle': 1, //标识符不能以_开头或结尾
// 'no-unneeded-ternary': 2, //禁止不必要的嵌套 var isYes = answer === 1 ? true : false;
// 'no-unreachable': 2, //不能有无法执行的代码
// 'no-unused-expressions': 2, //禁止无用的表达式
// 'no-unused-vars': [2, { vars: 'all', args: 'after-used' }], //不能有声明后未被使用的变量或参数
// 'no-use-before-define': 2, //未定义前不能使用
// 'no-useless-call': 2, //禁止不必要的call和apply
// 'no-void': 2, //禁用void操作符
// 'no-var': 0, //禁用var，用let和const代替
// 'no-warning-comments': [1, { terms: ['todo', 'fixme', 'xxx'], location: 'start' }], //不能有警告备注
// 'no-with': 2, //禁用with
// 'array-bracket-spacing': [2, 'never'], //是否允许非空数组里面有多余的空格
// 'arrow-parens': 0, //箭头函数用小括号括起来
// 'arrow-spacing': 0, //=>的前/后括号
// 'accessor-pairs': 0, //在对象中使用getter/setter
// 'block-scoped-var': 0, //块语句中使用var
// 'brace-style': [1, '1tbs'], //大括号风格
// 'callback-return': 1, //避免多次调用回调什么的
// camelcase: 2, //强制驼峰法命名
// 'comma-dangle': [2, 'never'], //对象字面量项尾不能有逗号
// 'comma-spacing': 0, //逗号前后的空格
// 'comma-style': [2, 'last'], //逗号风格，换行时在行首还是行尾
// complexity: [0, 11], //循环复杂度
// 'computed-property-spacing': [0, 'never'], //是否允许计算后的键名什么的
// 'consistent-return': 0, //return 后面是否允许省略
// 'consistent-this': [2, 'that'], //this别名
// 'constructor-super': 0, //非派生类不能调用super，派生类必须调用super
// curly: [2, 'all'], //必须使用 if(){} 中的{}
// 'default-case': 2, //switch语句最后必须有default
// 'dot-location': 0, //对象访问符的位置，换行的时候在行首还是行尾
// 'dot-notation': [0, { allowKeywords: true }], //避免不必要的方括号
// 'eol-last': 0, //文件以单一的换行符结束
// eqeqeq: 2, //必须使用全等
// 'func-names': 0, //函数表达式必须有名字
// 'func-style': [0, 'declaration'], //函数风格，规定只能使用函数声明/函数表达式
// 'generator-star-spacing': 0, //生成器函数*的前后空格
// 'guard-for-in': 0, //for in循环要用if语句过滤
// 'handle-callback-err': 0, //nodejs 处理错误
// 'id-length': 0, //变量名长度
// indent: [2, 4], //缩进风格
// 'init-declarations': 0, //声明时必须赋初值
// 'key-spacing': [0, { beforeColon: false, afterColon: true }], //对象字面量中冒号的前后空格
// 'lines-around-comment': 0, //行前/行后备注
// 'max-depth': [0, 4], //嵌套块深度
// 'max-len': [0, 80, 4], //字符串最大长度
// 'max-nested-callbacks': [0, 2], //回调嵌套深度
// 'max-params': [0, 3], //函数最多只能有3个参数
// 'max-statements': [0, 10], //函数内最多有几个声明
// 'new-cap': 2, //函数名首行大写必须使用new方式调用，首行小写必须用不带new方式调用
// 'new-parens': 2, //new时必须加小括号
// 'newline-after-var': 2, //变量声明后是否需要空一行
// 'object-curly-spacing': [0, 'never'], //大括号内是否允许不必要的空格
// 'object-shorthand': 0, //强制对象字面量缩写语法
// 'one-var': 1, //连续声明
// 'operator-assignment': [0, 'always'], //赋值运算符 += -=什么的
// 'operator-linebreak': [2, 'after'], //换行时运算符在行尾还是行首
// 'padded-blocks': 0, //块语句内行首行尾是否要空行
// 'prefer-const': 0, //首选const
// 'prefer-spread': 0, //首选展开运算
// 'prefer-reflect': 0, //首选Reflect的方法
// quotes: [1, 'single'], //引号类型 `` "" ''
// 'quote-props': [2, 'always'], //对象字面量中的属性名是否强制双引号
// radix: 2, //parseInt必须指定第二个参数
// 'id-match': 0, //命名检测
// 'require-yield': 0, //生成器函数必须有yield
// semi: [2, 'always'], //语句强制分号结尾
// 'semi-spacing': [0, { before: false, after: true }], //分号前后空格
// 'sort-vars': 0, //变量声明时排序
// 'space-after-keywords': [0, 'always'], //关键字后面是否要空一格
// 'space-before-blocks': [0, 'always'], //不以新行开始的块{前面要不要有空格
// 'space-before-function-paren': [0, 'always'], //函数定义时括号前面要不要有空格
// 'space-in-parens': [0, 'never'], //小括号里面要不要有空格
// 'space-infix-ops': 0, //中缀操作符周围要不要有空格
// 'space-return-throw-case': 2, //return throw case后面要不要加空格
// 'space-unary-ops': [0, { words: true, nonwords: false }], //一元运算符的前/后要不要加空格
// 'spaced-comment': 0, //注释风格要不要有空格什么的
// strict: 2, //使用严格模式
// 'use-isnan': 2, //禁止比较时使用NaN，只能用isNaN()
// 'valid-jsdoc': 0, //jsdoc规则
// 'valid-typeof': 2, //必须使用合法的typeof的值
// 'vars-on-top': 2, //var必须放在作用域顶部
// 'wrap-iife': [2, 'inside'], //立即执行函数表达式的小括号风格
// 'wrap-regex': 0, //正则表达式字面量用小括号包起来
// yoda: [2, 'never'], //禁止尤达条件
},
// 全局变量
globals: {},
};
};
注：可去根据自己项目要求或喜好配置。
- 补充
设置 vsCode 的 settings.json 文件，加入如下代码，在 Ctrl+Alt+F 保存文件时，可让 编辑器 尝试修复eslint语法检查的问题。
{
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
...
}
3、Stylelint
- 安装
pnpm i stylelint stylelint-prettier stylelint-config-prettier stylelint-config-recess-order stylelint-config-standard stylelint-config-standard-scss -D
- 配置
在项目跟目录下新建 .stylelintrc.js 配置文件，内容如下
// .stylelintrc.js
module.exports = {
// 注册 stylelint 的 prettier 插件
plugins: ['stylelint-prettier'],
// 继承一系列规则集合
extends: [
// standard 规则集合
'stylelint-config-standard',
// standard 规则集合的 scss 版本
'stylelint-config-standard-scss',
// 样式属性顺序规则
'stylelint-config-recess-order',
// 接入 Prettier 规则
'stylelint-config-prettier',
'stylelint-prettier/recommended',
],
// 配置 rules
rules: {
// 开启 Prettier 自动格式化功能
'prettier/prettier': true,
},
};
同时配置 package.json 文件
{
...
"scripts": {
...
"lint": "npm run lint:script && npm run lint:style",
"lint:script": "eslint --ext .js,.jsx,.ts,.tsx --fix --quiet ./src",
"lint:style": "stylelint --fix \"src/**/*.{css,scss}\""
},
...
}
二、husky 和 lint-staged
1.husky
- 安装
pnpm i husky -D
- 配置
按顺序执行以下操作
npx husky install // 注意 需要.git 地址
//package.json
{
"scripts": {
// 会在安装 npm 依赖后自动执行
"prepare": "husky install"
}
}
// 添加 Husky 钩子
npx husky add .husky/pre-commit "npm run lint"
2.lint-staged
- 安装
// 安装 lint-staged
pnpm i -D lint-staged
注：增量 Lint 检查
- 配置
//package.json
{
...
"lint-staged": {
"**/*.{js,jsx,tsx,ts}": [
"npm run lint:script",
"git add ."
],
"**/*.{scss}": [
"npm run lint:style",
"git add ."
]
}
...
}
- 集成
// .husky/pre-commit 文件 将`npm run lint`换成 如下代码
npx --no -- lint-staged
三、Commitlint
1、Commitlint
- 安装
pnpm i commitlint @commitlint/cli @commitlint/config-conventional -D
- 配置
根目录新建 .commitlintrc.js 文件
// .commitlintrc.js
module.exports = {
extends: ["@commitlint/config-conventional"]
};
- 提交规范
// type 指提交的类型
// subject 指提交的摘要信息
<type>: <subject>
//常用
| 类型 | 功能 | 描述 |
| -------- | ---- | -------------------------------------- |
| feat | 功能 | 新增功能，迭代项目需求 |
| fix | 修复 | 修复缺陷，修复上一版本存在问题 |
| docs | 文档 | 更新文档，仅修改文档不修改代码 |
| style | 样式 | 变动格式，不影响代码逻辑 |
| refactor | 重构 | 重构代码，非新增功能也非修复缺陷 |
| perf | 性能 | 优化性能，提高代码执行性能 |
| test | 测试 | 新增测试，追加测试用例验证代码 |
| build | 构建 | 构建 更新构建，改动构建工具或外部依赖 |
| ci | 脚本 | 更新脚本，改动CI或执行脚本配置 |
| chore | 事务 | 变动事务，改动其他不影响代码的事务 |
| revert | 回滚 | 回滚版本，撤销某次代码提交 |
| merge | 合并 | 合并分支，合并分支代码到其他分支 |
| sync | 同步 | 同步分支，同步分支代码到其他分支 |
| impr | 改进 | 改进功能，升级当前功能模块 |
- 集成
npx husky add .husky/commit-msg "npx --no-install commitlint -e $HUSKY_GIT_PARAMS"
过程中您可能遇到的一些问题：
1.git commit -m'<类型>： <描述>'
解：冒号后面加个 空格。
2. ESLint was configured to run on '<tsconfigRootDir>/vite.config.ts' using 'parserOptions.project': <tsconfigRootDir>/tsconfig.json
解：在tsconfig.json 中添加：
{
...
"include": [..., "vite.config.ts", ".commitlintrc.cjs"],
...
}
3.windows 和 linux 两个系统的文本文件的换行符不一致。
可参考 文章 。
相关 gitee 地址。
