|
| 1 | +module.exports = { |
| 2 | + types: [ |
| 3 | + { value: 'feat', name: 'feat: A new feature' }, |
| 4 | + { value: 'fix', name: 'fix: A bug fix' }, |
| 5 | + { value: 'docs', name: 'docs: Documentation only changes' }, |
| 6 | + { |
| 7 | + value: 'style', |
| 8 | + name: 'style: Changes that do not affect the meaning of the code\n (white-space, formatting, missing semi-colons, etc)', |
| 9 | + }, |
| 10 | + { |
| 11 | + value: 'refactor', |
| 12 | + name: 'refactor: A code change that neither fixes a bug nor adds a feature', |
| 13 | + }, |
| 14 | + { |
| 15 | + value: 'perf', |
| 16 | + name: 'perf: A code change that improves performance', |
| 17 | + }, |
| 18 | + { value: 'test', name: 'test: Adding missing tests' }, |
| 19 | + { |
| 20 | + value: 'chore', |
| 21 | + name: 'chore: Changes to the build process or auxiliary tools\n and libraries such as documentation generation', |
| 22 | + }, |
| 23 | + { value: 'revert', name: 'revert: Revert to a commit' }, |
| 24 | + { value: 'WIP', name: 'WIP: Work in progress' }, |
| 25 | + ], |
| 26 | + |
| 27 | + scopes: [{ name: 'accounts' }, { name: 'admin' }, { name: 'exampleScope' }, { name: 'changeMe' }], |
| 28 | + |
| 29 | + usePreparedCommit: false, // to re-use commit from ./.git/COMMIT_EDITMSG |
| 30 | + allowTicketNumber: false, |
| 31 | + isTicketNumberRequired: false, |
| 32 | + ticketNumberPrefix: 'TICKET-', |
| 33 | + ticketNumberRegExp: '\\d{1,5}', |
| 34 | + |
| 35 | + // it needs to match the value for field type. Eg.: 'fix' |
| 36 | + /* |
| 37 | + scopeOverrides: { |
| 38 | + fix: [ |
| 39 | +
|
| 40 | + {name: 'merge'}, |
| 41 | + {name: 'style'}, |
| 42 | + {name: 'e2eTest'}, |
| 43 | + {name: 'unitTest'} |
| 44 | + ] |
| 45 | + }, |
| 46 | + */ |
| 47 | + // override the messages, defaults are as follows |
| 48 | + messages: { |
| 49 | + type: "Select the type of change that you're committing:", |
| 50 | + scope: '\nDenote the SCOPE of this change (optional):', |
| 51 | + // used if allowCustomScopes is true |
| 52 | + customScope: 'Denote the SCOPE of this change:', |
| 53 | + subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n', |
| 54 | + body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n', |
| 55 | + breaking: 'List any BREAKING CHANGES (optional):\n', |
| 56 | + footer: 'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n', |
| 57 | + confirmCommit: 'Are you sure you want to proceed with the commit above?', |
| 58 | + }, |
| 59 | + |
| 60 | + allowCustomScopes: true, |
| 61 | + allowBreakingChanges: ['feat', 'fix'], |
| 62 | + // skip any questions you want |
| 63 | + // skipQuestions: ['scope', 'body'], |
| 64 | + |
| 65 | + // limit subject length |
| 66 | + subjectLimit: 100, |
| 67 | + // breaklineChar: '|', // It is supported for fields body and footer. |
| 68 | + // footerPrefix : 'ISSUES CLOSED:' |
| 69 | + // askForBreakingChangeFirst : true, // default is false |
| 70 | +}; |
0 commit comments