forked from commitizen/cz-conventional-changelog
-
Notifications
You must be signed in to change notification settings - Fork 3
/
index.js
87 lines (81 loc) · 2.83 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
// This can be any kind of SystemJS compatible module.
// We use Commonjs here, but ES6 or AMD would do just
// fine.
module.exports = {
// When a user runs `git cz`, prompter will
// be executed. We pass you cz, which currently
// is just an instance of inquirer.js. Using
// this you can ask questions and get answers.
//
// The commit callback should be executed when
// you're ready to send back a commit template
// to git.
//
// By default, we'll de-indent your commit
// template and will keep empty lines.
prompter: function(cz, commit) {
console.log('\nAll commit message lines will be cropped at 100 characters.\n');
// Let's ask some questions of the user
// so that we can populate our commit
// template.
//
// See inquirer.js docs for specifics.
// You can also opt to use another input
// collection library if you prefer.
cz.prompt([
{
type: 'list',
name: 'type',
message: 'Select the type of change that you\'re committing:',
choices: [
{
name: 'feat: A new feature',
value: 'feat'
}, {
name: 'fix: A bug fix',
value: 'fix'
}, {
name: 'docs: Documentation only changes',
value: 'docs'
}, {
name: 'style: Changes that do not affect the meaning of the code\n (white-space, formatting, missing semi-colons, etc)',
value: 'style'
}, {
name: 'refactor: A code change that neither fixes a bug or adds a feature',
value: 'refactor'
}, {
name: 'perf: A code change that improves performance',
value: 'perf'
}, {
name: 'test: Adding missing tests',
value: 'test'
}, {
name: 'chore: Changes to the build process or auxiliary tools\n and libraries such as documentation generation',
value: 'chore'
}]
}, {
type: 'input',
name: 'scope',
message: 'Denote the scope of this change ($location, $browser, $compile, etc.):\n'
}, {
type: 'input',
name: 'subject',
message: 'Write a short, imperative tense description of the change:\n'
}, {
type: 'input',
name: 'body',
message: 'Provide a longer description of the change:\n'
}, {
type: 'input',
name: 'footer',
message: 'List any breaking changes or issues closed by this change:\n'
}
], function(answers) {
// Plug the answers into our template
// By default, we dedent this for you
commit(`${answers.type}(${answers.scope}): ${answers.subject}`.slice(0, 100) + `
` + answers.body.slice(0, 100) + `
` + answers.footer.slice(0, 100));
});
}
}