iosonntag_obsidian-plugin-t.../commitlint.config.js
iOSonntag 70c4688bbd
feat(ci): improve ci
- added semantic-version package to automate CHANGELOG.md creation and version bumping
- added husky commit message hook to prevent commit messages not parsable by semantic-version package
2023-09-24 06:59:18 +02:00

33 lines
1,005 B
JavaScript

/**
* @type {import('@commitlint/types').UserConfig}
*
* Commit Message Guidelines
*
* All commit message MUST follow https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
*
* Format as:
*
* ```
* <type>(<scope>): <subject>
* <BLANK LINE>
* <body>
* <BLANK LINE>
* <footer>
* ```
* Note: The **&lt;type&gt;** can be found in **./commitlint.config.js** file.
*/
module.exports = {
rules: {
'body-leading-blank': [1, 'always'],
'footer-leading-blank': [1, 'always'],
'header-max-length': [2, 'always', 72],
'scope-case': [2, 'always', 'lower-case'],
'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', ['breaking', 'build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test']],
},
};