CommitLint

1. .commitlintrc.js

/**
 * @link https://commitlint.js.org
 * @type {import('@commitlint/types').UserConfig}
 */
module.exports = {
  extends: ['@commitlint/config-conventional'],
}

2. .cz-config.js

/**
 * @link https://github.com/leoforfree/cz-customizable
 * @type {import('cz-customizable').Options}
 */
module.exports = {
  types: [
    { value: 'feat', name: '✨feat         新增功能' },
    { value: 'fix', name: '🐛fix          修复缺陷' },
    { value: 'docs', name: '📚docs         文档更新' },
    { value: 'style', name: '💎style        代码格式' },
    { value: 'refactor', name: '🔄refactor     代码重构' },
    { value: 'perf', name: '🚀perf         性能优化' },
    { value: 'test', name: '✅test         测试相关' },
    { value: 'build', name: '📦build        构建相关' },
    { value: 'ci', name: '⚓ci           持续集成' },
    { value: 'chore', name: '🔨chore        其他更改' },
    { value: 'revert', name: '⏪revert       回滚代码' },
  ],
  messages: {
    type: '选择你要进行提交的类型',
    scope: '表示此更改的范围，如：组件或文件名（可选）',
    customScope: '表示此更改的范围，如：组件或文件名（可选）',
    subject: '用简短的话语描述此变更',
    body: '提供更详细的变更说明，使用“|”进行换行（可选）',
    breaking: '列出任何重大变化（可选）',
    footer: '列出此更改关闭的任何问题，如：#31, #34（可选）',
    confirmCommit: '您确定要继续执行上述提交操作吗？',
  },
  skipQuestions: ['body', 'footer'],
}

3. .husky

• commit-msg

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no -- commitlint -e

• pre-commit

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no -- lint-staged --quiet

4. package.json

{
  "scripts": {
    "commit": "git add . && npx cz-customizable",
    "lint-staged": "lint-staged --quiet",
    "lint:eslint": "eslint src --fix --quiet",
    "lint:prettier": "prettier src -w -c -u",
    "lint:stylelint": "stylelint src/**/*.{css,scss} --fix -q",
    "postinstall": "husky install"
  },
  "lint-staged": {
    "**/*.{ts,tsx}": "eslint --fix --quiet",
    "**/*.{css,scss}": "stylelint --fix -q",
    "*": "prettier -w -c -u"
  }
}