Last active
November 8, 2021 13:08
-
-
Save kocoler/517fbd7a806d69b4b7a80fef29c14414 to your computer and use it in GitHub Desktop.
configs to commitinit
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
module.exports = { | |
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', 'upper-case']], | |
'type-empty': [2, 'never'], | |
'type-enum': [ | |
2, | |
'always', | |
[ | |
'chore', // chore | |
'ci', // ci | |
'docs', // docs | |
'feat', // new feature | |
'fix', // fix | |
'to', // to | |
'perf', // improve performance | |
'refactor', // refactor | |
'revert', // revert | |
'style', // code style | |
'test', // add testing | |
'merge', // merge code | |
'sync', // sync bug(?) | |
], | |
], | |
}, | |
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: 'π', | |
}, | |
to: { | |
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: 'π¨', | |
}, | |
sync: { | |
description: | |
'Sync master or branch bugs', | |
title: 'Sync', | |
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".)', | |
}, | |
}, | |
}, | |
}; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment