✨ Feat: add scope and default values (fixes #18)

Author: JPeer264

README.md

@@ -41,10 +41,30 @@ $ sgc
 You can even create a global config. Just go to your users home and create a `.sgcrc`. The global config will be triggered if no project configurations are present.
 
 **Options:**
+- [questions](#questions)
 - [emojies](#emojies)
 - [types](#types)
 - [rules](#rules)
 
+### questions
+
+**Type:** `object`
+
+**Options:**
+- `scope` Asks for the scope in parentheses of the commit. Default: `false`
+- `moreInfo` Asks if more info (body) should be added. Default: `true`
+
+An object with predefined settings, what should be asked.
+
+Example:
+```js
+{
+  "questions": {
+    "scope": true
+  }
+}
+```
+
 ### emojies
 
 **Type:** `boolean`

lib/cli.js

@@ -10,6 +10,7 @@ import updateNotifier from 'update-notifier';
 import pkg from '../package.json';
 import getConfig from './getConfig';
 import questions from './questions';
+import combineTypeScope from './helpers/combineTypeScope';
 
 const config = getConfig();
 const questionsList = questions(config);
@@ -31,7 +32,8 @@ if (argv.v) {
   console.error(chalk.red('Please', chalk.bold('git add'), 'some files first before you commit.'));
 } else {
   inquirer.prompt(questionsList).then((answers) => {
-    const message = answers.moreInfo ? `${answers.editor}` : `${answers.type} ${answers.description}`;
+    const typeScope = combineTypeScope(answers.type, answers.scope);
+    const message = answers.moreInfo ? `${answers.editor}` : `${typeScope} ${answers.description}`;
 
     return execa('git', ['commit', '-m', message], { stdio: 'inherit' })
       .catch(() => {

lib/getConfig.js

@@ -1,6 +1,7 @@
 import os from 'os';
 import path from 'path';
 import json from 'json-extra';
+import merge from 'lodash.merge';
 
 const cwd = process.cwd();
 const homedir = os.homedir();
@@ -18,7 +19,17 @@ const getConfig = (altPath) => {
   //   - 2. (package.json).sgc
   // 2. global config
   // 3. default config from ../.sgcrc_default
-  const config = configObject || packageConfig || globalConfig || sgcrcDefaultConfig;
+  let config = configObject || packageConfig || globalConfig || sgcrcDefaultConfig;
+
+  // set defaults
+  const configDefaults = {
+    questions: {
+      scope: false,
+      moreInfo: true,
+    },
+  };
+
+  config = merge({}, configDefaults, config);
 
   return config;
 };

lib/helpers/combineTypeScope.js

@@ -0,0 +1,22 @@
+const combineTypeScope = (type, scope) => {
+  let thisType = type;
+  let thisScope = scope;
+
+  if (thisScope === undefined) {
+    thisScope = '';
+  }
+
+  // add scope correctly if ':' is at the end
+  if (thisScope.length > 0) {
+    if (thisType.charAt(thisType.length - 1) === ':') {
+      thisType = thisType.slice(0, thisType.length - 1);
+      thisType = `${thisType} ${thisScope}:`;
+    } else {
+      thisType = `${thisType} ${thisScope}`;
+    }
+  }
+
+  return thisType;
+};
+
+export default combineTypeScope;

lib/questions.js

@@ -1,11 +1,12 @@
 import chalk from 'chalk';
 import ruleWarningMessages from './rules/ruleWarningMessages';
+import combineTypeScope from './helpers/combineTypeScope';
 
-const choices = (configuration) => {
+const choices = (config) => {
   const choicesList = [];
 
-  configuration.types.forEach((type) => {
-    const isEmojies = configuration.emojies === undefined ? true : configuration.emojies;
+  config.types.forEach((type) => {
+    const isEmojies = config.emojies === undefined ? true : config.emojies;
     const emoji = isEmojies && type.emoji ? `${type.emoji} ` : '';
     const configType = type.type;
     const description = type.description || '';
@@ -28,6 +29,13 @@ const questions = (config) => {
       message: 'Select the type of your commit:',
       choices: choicesList,
     },
+    {
+      type: 'input',
+      name: 'scope',
+      message: 'Enter your scope (no whitespaces allowed):',
+      when: () => config.questions.scope,
+      filter: answers => (answers ? `(${answers})` : answers),
+    },
     {
       type: 'input',
       name: 'description',
@@ -42,14 +50,19 @@ const questions = (config) => {
       type: 'confirm',
       name: 'moreInfo',
       message: 'Do you want to add more information to your commit?',
+      when: () => config.questions.moreInfo,
       default: false,
     },
     {
       type: 'editor',
       name: 'editor',
       message: 'This will let you add more information',
       when: answers => answers.moreInfo,
-      default: answers => `${answers.type} ${answers.description}\n\n\n`,
+      default: (answers) => {
+        const type = combineTypeScope(answers.type, answers.scope);
+
+        return `${type} ${answers.description}\n\n\n`;
+      },
     },
   ];
 

package.json

@@ -68,6 +68,7 @@
     "is-git-added": "^1.0.1",
     "is-git-repository": "^1.0.1",
     "json-extra": "^0.5.0",
+    "lodash.merge": "^4.6.0",
     "object.entries": "^1.0.4",
     "update-notifier": "^2.1.0",
     "yargs": "^7.0.2"

test/fixtures/.sgcrc

@@ -1,4 +1,8 @@
 {
+  "questions": {
+    "scope": false,
+    "moreInfo": true
+  },
   "types": [
     {
       "emoji": ":emo:",

test/getConfig.js

@@ -15,7 +15,6 @@ const randomString = Math.random().toString(36).replace(/[^a-z]+/g, '').substr(0
 
 let globalExist = false;
 
-
 // rename global .sgcrc
 test.before(() => {
   if (fs.existsSync(path.join(homedir, '.sgcrc'))) {
@@ -24,7 +23,7 @@ test.before(() => {
   }
 });
 
-test.after(() => {
+test.after.always(() => {
   if (globalExist) {
     fs.renameSync(path.join(homedir, `.sgcrc.${randomString}-${datetime}.back`), path.join(homedir, '.sgcrc'));
   }
@@ -35,10 +34,17 @@ test('read config from a specific path', (t) => {
 });
 
 test('read config from a .sgcrc_default', (t) => {
-  t.deepEqual(getConfig(), json.readToObjSync(path.join(cwd, '.sgcrc_default')));
+  const globalConfig = json.readToObjSync(path.join(cwd, '.sgcrc_default'));
+
+  globalConfig.questions = {
+    scope: false,
+    moreInfo: true,
+  };
+
+  t.deepEqual(getConfig(), globalConfig);
 });
 
-test.serial('read config from package.json', (t) => {
+test('read config from package.json', (t) => {
   const sgcrc = json.readToObjSync(path.join(fixtures, '.sgcrc'));
   const packageJson = json.readToObjSync(path.join(cwd, 'package.json'));
 

test/helpers/combineTypeScope.js

@@ -0,0 +1,8 @@
+import test from 'ava';
+
+import combineTypeScope from '../../lib/helpers/combineTypeScope';
+
+test('check if the combination is correct', (t) => {
+  t.is(combineTypeScope('Type:', '(scope)'), 'Type (scope):');
+  t.is(combineTypeScope('Type', '(scope)'), 'Type (scope)');
+});

test/questions.js

@@ -2,7 +2,6 @@ import os from 'os';
 import test from 'ava';
 import path from 'path';
 import fs from 'fs-extra';
-import json from 'json-extra';
 
 import getConfig from '../lib/getConfig';
 import questions, { choices } from '../lib/questions';
@@ -25,16 +24,12 @@ test.before(() => {
   }
 });
 
-test.after(() => {
+test.after.always(() => {
   if (globalExist) {
     fs.renameSync(path.join(homedir, `.sgcrc.${randomString}-${datetime}.back`), path.join(homedir, '.sgcrc'));
   }
 });
 
-test('get configuration file equals .sgcrc_default', (t) => {
-  t.deepEqual(getConfig(), json.readToObjSync(path.join(cwd, '.sgcrc_default')));
-});
-
 test('choices are rendered without emojis', (t) => {
   const sgc = getConfig(path.join(fixtures, '.sgcrc'));
 
@@ -56,22 +51,37 @@ test('check the values of the question object', (t) => {
   const config = getConfig();
   const questionsList = questions(config);
 
-  t.deepEqual(typeof questionsList, 'object');
+  t.is(typeof questionsList, 'object');
+});
+
+test('check if scope is off by default', (t) => {
+  const config = getConfig();
+  const questionsList = questions(config);
+
+  t.is(questionsList[1].when(), false);
+});
+
+test('check if scope validates correctly', (t) => {
+  const config = getConfig();
+  const questionsList = questions(config);
+
+  t.is(questionsList[1].filter('answer'), '(answer)');
+  t.is(questionsList[1].filter(''), '');
 });
 
 test('validate functions in questions', (t) => {
   const config = getConfig();
   const questionsList = questions(config);
 
-  t.deepEqual(questionsList[1].validate('input text'), true);
-  t.deepEqual(questionsList[1].validate('This message has over 72 characters. So this test will definitely fail. I can guarantee that I am telling the truth'), 'The commit message is not allowed to be longer as 72. Consider writing a body.\n');
+  t.is(questionsList[2].validate('input text'), true);
+  t.is(questionsList[2].validate('This message has over 72 characters. So this test will definitely fail. I can guarantee that I am telling the truth'), 'The commit message is not allowed to be longer as 72. Consider writing a body.\n');
 });
 
 test('when and default functions in questions', (t) => {
   const config = getConfig();
   const questionsList = questions(config);
 
-  t.deepEqual(questionsList[3].when({ moreInfo: true }), true);
-  t.deepEqual(questionsList[3].when({ moreInfo: false }), false);
-  t.deepEqual(questionsList[3].default({ type: ':wrench: Chore:', description: 'This is a commit message!', moreInfo: true }), ':wrench: Chore: This is a commit message!\n\n\n');
+  t.is(questionsList[4].when({ moreInfo: true }), true);
+  t.is(questionsList[4].when({ moreInfo: false }), false);
+  t.deepEqual(questionsList[4].default({ type: ':wrench: Chore:', description: 'This is a commit message!', moreInfo: true }), ':wrench: Chore: This is a commit message!\n\n\n');
 });