From b2645c6474eb12f4130f80d2336a3daced7e9895 Mon Sep 17 00:00:00 2001 From: Stefan Hynek <stefan.hynek@uni-goettingen.de> Date: Fri, 22 May 2020 13:18:32 +0200 Subject: [PATCH] feat(commitizen): provide a customized commitizen adapter configuration closes #20 --- .cz-config.js | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 .cz-config.js diff --git a/.cz-config.js b/.cz-config.js new file mode 100644 index 0000000..9c8adbc --- /dev/null +++ b/.cz-config.js @@ -0,0 +1,68 @@ +module.exports = { + types: [ + { value: 'tr-s', name: 'tr-s: Small addition to or revision of Technical reference.' }, + { value: 'tr-m', name: 'tr-m: Medium addition to or revision of Technical reference.' }, + { value: 'tr-l', name: 'tr-l: Huge contribution to or revision of Technical reference.' }, + { value: 'feat', name: 'feat: A new feature' }, + { value: 'fix', name: 'fix: A bug fix' }, + { value: 'docs', name: 'docs: General documentation only changes' }, + { + value: 'style', + name: + 'style: Changes that do not affect the meaning of the code\n (white-space, formatting, missing semi-colons, etc)', + }, + { value: 'test', name: 'test: Adding missing tests' }, + { + value: 'build', + name: + 'build: Changes that affect the build system or dependencies\n (example scopes: npm, docker, pip, ant)', + }, + { + value: 'ci', + name: + 'ci: Changes to the CI configuration\n (example scopes: gitlab, travis)', + }, + { + value: 'chore', + name: + 'chore: Other changes that modify other than source or test files' + }, + { value: 'revert', name: 'revert: Revert to a commit' }, + ], + + // it needs to match the value for field type. Eg.: 'fix' + /* + scopeOverrides: { + fix: [ + + {name: 'merge'}, + {name: 'style'}, + {name: 'e2eTest'}, + {name: 'unitTest'} + ] + }, + */ + // override the messages, defaults are as follows + messages: { + type: "Select the type of change that you're committing:", + scope: '\nDenote the SCOPE of this change (optional):', + // used if allowCustomScopes is true + 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):\n', + footer: 'Reference ISSUES touched by this change (optional). E.g.: closes #31, see #34:\n', + confirmCommit: 'Are you sure you want to proceed with the commit above?', + }, + + allowCustomScopes: true, + allowBreakingChanges: ['feat', 'fix'], + // skip any questions you want + skipQuestions: ['body'], + + // limit subject length + subjectLimit: 100, + // breaklineChar: '|', // It is supported for fields body and footer. + footerPrefix : '' + // askForBreakingChangeFirst : true, // default is false +}; -- GitLab