| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148 |
- const fs = require('fs')
- const path = require('path')
- const { execSync } = require('child_process')
- const scopes = fs
- .readdirSync(path.resolve(__dirname, 'src'), { withFileTypes: true })
- .filter((dirent) => dirent.isDirectory())
- .map((dirent) => dirent.name.replace(/s$/, ''))
- // precomputed scope
- const scopeComplete = execSync('git status --porcelain || true')
- .toString()
- .trim()
- .split('\n')
- .find((r) => ~r.indexOf('M src'))
- ?.replace(/(\/)/g, '%%')
- ?.match(/src%%((\w|-)*)/)?.[1]
- ?.replace(/s$/, '')
- module.exports = {
- ignores: [(commit) => commit.includes('init')],
- extends: ['@commitlint/config-conventional'],
- rules: {
- 'body-leading-blank': [2, 'always'],
- 'footer-leading-blank': [1, 'always'],
- 'header-max-length': [2, 'always', 108],
- 'subject-empty': [2, 'never'],
- 'type-empty': [2, 'never'],
- 'subject-case': [0],
- // 'type-enum': [
- // 2,
- // 'always',
- // [
- // 'feat',
- // 'fix',
- // 'perf',
- // 'style',
- // 'docs',
- // 'test',
- // 'refactor',
- // 'build',
- // 'ci',
- // 'chore',
- // 'revert',
- // 'wip',
- // 'workflow',
- // 'types',
- // 'release',
- // ],
- // ],
- },
- prompt: {
- /** @use `pnpm commit :f` */
- useEmoji: false,
- 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,
- minSubjectLength: 0,
- defaultBody: '',
- defaultIssues: '',
- defaultScope: '',
- defaultSubject: '',
- // 中英文对照版
- messages: {
- type: "选择你要提交的类型 | Select the type of change that you're committing:",
- scope: '选择一个提交范围(可选) | Denote the SCOPE of this change (optional):',
- customScope: '请输入自定义的提交范围 | Denote the SCOPE of this change:',
- subject:
- '填写简短精炼的变更描述 | Write a SHORT, IMPERATIVE tense description of the change:\n',
- body: '填写更加详细的变更描述(可选)。使用 \'|\' 换行 | Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
- breaking:
- '列举非兼容性重大的变更(可选)。使用 \'|\' 换行 | List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
- footerPrefixesSelect:
- '选择关联issue前缀(可选) | Select the ISSUES type of changeList by this change (optional):',
- customFooterPrefix: '输入自定义issue前缀 | Input ISSUES prefix:',
- footer:
- '列举关联issue (可选) 例如: #31, #I3244 | List any ISSUES by this change. E.g.: #31, #34:\n',
- generatingByAI: 'Generating your AI commit subject...',
- generatedSelectByAI: 'Select suitable subject by AI generated:',
- confirmCommit:
- '是否提交或修改commit? | Are you sure you want to proceed with the commit above?',
- },
- types: [
- { value: 'feat', name: 'feat: 新增功能 | A new feature', emoji: ':sparkles:' },
- { value: 'fix', name: 'fix: 修复缺陷 | A bug fix', emoji: ':bug:' },
- { value: 'docs', name: 'docs: 文档更新 | Documentation only changes', emoji: ':memo:' },
- {
- value: 'style',
- name: 'style: 代码格式 | Changes that do not affect the meaning of the code',
- emoji: ':lipstick:',
- },
- {
- value: 'refactor',
- name: 'refactor: 代码重构 | A code change that neither fixes a bug nor adds a feature',
- emoji: ':recycle:',
- },
- {
- value: 'perf',
- name: 'perf: 性能提升 | A code change that improves performance',
- emoji: ':zap:',
- },
- {
- value: 'test',
- name: 'test: 测试相关 | Adding missing tests or correcting existing tests',
- emoji: ':white_check_mark:',
- },
- {
- value: 'build',
- name: 'build: 构建相关 | Changes that affect the build system or external dependencies',
- emoji: ':package:',
- },
- {
- value: 'ci',
- name: 'ci: 持续集成 | Changes to our CI configuration files and scripts',
- emoji: ':ferris_wheel:',
- },
- {
- value: 'chore',
- name: 'chore: 其他修改 | Other changes that do not modify src or test files',
- emoji: ':hammer:',
- },
- { value: 'revert', name: 'revert: 回退代码 | Revert to a commit', emoji: ':rewind:' },
- ],
- // emptyScopesAlias: 'empty: 不填写',
- // customScopesAlias: 'custom: 自定义',
- },
- }
|