Merge pull request #23 from JPeer264/feature/removeemojies

Feature/removeemojies

Author: JPeer264

README.md

@@ -41,9 +41,25 @@ $ 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:**
+- [emojies](#emojies)
 - [types](#types)
 - [rules](#rules)
 
+### emojies
+
+**Type:** `boolean`
+
+**Default:** `true`
+
+A boolean to enable emojies at the beginning of a commit message
+
+Example:
+```json
+{
+  "emojies": true
+}
+```
+
 ### types
 
 > Types will define your git commits.

lib/promptConfig.js

@@ -5,7 +5,8 @@ const choices = (configuration) => {
   const choicesList = [];
 
   configuration.types.forEach((type) => {
-    const emoji = `${type.emoji} ` || '';
+    const isEmojies = configuration.emojies === undefined ? true : configuration.emojies;
+    const emoji = isEmojies && type.emoji ? `${type.emoji} ` : '';
     const configType = type.type;
     const description = type.description || '';
 

package.json

@@ -9,7 +9,7 @@
   },
   "scripts": {
     "pretest": "npm run lint & npm run babel",
-    "test": "nyc ava",
+    "test": "nyc ava -s",
     "lint": "eslint lib test",
     "babel": "babel lib -d dest",
     "prepublish": "npm run babel",

test/fixtures/questions.js

@@ -0,0 +1,20 @@
+import chalk from 'chalk';
+
+const withEmoji = [
+  {
+    name: `${chalk.bold('Add:')} Files added`,
+    value: ':emo: Add:',
+  },
+];
+
+const withoutEmoji = [
+  {
+    name: `${chalk.bold('Add:')} Files added`,
+    value: 'Add:',
+  },
+];
+
+export {
+  withEmoji,
+  withoutEmoji,
+};

test/getConfig.js

@@ -38,7 +38,7 @@ test('read config from a .sgcrc_default', (t) => {
   t.deepEqual(getConfig(), json.readToObjSync(path.join(cwd, '.sgcrc_default')));
 });
 
-test('read config from package.json', (t) => {
+test.serial('read config from package.json', (t) => {
   const sgcrc = json.readToObjSync(path.join(fixtures, '.sgcrc'));
   const packageJson = json.readToObjSync(path.join(cwd, 'package.json'));
 

test/prompConfig.js renamed to test/promptConfig.js

@@ -1,22 +1,22 @@
 import os from 'os';
 import test from 'ava';
 import path from 'path';
-import chalk from 'chalk';
 import fs from 'fs-extra';
 import json from 'json-extra';
 
 import getConfig from '../lib/getConfig';
 import { choices, questions } from '../lib/promptConfig';
+import { withEmoji, withoutEmoji } from './fixtures/questions';
 
 const cwd = process.cwd();
-const homedir = os.homedir();
 const date = new Date();
+const homedir = os.homedir();
+const fixtures = path.join(cwd, 'test', 'fixtures');
 const datetime = date.toISOString().slice(0, 10);
 const randomString = Math.random().toString(36).replace(/[^a-z]+/g, '').substr(0, 4);
 
 let globalExist = false;
 
-
 // rename global .sgcrc
 test.before(() => {
   if (fs.existsSync(path.join(homedir, '.sgcrc'))) {
@@ -35,37 +35,35 @@ 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', async (t) => {
-  const sgc = await getConfig();
-  const choicesList = await choices(sgc);
-  const choicesArray = [];
+test('choices are rendered without emojis', (t) => {
+  const sgc = getConfig(path.join(fixtures, '.sgcrc'));
+
+  sgc.emojies = false;
+
+  const choicesList = choices(sgc);
 
-  sgc.types.forEach((type) => {
-    const emoji = `${type.emoji} ` || '';
-    const configType = type.type;
-    const description = type.description || '';
+  t.deepEqual(choicesList, withoutEmoji);
+});
 
-    choicesArray.push({
-      value: emoji + configType,
-      name: `${chalk.bold(configType)} ${description}`,
-    });
-  });
+test('choices are rendered with emojis (default)', (t) => {
+  const sgc = getConfig(path.join(fixtures, '.sgcrc'));
+  const choicesList = choices(sgc);
 
-  t.deepEqual(choicesList, await choicesArray);
+  t.deepEqual(choicesList, withEmoji);
 });
 
-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);
+test('check the values of the question object', (t) => {
+  const configuration = getConfig();
+  const choicesList = choices(configuration);
+  const questionsList = questions(choicesList, configuration);
 
   t.deepEqual(typeof questionsList, 'object');
 });
 
-test('validate functions in questions', async (t) => {
-  const configuration = await getConfig();
-  const choicesList = await choices(configuration);
-  const questionsList = await questions(choicesList, configuration);
+test('validate functions in questions', (t) => {
+  const configuration = getConfig();
+  const choicesList = choices(configuration);
+  const questionsList = questions(choicesList, configuration);
 
   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');