Skip to content

Commit abab6cd

Browse files
streamichstreamich
committedMay 23, 2018
refactor: 👌 do dependency injection of config
·
v2.0.0v1.4.0
1 parent d9d0113 commit abab6cd

File tree

5 files changed

+154
-147
lines changed

5 files changed

+154
-147
lines changed
 

‎src/prompt/LimitedInput.js ‎src/LimitedInput.js

File renamed without changes.

‎src/createPrompter.js

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
const fs = require('fs');
2+
const inquirer = require('inquirer');
3+
const wrap = require('word-wrap');
4+
const appRoot = require('app-root-path');
5+
const {
6+
createPackagesQuestion,
7+
createQuestions
8+
} = require('./questions');
9+
const LimitedInput = require('./LimitedInput');
10+
const {
11+
getAllPackages,
12+
getChangedPackages
13+
} = require('./lernaUtils');
14+
15+
const MAX_LINE_WIDTH = 72;
16+
17+
inquirer.registerPrompt('limitedInput', LimitedInput);
18+
19+
const IS_LERNA_PROJECT = fs.existsSync(appRoot.resolve('lerna.json'));
20+
21+
const makeAffectsLine = function (answers) {
22+
const selectedPackages = answers.packages;
23+
24+
if (selectedPackages && selectedPackages.length) {
25+
return `\naffects: ${selectedPackages.join(', ')}`;
26+
}
27+
28+
return '';
29+
};
30+
31+
module.exports = (config) => {
32+
const prompter = {
33+
prompter (cz, commit) {
34+
let promptQuestions = createQuestions(config);
35+
36+
if (IS_LERNA_PROJECT) {
37+
const allPackages = getAllPackages().map((pkg) => pkg.name);
38+
const changedPackages = getChangedPackages();
39+
40+
promptQuestions = promptQuestions.concat(createPackagesQuestion(allPackages, changedPackages));
41+
}
42+
43+
return inquirer.prompt(promptQuestions)
44+
.then((answers) => {
45+
const wrapOptions = {
46+
indent: '',
47+
trim: true,
48+
width: MAX_LINE_WIDTH
49+
};
50+
51+
const emoji = config.types[answers.type].emoji;
52+
const emojiPrefix = emoji ? emoji + ' ' : '';
53+
const head = answers.type + ': ' + emojiPrefix + answers.subject;
54+
const affectsLine = makeAffectsLine(answers);
55+
56+
// Wrap these lines at MAX_LINE_WIDTH character
57+
const body = wrap(answers.body + affectsLine, wrapOptions);
58+
const breaking = wrap(answers.breaking, wrapOptions);
59+
const footer = wrap(answers.footer, wrapOptions);
60+
61+
let msg;
62+
63+
msg = head;
64+
65+
if (body) {
66+
msg += '\n\n' + body;
67+
}
68+
69+
if (breaking) {
70+
msg += '\n\nBREAKING CHANGE: ' + breaking;
71+
}
72+
73+
if (footer) {
74+
msg += '\n\nIssues: ' + footer;
75+
}
76+
77+
return commit(msg);
78+
});
79+
}
80+
};
81+
82+
return prompter;
83+
};

‎src/index.js

+3-79
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,4 @@
1-
const fs = require('fs');
2-
const inquirer = require('inquirer');
3-
const wrap = require('word-wrap');
4-
const appRoot = require('app-root-path');
5-
const defaults = require('./defaults');
6-
const {
7-
makePackagesQuestion,
8-
questions
9-
} = require('./prompt/questions');
10-
const LimitedInput = require('./prompt/LimitedInput');
11-
const {
12-
getAllPackages,
13-
getChangedPackages
14-
} = require('./lernaUtils');
1+
const createPrompter = require('./createPrompter');
2+
const config = require('./defaults');
153

16-
const MAX_LINE_WIDTH = 72;
17-
18-
inquirer.registerPrompt('limitedInput', LimitedInput);
19-
20-
const IS_LERNA_PROJECT = fs.existsSync(appRoot.resolve('lerna.json'));
21-
22-
const makeAffectsLine = function (answers) {
23-
const selectedPackages = answers.packages;
24-
25-
if (selectedPackages && selectedPackages.length) {
26-
return `\naffects: ${selectedPackages.join(', ')}`;
27-
}
28-
29-
return '';
30-
};
31-
32-
module.exports = {
33-
prompter (cz, commit) {
34-
let promptQuestions = questions;
35-
36-
if (IS_LERNA_PROJECT) {
37-
const allPackages = getAllPackages().map((pkg) => pkg.name);
38-
const changedPackages = getChangedPackages();
39-
40-
promptQuestions = promptQuestions.concat(makePackagesQuestion(allPackages, changedPackages));
41-
}
42-
43-
return inquirer.prompt(promptQuestions)
44-
.then((answers) => {
45-
const wrapOptions = {
46-
indent: '',
47-
trim: true,
48-
width: MAX_LINE_WIDTH
49-
};
50-
51-
const emoji = defaults.types[answers.type].emoji;
52-
const emojiPrefix = emoji ? emoji + ' ' : '';
53-
const head = answers.type + ': ' + emojiPrefix + answers.subject;
54-
const affectsLine = makeAffectsLine(answers);
55-
56-
// Wrap these lines at MAX_LINE_WIDTH character
57-
const body = wrap(answers.body + affectsLine, wrapOptions);
58-
const breaking = wrap(answers.breaking, wrapOptions);
59-
const footer = wrap(answers.footer, wrapOptions);
60-
61-
let msg;
62-
63-
msg = head;
64-
65-
if (body) {
66-
msg += '\n\n' + body;
67-
}
68-
69-
if (breaking) {
70-
msg += '\n\nBREAKING CHANGE: ' + breaking;
71-
}
72-
73-
if (footer) {
74-
msg += '\n\nIssues: ' + footer;
75-
}
76-
77-
return commit(msg);
78-
});
79-
}
80-
};
4+
module.exports = createPrompter(config);

‎src/prompt/questions.js

-68
This file was deleted.

‎src/questions.js

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
const pad = require('pad-right');
2+
3+
const typeToListItem = ({description, emoji, value}) => ({
4+
name: (emoji || '❔') + ' ' + pad(value + ':', 12, ' ') + description,
5+
value
6+
});
7+
8+
const createQuestions = (config) => {
9+
const MIN_SUBJECT_LENGTH_ERROR_MESSAGE = `The subject must have at least ${config.minMessageLength} characters`;
10+
const questions = [
11+
{
12+
choices: config.list.map((type) => typeToListItem(config.types[type])),
13+
message: 'Select the type of change that you\'re committing:',
14+
name: 'type',
15+
type: 'list'
16+
},
17+
{
18+
filter: (input) => {
19+
let subject;
20+
21+
subject = input.trim();
22+
while (subject.endsWith('.')) {
23+
subject = subject.substr(0, subject.length - 1).trim();
24+
}
25+
26+
return subject;
27+
},
28+
leadingLabel: (answers) => `${answers.type}:`,
29+
30+
// Minus 3 chars are for emoji + space.
31+
maxLength: config.maxMessageLength - 3,
32+
message: 'Write a short, imperative mood description of the change:',
33+
name: 'subject',
34+
type: 'limitedInput',
35+
validate: (input) => input.length >= config.minMessageLength || MIN_SUBJECT_LENGTH_ERROR_MESSAGE
36+
},
37+
{
38+
message: 'Provide a longer description of the change:\n',
39+
name: 'body',
40+
type: 'input'
41+
},
42+
{
43+
message: 'List any breaking changes:\n BREAKING CHANGE:',
44+
name: 'breaking',
45+
type: 'input'
46+
},
47+
{
48+
message: 'Reference any task that this commit closes:\n Issues:',
49+
name: 'footer',
50+
type: 'input'
51+
}
52+
];
53+
54+
return questions;
55+
};
56+
57+
const createPackagesQuestion = (allPackages, changedPackages) => ({
58+
choices: allPackages,
59+
default: changedPackages,
60+
message: `The packages that this commit has affected (${changedPackages.length} detected)\n`,
61+
name: 'packages',
62+
type: 'checkbox'
63+
});
64+
65+
module.exports = {
66+
createPackagesQuestion,
67+
createQuestions
68+
};

0 commit comments

Comments
 (0)
Please sign in to comment.