代码规范

1. eslint: 

检查语法语义，变量未定义，定义未使用

1) use npm to install:

npm install eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin --save-dev

2) init in project

npx eslint --init

3) install eslint extension in VSCode

4) detect

in package.json

add a script:

"lint": "eslint 'src/**/*.+(js|ts|jsx|tsx)' "

then run: npm run lint

2. prettier

检查编码风格，如每一行末尾是否加分号

1) use npm to install:

npm install prettier eslint-config-prettier eslint-plugin-prettier --save-dev

2) in eslintrc.js file, in extends, add one line:

"plugin:prettier/recommended"

3) install prettier extension in VSCode

3) detect and correct:

in package.json - scripts, add one line:

"format": "prettier --write 'src/**/*.+(js|ts|jsx|tsx)' "

Then run npm run format

4) 保存自动修改

创建.vscode 文件夹，里面创建settings.json

加入以下内容：

{

"editor.codeActionsOnSave": {

"source.fixAll.eslint": true

}

}

3. husky

pre-commit checking

1) install: 

npm install husky -D

2) add hooks before commit:

npm pkg set scripts.prepare="husky install"
npm run prepare

then add command you want hook to be added:

npx husky add .husky/pre-commit "npm run lint"

npx husky add .husky/pre-commit "npm run format"

npx husky add .husky/pre-commit "git add ."

4. commit-lint: 规范commit提交格式

github: commitlint

1) install:

npm install --save-dev @commitlint/{config-conventional,cli}

2) configure

echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

3) add hook

npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'

4) types:

'chore',

'ci',

'docs',

'feat',

'fix',

'perf',

'refactor',

'revert',

'style',

'test',

git commit -m "type: xxx"