Merge pull request #14 from JPeer264/feat/rules

Feat/rules

Author: JPeer264

.sgcrc_default

@@ -45,5 +45,10 @@
       "type": "Test:",
       "description": "Adding missing tests or correcting existing tests"
     }
-  ]
+  ],
+  "rules": {
+    "max-char": 72,
+    "min-char": 10,
+    "end-with-dot": false
+  }
 }

lib/cli.js

@@ -11,7 +11,7 @@ import { choices, questions } from './promptConfig';
 
 const configuration = getConfig();
 const choicesList = choices(configuration);
-const questionsList = questions(choicesList);
+const questionsList = questions(choicesList, configuration);
 const argv = yargs
   .usage('Usage: $0')
   .alias('v', 'version')

lib/promptConfig.js

@@ -1,4 +1,5 @@
 import chalk from 'chalk';
+import ruleWarningMessages from './rules/ruleWarningMessages';
 
 const choices = (configuration) => {
   const choicesList = [];
@@ -29,7 +30,13 @@ const questions = (choicesList) => {
       type: 'input',
       name: 'description',
       message: 'Enter your commit message:',
-      validate: input => (input ? true : 'A commit message is mandatory!'),
+      validate: (input) => {
+        const warnings = ruleWarningMessages(input);
+
+        if (warnings) return warnings;
+
+        return true;
+      },
     },
     {
       type: 'confirm',

lib/rules/availableRules.js

@@ -0,0 +1,29 @@
+import getConfig from '../getConfig';
+
+const configuration = getConfig();
+
+const rules = {
+  endWithDot: {
+    message: 'The commit message can not end with a dot',
+    check: (input) => {
+      if (input[input.length - 1] === '.') return false;
+      return true;
+    },
+  },
+  maxChar: {
+    message: `The commit message is not allowed to be longer as ${configuration.rules['max-char']}. Consider writing a body.`,
+    check: (input) => {
+      if (input.length > configuration.rules['max-char']) return false;
+      return true;
+    },
+  },
+  minChar: {
+    message: `The commit message has to be at least ${configuration.rules['min-char']} character.`,
+    check: (input) => {
+      if (input.length < configuration.rules['min-char']) return false;
+      return true;
+    },
+  },
+};
+
+export default rules;

lib/rules/ruleWarningMessages.js

@@ -0,0 +1,21 @@
+import entries from 'object.entries';
+import getConfig from '../getConfig';
+import rules from './availableRules';
+
+const configuration = getConfig();
+
+const ruleWarningMessages = (input) => {
+  let warningMessage = '';
+  const configRuleEntries = entries(configuration.rules);
+
+  configRuleEntries.forEach((rule) => {
+    const camelCaseRuleName = (rule[0]).replace(/-([a-z])/g, g => (g[1].toUpperCase()));
+    const ruleIs = rules[camelCaseRuleName].check(input);
+
+    if (!ruleIs) warningMessage += `${rules[camelCaseRuleName].message}\n`;
+  });
+
+  return warningMessage;
+};
+
+export default ruleWarningMessages;

package.json

@@ -17,7 +17,10 @@
     "prepush": "npm test"
   },
   "ava": {
-    "require": "babel-register",
+    "require": [
+      "babel-register",
+      "babel-polyfill"
+    ],
     "babel": "inherit"
   },
   "nyc": {
@@ -47,6 +50,7 @@
   "devDependencies": {
     "ava": "^0.18.2",
     "babel-cli": "^6.24.0",
+    "babel-polyfill": "^6.23.0",
     "babel-preset-env": "^1.2.1",
     "coveralls": "^2.12.0",
     "eslint": "^3.17.1",
@@ -61,6 +65,7 @@
     "execa": "^0.6.1",
     "inquirer": "^3.0.6",
     "json-extra": "^0.5.0",
+    "object.entries": "^1.0.4",
     "update-notifier": "^2.1.0",
     "yargs": "^7.0.2"
   }

test/fixtures/.sgcrc

@@ -5,5 +5,10 @@
       "type": "Add:",
       "description": "Files added"
     }
-  ]
+  ],
+  "rules": {
+    "max-char": 72,
+    "min-char": 10,
+    "end-with-dot": false
+  }
 }

test/prompConfig.js

@@ -11,43 +11,40 @@ test('get configuration file equals .sgcrc_default', (t) => {
   t.deepEqual(getConfig(), json.readToObjSync(path.join(cwd, '.sgcrc_default')));
 });
 
-test('choices are the same as choices generated from .sgcrc_default', (t) => {
-  const sgc = getConfig();
-  const configuration = getConfig();
-  const choicesList = choices(configuration);
+test('choices are the same as choices generated from .sgcrc_default', async (t) => {
+  const sgc = await getConfig();
+  const choicesList = await choices(sgc);
   const choicesArray = [];
 
-  Promise.resolve(() => {
-    sgc.types.forEach((type) => {
-      const emoji = `${type.emoji} ` || '';
-      const configType = type.type;
-      const description = type.description || '';
-
-      choicesArray.push({
-        value: emoji + configType,
-        name: `${chalk.bold(configType)} ${description}`,
-      });
-    }).then(() => {
-      t.deepEqual(choicesList, choicesArray);
+  sgc.types.forEach((type) => {
+    const emoji = `${type.emoji} ` || '';
+    const configType = type.type;
+    const description = type.description || '';
+
+    choicesArray.push({
+      value: emoji + configType,
+      name: `${chalk.bold(configType)} ${description}`,
     });
   });
+
+  t.deepEqual(choicesList, await choicesArray);
 });
 
-test('check the values of the question object', (t) => {
-  const configuration = getConfig();
-  const choicesList = choices(configuration);
-  const questionsList = questions(choicesList);
+test('check the values of the question object', async (t) => {
+  const configuration = await getConfig();
+  const choicesList = await choices(configuration);
+  const questionsList = await questions(choicesList, configuration);
 
   t.deepEqual(typeof questionsList, 'object');
 });
 
-test('validate functions in questions', (t) => {
-  const configuration = getConfig();
-  const choicesList = choices(configuration);
-  const questionsList = questions(choicesList);
+test('validate functions in questions', async (t) => {
+  const configuration = await getConfig();
+  const choicesList = await choices(configuration);
+  const questionsList = await questions(choicesList, configuration);
 
   t.deepEqual(questionsList[1].validate('input text'), true);
-  t.deepEqual(questionsList[1].validate(), 'A commit message is mandatory!');
+  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');
 });
 
 test('when and default functions in questions', (t) => {

test/rules/availableRules.js

@@ -0,0 +1,23 @@
+import test from 'ava';
+import rules from '../../lib/rules/availableRules';
+
+test('rules endWithDot', (t) => {
+  const endWithDot = rules.endWithDot.check('input with dot.');
+  const endWithoutDot = rules.endWithDot.check('input with dot');
+  t.deepEqual(endWithDot, false);
+  t.deepEqual(endWithoutDot, true);
+});
+
+test('rules minChar', (t) => {
+  const notMinChar = rules.minChar.check('less');
+  const minChar = rules.minChar.check('this are more than 10 characters');
+  t.deepEqual(notMinChar, false);
+  t.deepEqual(minChar, true);
+});
+
+test('rules mxChar', (t) => {
+  const moreThanMaxChar = rules.maxChar.check('this are more than 72 characters, believe me or not but the value moreThanMaxChar will be false ;-P');
+  const lessThanMaxChar = rules.maxChar.check('this are less than 72 characters');
+  t.deepEqual(moreThanMaxChar, false);
+  t.deepEqual(lessThanMaxChar, true);
+});

test/rules/ruleWarningMessages.js

@@ -0,0 +1,7 @@
+import test from 'ava';
+import ruleWaringMessages from '../../lib/rules/ruleWarningMessages';
+
+test('ruleWarningMessages', (t) => {
+  const messages = ruleWaringMessages('input.');
+  t.deepEqual(messages, 'The commit message has to be at least 10 character.\nThe commit message can not end with a dot\n');
+});