# 安装 CLI 和 Conventional Commits 推荐配置
pnpm add -D @commitlint/cli @commitlint/config-conventional
 
# 或使用 npm
npm install --save-dev @commitlint/cli @commitlint/config-conventional

// commitlint.config.js
export default {
  extends: ['@commitlint/config-conventional'],
  rules: {
    // 自定义规则示例
    'type-enum': [
      2,
      'always',
      [
        'feat',     // 新功能
        'fix',      // 修复 bug
        'docs',     // 文档变更
        'style',    // 代码格式（不影响逻辑）
        'refactor', // 重构
        'perf',     // 性能优化
        'test',     // 测试相关
        'build',    // 构建系统或外部依赖
        'ci',       // CI 配置
        'chore',    // 其他杂务
        'revert',   // 回滚
      ],
    ],
    'subject-case': [0],            // 关闭 subject 大小写检查（适配中文）
    'subject-max-length': [2, 'always', 100],
  },
}

# 1. 安装 Husky 并初始化
pnpm add -D husky
npx husky init
 
# 2. 创建 commit-msg hook
echo "npx commitlint --edit \$1" > .husky/commit-msg
 
# 3. 测试
git commit -m "feat: 添加用户登录功能"   # ✅ 通过
git commit -m "随便写点啥"               # ❌ 报错，拒绝提交

// package.json
{
  "scripts": {
    "prepare": "husky"
  }
}

# .husky/commit-msg
npx commitlint --edit "$1"

// 项目 commitlint.config.js
export default {
  extends: ['@company/commitlint-config'],  // 团队共享配置
}

export default {
  rules: {
    'body-max-line-length': [2, 'always', 100],
    'header-max-length': [1, 'always', 120],  // 警告级别
    'type-empty': [2, 'never'],                // 禁止空 type
    'subject-full-stop': [2, 'never', '.'],    // 禁止句号结尾
  },
}

export default {
  rules: {
    'scope-enum': [2, 'always', ['api', 'ui', 'core', 'deps']],
  },
  // 当 scope 为空时跳过 scope-enum 检查
  defaultIgnores: true,
}

export default {
  parserPreset: './custom-parser.js',
}

pnpm add -D @commitlint/prompt

// package.json
{
  "config": {
    "commitizen": {
      "path": "@commitlint/prompt"
    }
  }
}

# 检查最近 N 次提交
npx commitlint --from HEAD~5 --to HEAD
 
# 或检查 PR 分支的所有提交
npx commitlint --from origin/main --to HEAD

export default {
  rules: {
    'jira-ticket': async (parsed) => {
      const { footer } = parsed
      const hasTicket = /JIRA-\d+/.test(footer || '')
      return [hasTicket, '必须在 footer 中包含 Jira Issue 编号']
    },
  },
}

// commitlint.config.ts
import type { UserConfig } from '@commitlint/types'
 
const config: UserConfig = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [2, 'always', ['feat', 'fix', 'docs']],
  },
}
 
export default config

# 安装
pnpm add -D conventional-changelog-cli
 
# 生成 CHANGELOG
npx conventional-changelog -p angular -i CHANGELOG.md -s

pnpm add -D semantic-release

# .github/workflows/release.yml
name: Release
on:
  push:
    branches: [main]
jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
      - run: npx semantic-release

// commitlint.config.js
export default {
  extends: ['@commitlint/config-conventional', '@commitlint/config-pnpm-scopes'],
}

# GitHub Actions 示例
- name: Lint commit messages
  run: npx commitlint --from origin/main --to HEAD --verbose

{
  "scripts": {
    "prepare": "husky",
    "commit": "cz",
    "lint:commits": "commitlint --from HEAD~10 --to HEAD"
  },
  "devDependencies": {
    "@commitlint/cli": "^21.2.0",
    "@commitlint/config-conventional": "^21.0.2",
    "commitizen": "^4.3.0",
    "cz-git": "^1.11.0",
    "husky": "^9.1.0",
    "lint-staged": "^15.2.0"
  },
  "config": {
    "commitizen": {
      "path": "cz-git"
    }
  },
  "lint-staged": {
    "*.{ts,tsx,vue}": ["eslint --fix", "prettier --write"]
  }
}

// commitlint.config.js
import { defineConfig } from 'cz-git'
 
export default {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'subject-case': [0],
    'subject-full-stop': [0],
  },
  prompt: {
    alias: { fd: 'docs: fix typos' },
    messages: {
      type: '选择你要提交的类型：',
      scope: '选择一个 scope（可选）：',
      subject: '填写简短描述：\n',
      body: '填写详细描述（可选，使用 "|" 换行）：\n',
      footerPrefix: '填写关联 Issue（可选）：\n',
      confirmCommit: '确认提交吗？',
    },
    types: [
      { value: 'feat', name: 'feat:     新功能' },
      { value: 'fix', name: 'fix:      修复 bug' },
      { 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:       CI 配置' },
      { value: 'chore', name: 'chore:    杂务' },
      { value: 'revert', name: 'revert:   回滚' },
    ],
    useEmoji: false,
    emojiAlign: 'center',
    themeColorCode: '',
    scopes: [],
    allowCustomScopes: true,
    allowEmptyScopes: true,
    upperCaseSubject: false,
    breaklineNumber: 100,
    breaklineChar: '|',
    skipQuestions: [],
    issuePrefixes: [{ value: 'closed', name: 'closed:   ISSUES 已完成' }],
    customIssuePrefixAlign: 'left',
    emptyIssuePrefixAlias: 'skip',
    customIssuePrefixAlias: 'custom',
    allowCustomIssuePrefix: true,
    allowEmptyIssuePrefix: true,
    confirmCommit: 'warn',
  },
}

// commitlint-config-team/index.js
module.exports = {
  rules: {
    'type-enum': [2, 'always', [
      'feat', 'fix', 'docs', 'style', 'refactor',
      'perf', 'test', 'build', 'ci', 'chore', 'revert',
    ]],
    'subject-case': [0],
    'subject-full-stop': [2, 'never', '。'],  // 中文句号
    'subject-max-length': [2, 'always', 100],
    'body-max-line-length': [1, 'always', 200],
  },
}

// package.json
{
  "name": "commitlint-config-team",
  "version": "1.0.0",
  "main": "index.js"
}

// commitlint.config.js
export default {
  extends: ['team'],  // 自动解析为 commitlint-config-team
}

// commitlint.config.js
export default {
  extends: ['@commitlint/config-conventional'],
  rules: {
    // 关闭英文大小写检查
    'subject-case': [0],
    // 关闭句号结尾检查（中文使用全角句号）
    'subject-full-stop': [2, 'never', '。'],
    // 允许中文标点
    'header-full-stop': [0],
    // type 必须存在
    'type-empty': [2, 'never'],
    // subject 必须存在
    'subject-empty': [2, 'never'],
    // subject 最大长度
    'subject-max-length': [2, 'always', 100],
    // body 每行最大长度
    'body-max-line-length': [1, 'always', 200],
  },
}

{
  types: [
    { value: 'feat', name: 'feat:     ✨ 新功能' },
    { value: 'fix', name: 'fix:      🐛 修复 bug' },
    { 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:       👷 CI/CD 配置变更' },
    { value: 'chore', name: 'chore:    🔨 其他杂务' },
    { value: 'revert', name: 'revert:   ⏪️ 回滚提交' },
    // 扩展类型
    { value: 'wip', name: 'wip:      🚧 进行中的工作' },
    { value: 'i18n', name: 'i18n:     🌍 国际化' },
    { value: 'a11y', name: 'a11y:     ♿ 无障碍' },
  ],
}

// commitlint.config.js（pnpm workspace 项目）
export default {
  extends: [
    '@commitlint/config-conventional',
    '@commitlint/config-pnpm-scopes',
  ],
}