Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: predefined scope options #126

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Feature: predefined scope options #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8760413
refactor: lift inquirer up to the initialization of engine from the p…
ThisIsMissEm Jul 29, 2020
9997ea9
refactor: improve loading of configuration
ThisIsMissEm Jul 29, 2020
19d41d7
feat: improve debuggability of tests
ThisIsMissEm Jul 29, 2020
23e0356
feat(engine): implement scope choices
ThisIsMissEm Jul 29, 2020
1964940
test: improve coverage for subject max header length
ThisIsMissEm Jul 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 85 additions & 16 deletions engine.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,55 +36,119 @@ var filterSubject = function(subject) {
// This can be any kind of SystemJS compatible module.
// We use Commonjs here, but ES6 or AMD would do just
// fine.
module.exports = function(options) {
module.exports = function(options, inquirer) {
var types = options.types;

var length = longest(Object.keys(types)).length + 1;
var choices = map(types, function(type, key) {
var longestTypeChoice = longest(Object.keys(types)).length + 1;
var typeChoices = map(types, function(type, key) {
return {
name: (key + ':').padEnd(length) + ' ' + type.description,
name: (key + ':').padEnd(longestTypeChoice) + ' ' + type.description,
value: key
};
});

var predefinedScopes = options.scopes || [];
var hasPredefinedScopes = predefinedScopes.length > 0;

var otherScopeChoice = 'something else...';
var scopeChoices = [{ name: chalk.dim(chalk.white('(skip)')), value: '' }]
.concat(
map(predefinedScopes, function(scope) {
return {
name: scope,
value: scope
};
})
)
.concat([
new inquirer.Separator(''),
{ name: otherScopeChoice, value: otherScopeChoice }
]);

var defaultScopeChoice;

if (options.defaultScope) {
var foundDefault = scopeChoices.findIndex(function(choice) {
if (choice.type === 'separator') {
return false;
}
return (
choice.value === options.defaultScope ||
choice.name === options.defaultScope
);
});

defaultScopeChoice =
foundDefault === -1 ? scopeChoices.length - 1 : foundDefault;
}

return {
// 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.
// be executed.
//
// 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) {
prompter: function(commit) {
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may be able to simplify the engine even more by just having it directly run cz.prompt / inquirer.prompt, but doing such a change right now would result in the changes due to predefined scopes being obscured. THis future change would look like:

module.exports = function(options, inquirer, commit) {
  // ...
  inquirer.prompt().then(...)
}

Without returning a "prompter" method here.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Essentially I'm trying to make this easier to review by avoiding changes that would make additional lines of code look changed when they've not actually changed, other than an indentation level change.

// 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.

// FIXME: Avoid changing the entire file because of the longer variable of inquirer vs cz
var cz = inquirer;

cz.prompt([
{
type: 'list',
name: 'type',
message: "Select the type of change that you're committing:",
choices: choices,
choices: typeChoices,
default: options.defaultType
},
{
type: 'list',
name: 'scopeChoices',
message:
'What is the scope of this change' +
(defaultScopeChoice > 0 ? '' : ' (press enter to skip)') +
':',
choices: scopeChoices,
default: function() {
return (
scopeChoices[defaultScopeChoice] &&
scopeChoices[defaultScopeChoice].value
);
},
filter: function(value) {
return options.disableScopeLowerCase
? value.trim()
: value.trim().toLowerCase();
},
when: function() {
return hasPredefinedScopes;
}
},
{
type: 'input',
name: 'scope',
message:
'What is the scope of this change (e.g. component or file name): (press enter to skip)',
'What is the scope of this change (e.g. component or file name): ' +
chalk.grey('(press enter to skip)') +
'\n> ',
default: options.defaultScope,
filter: function(value) {
return options.disableScopeLowerCase
? value.trim()
: value.trim().toLowerCase();
},
when: function(answers) {
return (
(answers.scopeChoices &&
answers.scopeChoices === otherScopeChoice) ||
!hasPredefinedScopes
);
}
},
{
Expand Down Expand Up @@ -197,7 +261,12 @@ module.exports = function(options) {
};

// parentheses are only needed when a scope is present
var scope = answers.scope ? '(' + answers.scope + ')' : '';
var scope;
if (answers.scopeChoices && answers.scopeChoices !== otherScopeChoice) {
scope = '(' + answers.scopeChoices + ')';
} else {
scope = answers.scope ? '(' + answers.scope + ')' : '';
}

// Hard limit this line in the validate
var head = answers.type + scope + ': ' + answers.subject;
Expand Down
Loading