UNPKG

2.44 kBJavaScriptView Raw
1module.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 allowTicketNumber: false,
30 isTicketNumberRequired: false,
31 ticketNumberPrefix: 'TICKET-',
32 ticketNumberRegExp: '\\d{1,5}',
33
34 // it needs to match the value for field type. Eg.: 'fix'
35 /*
36 scopeOverrides: {
37 fix: [
38
39 {name: 'merge'},
40 {name: 'style'},
41 {name: 'e2eTest'},
42 {name: 'unitTest'}
43 ]
44 },
45 */
46 // override the messages, defaults are as follows
47 messages: {
48 type: "Select the type of change that you're committing:",
49 scope: '\nDenote the SCOPE of this change (optional):',
50 // used if allowCustomScopes is true
51 customScope: 'Denote the SCOPE of this change:',
52 subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
53 body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
54 breaking: 'List any BREAKING CHANGES (optional):\n',
55 footer: 'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
56 confirmCommit: 'Are you sure you want to proceed with the commit above?',
57 },
58
59 allowCustomScopes: true,
60 allowBreakingChanges: ['feat', 'fix'],
61 // skip any questions you want
62 // skipQuestions: ['scope', 'body'],
63
64 // limit subject length
65 subjectLimit: 100,
66 // breaklineChar: '|', // It is supported for fields body and footer.
67 // footerPrefix : 'ISSUES CLOSED:'
68 // askForBreakingChangeFirst : true, // default is false
69};