安装配置git commit规范插件：commitlint+husky

文章索引

一、安装commitlint

npm install -D @commitlint/cli @commitlint/config-conventional

1	npm install -D @commitlint/cli @commitlint/config-conventional

二、创建并配置commitlint.config.ts

export default {
  extends: ['@commitlint/config-conventional'],
  parserPreset: 'conventional-changelog-conventionalcommits',
  rules: {
    'body-leading-blank': [1, 'always'],
    'body-max-line-length': [2, 'always', 100],
    'footer-leading-blank': [1, 'always'],
    'footer-max-line-length': [2, 'always', 100],
    'header-max-length': [2, 'always', 100],
    'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
    'subject-empty': [2, 'never'],
    'subject-full-stop': [2, 'never', '.'],
    'type-case': [2, 'always', 'lower-case'],
    'type-empty': [2, 'never'],
    'type-enum': [
      2,
      'always',
      ['build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test']
    ]
  },
  prompt: {
    questions: {
      type: {
        description: "Select the type of change that you're committing",
        enum: {
          feat: {
            description: 'A new feature',
            title: 'Features',
            emoji: '✨'
          },
          fix: {
            description: 'A bug fix',
            title: 'Bug Fixes',
            emoji: '🐛'
          },
          docs: {
            description: 'Documentation only changes',
            title: 'Documentation',
            emoji: '📚'
          },
          style: {
            description:
              'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',
            title: 'Styles',
            emoji: '💎'
          },
          refactor: {
            description: 'A code change that neither fixes a bug nor adds a feature',
            title: 'Code Refactoring',
            emoji: '📦'
          },
          perf: {
            description: 'A code change that improves performance',
            title: 'Performance Improvements',
            emoji: '🚀'
          },
          test: {
            description: 'Adding missing tests or correcting existing tests',
            title: 'Tests',
            emoji: '🚨'
          },
          build: {
            description:
              'Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)',
            title: 'Builds',
            emoji: '🛠'
          },
          ci: {
            description:
              'Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)',
            title: 'Continuous Integrations',
            emoji: '⚙️'
          },
          chore: {
            description: "Other changes that don't modify src or test files",
            title: 'Chores',
            emoji: '♻️'
          },
          revert: {
            description: 'Reverts a previous commit',
            title: 'Reverts',
            emoji: '🗑'
          }
        }
      },
      scope: {
        description: 'What is the scope of this change (e.g. component or file name)'
      },
      subject: {
        description: 'Write a short, imperative tense description of the change'
      },
      body: {
        description: 'Provide a longer description of the change'
      },
      isBreaking: {
        description: 'Are there any breaking changes?'
      },
      breakingBody: {
        description:
          'A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself'
      },
      breaking: {
        description: 'Describe the breaking changes'
      },
      isIssueAffected: {
        description: 'Does this change affect any open issues?'
      },
      issuesBody: {
        description:
          'If issues are closed, the commit requires a body. Please enter a longer description of the commit itself'
      },
      issues: {
        description: 'Add issue references (e.g. "fix #123", "re #123".)'
      }
    }
  }
}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

export default {

extends: ['@commitlint/config-conventional'],

parserPreset: 'conventional-changelog-conventionalcommits',

rules: {

'body-leading-blank': [1, 'always'],

'body-max-line-length': [2, 'always', 100],

'footer-leading-blank': [1, 'always'],

'footer-max-line-length': [2, 'always', 100],

'header-max-length': [2, 'always', 100],

'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],

'subject-empty': [2, 'never'],

'subject-full-stop': [2, 'never', '.'],

'type-case': [2, 'always', 'lower-case'],

'type-empty': [2, 'never'],

'type-enum': [

'always',

['build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test']

]

prompt: {

questions: {

type: {

description: "Select the type of change that you're committing",

enum: {

feat: {

description: 'A new feature',

title: 'Features',

emoji: '✨'

fix: {

description: 'A bug fix',

title: 'Bug Fixes',

emoji: '🐛'

docs: {

description: 'Documentation only changes',

title: 'Documentation',

emoji: '📚'

style: {

description:

'Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)',

title: 'Styles',

emoji: '💎'

refactor: {

description: 'A code change that neither fixes a bug nor adds a feature',

title: 'Code Refactoring',

emoji: '📦'

perf: {

description: 'A code change that improves performance',

title: 'Performance Improvements',

emoji: '🚀'

test: {

description: 'Adding missing tests or correcting existing tests',

title: 'Tests',

emoji: '🚨'

build: {

description:

'Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)',

title: 'Builds',

emoji: '🛠'

ci: {

description:

'Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)',

title: 'Continuous Integrations',

emoji: '⚙️'

chore: {

description: "Other changes that don't modify src or test files",

title: 'Chores',

emoji: '♻️'

revert: {

description: 'Reverts a previous commit',

title: 'Reverts',

emoji: '🗑'

}

scope: {

description: 'What is the scope of this change (e.g. component or file name)'

subject: {

description: 'Write a short, imperative tense description of the change'

body: {

description: 'Provide a longer description of the change'

isBreaking: {

description: 'Are there any breaking changes?'

breakingBody: {

description:

'A BREAKING CHANGE commit requires a body. Please enter a longer description of the commit itself'

breaking: {

description: 'Describe the breaking changes'

isIssueAffected: {

description: 'Does this change affect any open issues?'

issuesBody: {

description:

'If issues are closed, the commit requires a body. Please enter a longer description of the commit itself'

issues: {

description: 'Add issue references (e.g. "fix #123", "re #123".)'

}

三、安装husky

npm install -D husky

1	npm install -D husky

四、添加husky hook

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'

1	npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'

五、文档

https://github.com/conventional-changelog/commitlint

mac下使用sourcetree提交报错：.husky/pre-commit: Line 4 npm: command not found2023年4月27日
安装使用commitizen2022年9月21日
安装配置git commit规范插件：commitlint+husky2022年9月21日
Git修改已经提交的用户名信息2022年8月26日
解决ssh bad permissions权限报错2022年3月28日
git将某个提交合并到另一个分支2021年12月26日

北鱼IT

安装配置git commit规范插件：commitlint+husky

一、安装commitlint

二、创建并配置commitlint.config.ts

三、安装husky

四、添加husky hook

五、文档

相关文章