Commitlint基础配置
安装stylelint
安装依赖
1npm install --save-dev @commitlint/config-conventional @commitlint/cli
不单独使用命令,结合Husky使用,请继续查阅Husky文档
配置文件约定1234567891011121314151617181920212223242526272829303132333435363738394041424344454647/** * type-enum 相关定义 参考公司文档http://doc.gitlab.py.pages:280/it-doc/pages/73cb32/ init: 初始化项目 feat:新功能(feature) fix:修补 docs:文档(documentation)以及注释相关 style: 格式(不影响代码运行的变动) refactor:重构(即不是新增功能,也不是修改bug的代码变动) test:增加测试,测试用例,接口测试等等 revert:feat(pencil): add 'graphiteWidth' opt ...
Husky基础配置
安装
安装husky
1npm i -D husky
package.json中加入通用命令
123"scripts": { "prepare": "husky install"}
运行命令生成默认配置,并添加相关配置
12345npm run preparenpx husky add .husky/commit-msg# 生成文件undefined替换为npx --no -- commitlint --edit ${1}npx husky add .husky/pre-commit# 生成文件undefined替换为npx lint-staged
辅助插件lint-staged安装
1npm i -D lint-staged
12345module.exports = { '*.{js,jsx,ts,tsx}': ['eslint', 'prettier --check'], ...
ESlint基础配置
安装eslint
如果项目不存在package.json,先npm init生成一个
1npm init
保证nodejs版本为(^12.22.0、^14.17.0或>=16.0.0)
1npm init @eslint/config
根据自定义选择会安装默认的插件以及生成默认的.eslintrc.js配置文件
我们是react+ts的项目,结合项目本身我们约定安装以下插件(其他类型项目再补充,如有vue项目需要添加适配vue的插件)
@typescript-eslint/eslint-plugin
@typescript-eslint/parser
eslint
eslint-plugin-react
eslint-plugin-react-hooks
eslint-plugin-prettier
eslint-config-prettier
简易运行检测命令
1npx eslint yourfile.js
package.json中加入通用命令
1234"scripts": { "lin ...
Stylelint基础配置
安装stylelint
如果项目不存在package.json,先npm init生成一个
1npm init
保证nodejs版本为(^14.18.0、^16.14.0或>=18.0.0)
1npm init stylelint
会安装默认的插件以及生成默认的.stylelintrc.json配置文件,但是我们约定配置文件都用.js,所以项目中会是.stylelintrc.js
由于stylelint对less的支持度不高,没有特定的相关插件使用,所有考虑项目使用react+scss,结合项目本身我们约定安装以下插件(其他类型项目再补充,如有vue项目需要添加适配vue的插件)
stylelint
stylelint-config-standard-scss
stylelint-config-prettier-scss
stylelint-order
stylelint-config-rational-order
简易运行检测命令
1npx stylelint yourfile.css
package.json中加入通用命令
1234"sc ...
Prettier基础配置
安装prettier
编辑器中安装插件
vscode: Ctrl+Shift+X -> 搜索’Prettier’ -> 安装
webstorm: Settings -> Plugins -> 搜索’Prettier’ -> 安装
编辑器中配置prettier为默认格式化工具
vscode: Ctrl+Shift+P -> 搜索选择’Format Document With’ ->选择’Configure Default Formatter’->选择’Prettier’
webstorm: 点击访问相关文献
一般使用快捷键手动格式化,或者配置保存自动格式化formatOnSave,
vscode: 在 .vscode/settings.json 文件中添加”editor.formatOnSave”: true
webstorm:
打开 WebStorm,并在菜单栏中选择「Preferences」(Mac)或「Settings」(Windows / Linux)
搜索「File Watchers」并选择 ...