|
| 1 | +module.exports = { |
| 2 | + // type 类型(定义之后,可通过上下键选择) |
| 3 | + types: [ |
| 4 | + { value: 'feat', name: 'feat: 新增功能' }, |
| 5 | + { value: 'fix', name: 'fix: 修复 bug' }, |
| 6 | + { value: 'docs', name: 'docs: 文档变更' }, |
| 7 | + { |
| 8 | + value: 'style', |
| 9 | + name: 'style: 代码格式(不影响功能,例如空格、分号等格式修正)' |
| 10 | + }, |
| 11 | + { |
| 12 | + value: 'refactor', |
| 13 | + name: 'refactor: 代码重构(不包括 bug 修复、功能新增)' |
| 14 | + }, |
| 15 | + { value: 'perf', name: 'perf: 性能优化' }, |
| 16 | + { value: 'test', name: 'test: 添加、修改测试用例' }, |
| 17 | + { |
| 18 | + value: 'build', |
| 19 | + name: |
| 20 | + 'build: 构建流程、外部依赖变更(如升级 npm 包、修改 webpack 配置等)' |
| 21 | + }, |
| 22 | + { value: 'ci', name: 'ci: 修改 CI 配置、脚本' }, |
| 23 | + { |
| 24 | + value: 'chore', |
| 25 | + name: 'chore: 对构建过程或辅助工具和库的更改(不影响源文件、测试用例)' |
| 26 | + }, |
| 27 | + { value: 'revert', name: 'revert: 回滚 commit' } |
| 28 | + ], |
| 29 | + |
| 30 | + // scope 类型(定义之后,可通过上下键选择) |
| 31 | + scopes: [ |
| 32 | + ['components', '组件相关'], |
| 33 | + ['hooks', 'hook 相关'], |
| 34 | + ['utils', 'utils 相关'], |
| 35 | + ['element-ui', '对 element-ui 的调整'], |
| 36 | + ['styles', '样式相关'], |
| 37 | + ['deps', '项目依赖'], |
| 38 | + ['auth', '对 auth 修改'], |
| 39 | + ['other', '其他修改'], |
| 40 | + // 如果选择 custom,后面会让你再输入一个自定义的 scope。也可以不设置此项,把后面的 allowCustomScopes 设置为 true |
| 41 | + ['custom', '以上都不是?我要自定义'] |
| 42 | + ].map(([value, description]) => { |
| 43 | + return { |
| 44 | + value, |
| 45 | + name: `${value.padEnd(30)} (${description})` |
| 46 | + } |
| 47 | + }), |
| 48 | + |
| 49 | + // 是否允许自定义填写 scope,在 scope 选择的时候,会有 empty 和 custom 可以选择。 |
| 50 | + // allowCustomScopes: true, |
| 51 | + |
| 52 | + // allowTicketNumber: false, |
| 53 | + // isTicketNumberRequired: false, |
| 54 | + // ticketNumberPrefix: 'TICKET-', |
| 55 | + // ticketNumberRegExp: '\\d{1,5}', |
| 56 | + |
| 57 | + // 针对每一个 type 去定义对应的 scopes,例如 fix |
| 58 | + /* |
| 59 | + scopeOverrides: { |
| 60 | + fix: [ |
| 61 | + { name: 'merge' }, |
| 62 | + { name: 'style' }, |
| 63 | + { name: 'e2eTest' }, |
| 64 | + { name: 'unitTest' } |
| 65 | + ] |
| 66 | + }, |
| 67 | + */ |
| 68 | + |
| 69 | + // 交互提示信息 |
| 70 | + messages: { |
| 71 | + type: '确保本次提交遵循 Angular 规范!\n选择你要提交的类型:', |
| 72 | + scope: '\n选择一个 scope(可选):', |
| 73 | + // 选择 scope: custom 时会出下面的提示 |
| 74 | + customScope: '请输入自定义的 scope:', |
| 75 | + subject: '填写简短精炼的变更描述:\n', |
| 76 | + body: '填写更加详细的变更描述(可选)。使用 "|" 换行:\n', |
| 77 | + breaking: '列举非兼容性重大的变更(可选):\n', |
| 78 | + footer: '列举出所有变更的 ISSUES CLOSED(可选)。 例如: #31, #34:\n', |
| 79 | + confirmCommit: '确认提交?' |
| 80 | + }, |
| 81 | + |
| 82 | + // 设置只有 type 选择了 feat 或 fix,才询问 breaking message |
| 83 | + allowBreakingChanges: ['feat', 'fix'], |
| 84 | + |
| 85 | + // 跳过要询问的步骤 |
| 86 | + // skipQuestions: ['body', 'footer'], |
| 87 | + |
| 88 | + subjectLimit: 100, // subject 限制长度 |
| 89 | + breaklineChar: '|' // 换行符,支持 body 和 footer |
| 90 | + // footerPrefix : 'ISSUES CLOSED:' |
| 91 | + // askForBreakingChangeFirst : true, |
| 92 | +} |
0 commit comments