git 提交配置
husky
Husky 是 Git 钩子工具，可以设置在 git 各个阶段（pre-commit、commit-msg 等）触发。
# 安装husky
pnpm install --save-dev husky
# 初始化husky 增加.husky 目录
npx husky init
# 在package.json中添加脚本,执行不成功手动添加， true 是服务端兼容
npm set-script prepare "husky install || true"
"scripts": {
"prepare": "husky install || true" # 不清楚什么意思
}
lint-staged
lint-staged 是一个在 git add 到暂存区的文件运行 linters (ESLint/Prettier/StyleLint) 的工具，避免在 git commit 提交时在整个项目执行。lint-staged 可以让你当前的代码检查 只检查本次修改更新的代码，并在出现错误的时候，自动修复并且推送
# 安装 lint-staged
# npm install --save-dev lint-staged
# 在package.json中添加脚本
"scripts": {
"lint:lint-staged": "lint-staged"
},
# 配置检查的文件和执行的命令
"lint-staged": {
"*.{js,ts,vue}": [
"eslint --fix",
"prettier --write",
"git add"
],
"*.{cjs,json}": [
"prettier --write"
],
"*.{vue,html}": [
"eslint --fix",
"prettier --write",
"stylelint --fix"
],
"*.{scss,css}": [
"stylelint --fix",
"prettier --write"
],
"*.md": [
"prettier --write"
]
}
# 配置pre-commit
.husky/pre-commit
npm run lint:lint-staged
# 或
npx --no-install lint-staged
commitilint
Commitlint 检查您的提交消息是否符合 Conventional commit format
# 安装
pnpm install --save-dev @commitlint/config-conventional @commitlint/cli
# 注意：确保保存为 `UTF-8` 的编码格式**，否则可能会出现错误。
echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.cjs
# commitlint.config.cjs
export default {
// 继承的规则
extends: ['@commitlint/config-conventional'],
// @see: https://commitlint.js.org/#/reference-rules
rules: {
'subject-case': [0], // subject大小写不做校验
// 类型枚举，git提交type必须是以下类型
'type-enum': [
// 当前验证的错误级别
2,
// 在什么情况下进行验证，always表示一直进行验证
'always',
[
'feat', // 新增功能
'fix', // 修复缺陷
'docs', // 文档变更
'style', // 代码格式（不影响功能，例如空格、分号等格式修正）
'refactor', // 代码重构（不包括 bug 修复、功能新增）
'perf', // 性能优化
'test', // 添加疏漏测试或已有测试改动
'build', // 构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）
'ci', // 修改 CI 配置、脚本
'revert', // 回滚 commit
'chore' // 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
]
]
}
}
echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg
Commitizen & cz-git
commitizen: 基于Node.js的 git commit 命令行工具，辅助生成标准化规范化的 commit message。–官方文档
cz-git: 一款工程性更强，轻量级，高度自定义，标准输出格式的 commitizen 适配器。-官方文档
# 安装
pnpm install -g commitizen cz-git
# package.json
script: {
"commit": "git-cz"
},
"config": {
"commitizen": {
"path": "node_modules/cz-git" # 直接使用git-cz 命令
}
}
cz-git 与 commitlint 进行联动给予校验信息，所以可以编写于 commitlint 配置文件(commitlint.config.cjs)之中
// commitlint.config.cjs
module.exports = {
rule: {
...
},
prompt: {
messages: {
type: '选择你要提交的类型 :',
scope: '选择一个提交范围（可选）:',
customScope: '请输入自定义的提交范围 :',
subject: '填写简短精炼的变更描述 :\n',
body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
footerPrefixesSelect: '选择关联issue前缀（可选）:',
customFooterPrefix: '输入自定义issue前缀 :',
footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
generatingByAI: '正在通过 AI 生成你的提交简短描述...',
generatedSelectByAI: '选择一个 AI 生成的简短描述:',
confirmCommit: '是否提交或修改commit ?',
},
// prettier-ignore
types: [
{ value: "feat", name: "特性: ✨ 新增功能", emoji: ":sparkles:" },
{ value: "fix", name: "修复: 🐛 修复缺陷", emoji: ":bug:" },
{ value: "docs", name: "文档: 📝 文档变更", emoji: ":memo:" },
{ value: "style", name: "格式: 💄 代码格式（不影响功能，例如空格、分号等格式修正）", emoji: ":lipstick:" },
{ value: "refactor", name: "重构: ♻️ 代码重构（不包括 bug 修复、功能新增）", emoji: ":recycle:" },
{ value: "perf", name: "性能: ⚡️ 性能优化", emoji: ":zap:" },
{ value: "test", name: "测试: ✅ 添加疏漏测试或已有测试改动", emoji: ":white_check_mark:"},
{ value: "build", name: "构建: 📦️ 构建流程、外部依赖变更（如升级 npm 包、修改 vite 配置等）", emoji: ":package:"},
{ value: "ci", name: "集成: 🎡 修改 CI 配置、脚本", emoji: ":ferris_wheel:"},
{ value: "revert", name: "回退: ⏪️ 回滚 commit",emoji: ":rewind:"},
{ value: "chore", name: "其他: 🔨 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）", emoji: ":hammer:"},
],
useEmoji: true,
emojiAlign: 'center',
useAI: false,
aiNumber: 1,
themeColorCode: '',
scopes: [],
allowCustomScopes: true,
allowEmptyScopes: true,
customScopesAlign: 'bottom',
customScopesAlias: 'custom',
emptyScopesAlias: 'empty',
upperCaseSubject: false,
markBreakingChangeMode: false,
allowBreakingChanges: ['feat', 'fix'],
breaklineNumber: 100,
breaklineChar: '|',
skipQuestions: [],
issuePrefixes: [{ value: 'closed', name: 'closed: ISSUES has been processed' }],
customIssuePrefixAlign: 'top',
emptyIssuePrefixAlias: 'skip',
customIssuePrefixAlias: 'custom',
allowCustomIssuePrefix: true,
allowEmptyIssuePrefix: true,
confirmColorize: true,
maxHeaderLength: Infinity,
maxSubjectLength: Infinity,
minSubjectLength: 0,
scopeOverrides: undefined,
defaultBody: '',
defaultIssues: '',
defaultScope: '',
defaultSubject: '',
}
}
自定义验证规则
commitlint.config.cjs
commitlint.config.js 有点区分 和上边的规则有点不同
/* eslint-disable */
const chalk = require('chalk')
module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {
'type-case': [0],
'type-empty': [0],
'scope-empty': [0],
'scope-case': [0],
'subject-full-stop': [0],
'subject-case': [0, 'never'],
'header-max-length': [0, 'always', 72],
'type-enum': [0, 'never'],
'subject-empty': [0, 'never'],
// 类型枚举，git提交type必须是以下类型 目前有自定义验证逻辑，此处禁用
'type-enum': [
0,
'never',
[
'feat', // 新增功能
'fix', // 修复缺陷
'docs', // 文档变更
'style', // 代码格式（不影响功能，例如空格、分号等格式修正）
'refactor', // 代码重构（不包括 bug 修复、功能新增）
'perf', // 性能优化
'test', // 添加疏漏测试或已有测试改动
'build', // 构建流程、外部依赖变更（如升级 npm 包、修改 webpack 配置等）
'ci', // 修改 CI 配置、脚本
'revert', // 回滚 commit
'chore', // 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）
'wip', // 工作进行中（Work In Progress），表示提交的内容是未完成的工作，通常用于临时提交保存工作进度。
'temp', // 临时，用于一些临时的、可能后续会被删除或修改的提交，类似于 wip，但可能更侧重于临时性的尝试或实验。
'update', // 更新，一般用于对现有功能、数据等进行更新操作，比 feat 更侧重于对已有内容的修改而不是添加全新功能。
'merge', // 合并，用于提交合并分支的操作记录。
'clear', // 清除，可能用于清除一些临时文件、缓存或不必要的数据等操作的提交。
'delete', // 删除，用于删除文件、目录或代码等内容的提交。
'conflict', // 冲突，一般是在处理合并冲突后提交的记录，表明解决了代码合并过程中产生的冲突。
'reset', // 重置，用于执行 git reset 操作相关的提交，可能是重置分支指针等操作。
'add', // 添加，用于添加新的文件、代码或资源到项目中的提交。
'config', // 配置，用于对项目配置文件（如项目的配置参数、环境配置等）进行的更改提交。
'git', // Git 相关，用于与 Git 本身的操作或配置相关的提交，比如修改.gitignore 文件等。
'format', // 格式化，用于对代码或文档进行格式化操作的提交，类似于 style，但更侧重于整体的格式规范调整。
],
],
'local-rule': [2, 'always'],
},
plugins: [
{
rules: {
'local-rule': value => {
const commitRE =
/^(build|chore|ci|docs|feat|fix|wip|perf|refactor|revert|style|test|temp|update|merge|clear|delete|conflict|reset|add|eslint|config|git|format)(\(.+\))?[:,：] [\s\S]{1,80}\s+#[\w,-]{4,}(,#[\w,-]{4,})?$/
const msg = value?.header || ''
if (!(commitRE.test(msg) || msg.indexOf('Merge') === 0)) {
const errMsg = `
${chalk.bgRed.white('-------------------ERROR------------------')}
"${chalk.red(msg)}" ${chalk.red('格式错误')}
${chalk.red('格式如下:')}
${chalk.yellow('可以使用vscode，commit 插件，也可以是手动输入，或者npm run commit')}
${chalk.green('build|chore|ci|docs|feat|fix|wip|perf|refactor|revert|style|test|temp|update|merge|clear|delete|conflict|reset|add|eslint|config|git|format(***): **** #任务id')}
${chalk.green('feat(模块): 预发布环境增加 A 模块 #QLMR-4584')}
${chalk.green(`
feat(模块): 门户商品大厅
1. 优化商品大厅列表
2. 优化商品详情页
3. 优化商品添加购物车功能
#QLMR-4584
`)}
${chalk.green('feat(api): 预发布环境增加 A 模块 #QLMR-4584')}
${chalk.green('fix(文案): 修复错误文案 #QLMR-4584, #QLMR-4584')}
${chalk.green('fix: 多个任务id #QLMR-4584, #QLMR-4584, #QLMR-4584')}
${chalk.bgRed.white('-------------------ERROR------------------')}
`
return [0, errMsg]
}
return [2]
},
},
},
],
prompt: {
messages: {
type: '选择你要提交的类型 :',
scope: '选择一个提交范围（可选）:',
customScope: '请输入自定义的提交范围 :',
subject: '填写简短精炼的变更描述 :\n',
body: '填写更加详细的变更描述（可选）。使用 "|" 换行 :\n',
breaking: '列举非兼容性重大的变更（可选）。使用 "|" 换行 :\n',
footerPrefixesSelect: '选择关联issue前缀（可选）:',
customFooterPrefix: '输入自定义issue前缀 :',
footer: '列举关联issue (可选) 例如: #31, #I3244 :\n',
generatingByAI: '正在通过 AI 生成你的提交简短描述...',
generatedSelectByAI: '选择一个 AI 生成的简短描述:',
confirmCommit: '是否提交或修改commit ?',
},
types: [
{ value: 'feat', name: '特性: ✨ 新增功能', emoji: ':sparkles:' },
{ value: 'fix', name: '修复: 🐛 修复缺陷', emoji: ':bug:' },
{ value: 'docs', name: '文档: 📝 文档变更', emoji: ':memo:' },
{
value: 'style',
name: '格式: 💄 代码格式（不影响功能，例如空格、分号等格式修正）',
emoji: ':lipstick:',
},
{
value: 'refactor',
name: '重构: ♻️ 代码重构（不包括 bug 修复、功能新增）',
emoji: ':recycle:',
},
{ value: 'perf', name: '性能: ⚡️ 性能优化', emoji: ':zap:' },
{
value: 'test',
name: '测试: ✅ 添加疏漏测试或已有测试改动',
emoji: ':white_check_mark:',
},
{
value: 'build',
name: '构建: 📦️ 构建流程、外部依赖变更（如升级 npm 包、修改 vite 配置等）',
emoji: ':package:',
},
{ value: 'ci', name: '集成: 🎡 修改 CI 配置、脚本', emoji: ':ferris_wheel:' },
{ value: 'revert', name: '回退: ⏪️ 回滚 commit', emoji: ':rewind:' },
{
value: 'chore',
name: '其他: 🔨 对构建过程或辅助工具和库的更改（不影响源文件、测试用例）',
emoji: ':hammer:',
},
],
useEmoji: true,
emojiAlign: 'center',
useAI: false,
aiNumber: 1,
themeColorCode: '',
scopes: [],
allowCustomScopes: true,
allowEmptyScopes: true,
customScopesAlign: 'bottom',
customScopesAlias: 'custom',
emptyScopesAlias: 'empty',
upperCaseSubject: false,
markBreakingChangeMode: false,
allowBreakingChanges: ['feat', 'fix'],
breaklineNumber: 100,
breaklineChar: '|',
skipQuestions: [],
issuePrefixes: [{ value: 'closed', name: 'closed: ISSUES has been processed' }],
customIssuePrefixAlign: 'top',
emptyIssuePrefixAlias: 'skip',
customIssuePrefixAlias: 'custom',
allowCustomIssuePrefix: true,
allowEmptyIssuePrefix: true,
confirmColorize: true,
maxHeaderLength: Infinity,
maxSubjectLength: Infinity,
minSubjectLength: 0,
scopeOverrides: undefined,
defaultBody: '',
defaultIssues: '',
defaultScope: '',
defaultSubject: '',
},
}
验证下
git add .
npm run commit || git-cz
# 或者 git commit 'ci(git): 添加git提交验证,'
# git commit -m 'ci(git): 添加git提交验证,' --no-verify 跳过验证
# --no-verify 跳过验证
git push
