|
| 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: 'cleanup', |
| 8 | + name: |
| 9 | + 'cleanup: A code change that neither fixes a bug nor adds a feature', |
| 10 | + }, |
| 11 | + { |
| 12 | + value: 'chore', |
| 13 | + name: "chore: Other changes that don't modify src or test files", |
| 14 | + }, |
| 15 | + ], |
| 16 | + |
| 17 | + scopes: [ |
| 18 | + { name: 'schematics', description: 'anything related to the ddd schematics' }, |
| 19 | + { name: 'repo', description: 'anything making improvements on the repo' }, |
| 20 | + { name: 'misc', description: 'misc stuff' }, |
| 21 | + ], |
| 22 | + |
| 23 | + allowTicketNumber: true, |
| 24 | + isTicketNumberRequired: false, |
| 25 | + ticketNumberPrefix: 'TICKET-', |
| 26 | + ticketNumberRegExp: '\\d{1,5}', |
| 27 | + |
| 28 | + // it needs to match the value for field type. Eg.: 'fix' |
| 29 | + /* |
| 30 | + scopeOverrides: { |
| 31 | + fix: [ |
| 32 | + {name: 'merge'}, |
| 33 | + {name: 'style'}, |
| 34 | + {name: 'e2eTest'}, |
| 35 | + {name: 'unitTest'} |
| 36 | + ] |
| 37 | + }, |
| 38 | + */ |
| 39 | + // override the messages, defaults are as follows |
| 40 | + messages: { |
| 41 | + type: "Select the type of change that you're committing:", |
| 42 | + scope: '\nDenote the SCOPE of this change (optional):', |
| 43 | + // used if allowCustomScopes is true |
| 44 | + customScope: 'Denote the SCOPE of this change:', |
| 45 | + subject: |
| 46 | + 'Write a SHORT, IMPERATIVE (lowercase) description of the change:\n', |
| 47 | + body: |
| 48 | + 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n', |
| 49 | + breaking: 'List any BREAKING CHANGES (optional):\n', |
| 50 | + footer: |
| 51 | + 'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n', |
| 52 | + confirmCommit: 'Are you sure you want to proceed with the commit above?', |
| 53 | + }, |
| 54 | + |
| 55 | + allowCustomScopes: false, |
| 56 | + allowBreakingChanges: ['feat', 'fix'], |
| 57 | + // skip any questions you want |
| 58 | + skipQuestions: ['ticketNumber'], |
| 59 | + |
| 60 | + // limit subject length |
| 61 | + subjectLimit: 100, |
| 62 | + // breaklineChar: '|', // It is supported for fields body and footer. |
| 63 | + // footerPrefix : 'ISSUES CLOSED:' |
| 64 | + // askForBreakingChangeFirst : true, // default is false |
| 65 | +}; |
0 commit comments