Feat: remove inherit, change readme defaults

Author: JPeer264

.gitignore

@@ -8,3 +8,6 @@ coverage
 
 # macOS
 .DS_STORE
+
+# IDE / Editors
+.vscode

.sgcrc

@@ -1,8 +1,6 @@
 {
-  "questions": {
-    "scope": false,
-    "body": true
-  },
+  "scope": false,
+  "body": true,
   "emoji": false,
   "types": [
     {

README.md

@@ -41,28 +41,39 @@ $ 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)
+- [body](#body)
+- [scope](#scope)
 - [emoji](#emoji)
 - [types](#types)
 - [rules](#rules)
-- [inherit](#inherit)
 
-### questions
+### body
 
-**Type:** `object`
+**Type:** `boolean`
 
-**Options:**
-- `scope` Asks for the scope in parentheses of the commit. Default: `false`
-- `body` Asks if more info (body) should be added. Default: `true`
+**Default**: `true`
 
-An object with predefined settings, what should be asked.
+Asks if more info (body) should be added. This will open your default editor.
 
 Example:
-```js
+```json
 {
-  "questions": {
-    "scope": true
-  }
+  "body": false
+}
+```
+
+### scope
+
+**Type:** `boolean`
+
+**Default:** `false`
+
+Asks for the scope in parentheses of the commit.
+
+Example:
+```json
+{
+  "scope": true
 }
 ```
 
@@ -83,7 +94,8 @@ Example:
 
 ### types
 
-> Types will define your git commits.
+> Types will define your git commits. If `types` is not set in your own `.sgcrc`, the `types` of the global [.sgcrc](.sgcrc)
+
 
 **Keys**
 
@@ -135,15 +147,15 @@ Available rules:
 
 **Type:** `number`
 
-**Default:** `undefined`
+**Default:** `72`
 
-If a number is set, it will not allow to commit messages **more than** the given number
+If a number is set, it will not allow to commit messages **more than** the given number. If it is set to `false` the rule is deactivated
 
 Example:
 ```json
 {
   "rules": {
-    "max-char": 10
+    "max-char": false
   }
 }
 ```
@@ -152,15 +164,15 @@ Example:
 
 **Type:** `number`
 
-**Default:** `undefined`
+**Default:** `10`
 
-If a number is set, it will not allow to commit messages **less than** the given number
+If a number is set, it will not allow to commit messages **less than** the given number. If it is set to `false` the rule is deactivated
 
 Example:
 ```json
 {
   "rules": {
-    "min-char": 10
+    "min-char": false
   }
 }
 ```
@@ -181,28 +193,3 @@ Example:
   }
 }
 ```
-
-### inherit
-
-**Type:** `boolean | array`
-
-**Default:** `false`
-
-This will inherit every object entry which is given in the array. If this is set to true everything is inherited. The own configuration won't get overwritten.
-
-Example:
-```js
-// following set "emoji" to true, and will inherit everything except "emoji" from the defaults.
-{
-  "emoji": true,
-  "inherit": true
-}
-
-// following has "emoji" to true and just types are "types" from the defaults.
-{
-  "emoji": true,
-  "inherit": [
-    "types"
-  ]
-}
-```

lib/getConfig.js

@@ -24,33 +24,20 @@ const getConfig = (altPath) => {
   // 3. default config
   //   - 1. from ../.sgcrc
   //   - 2. test case ../.sgcrc is renamed to ../.sgcrc_default
-  let config = configObject || packageConfig || globalConfig || sgcrcDefault;
-
-  config.inherit = config.inherit === undefined ? {} : config.inherit;
+  const config = configObject || packageConfig || globalConfig || sgcrcDefault;
 
   // set defaults which are necessary
-  let configDefaults = {};
-
-  configDefaults.questions = sgcrcDefault.questions;
+  const tempConfig = merge({}, sgcrcDefault, config);
 
-  // inherit everything
-  if (config.inherit === true) {
-    configDefaults = sgcrcDefault;
+  // do not merge types
+  // so return them to their set default
+  if (config.types) {
+    tempConfig.types = config.types;
   }
 
-  if (Object.prototype.toString.call(config.inherit) === '[object Array]') {
-    config.inherit.forEach((element) => {
-      if (!config[element] && sgcrcDefault[element] !== undefined) {
-        config[element] = sgcrcDefault[element];
-      }
-    });
-  }
-
-  config = merge({}, configDefaults, config);
-
   // next will remove "inherit" from the config
   // eslint-disable-next-line
-  const { inherit, ...copiedConfig } = config;
+  const { inherit, ...copiedConfig } = tempConfig;
 
   return copiedConfig;
 };

lib/questions.js

@@ -32,7 +32,7 @@ const questions = (config) => {
       type: 'input',
       name: 'scope',
       message: 'Enter your scope (no whitespaces allowed):',
-      when: () => config.questions.scope,
+      when: () => config.scope,
       validate: input => (input.match(/\s/) !== null ? 'No whitespaces allowed' : true),
       filter: input => (input ? `(${input})` : input),
     },
@@ -50,7 +50,7 @@ const questions = (config) => {
       type: 'confirm',
       name: 'body',
       message: 'Do you want to add a body?',
-      when: () => config.questions.body,
+      when: () => config.body,
       default: false,
     },
     {

test/fixtures/.sgcrc

@@ -1,8 +1,6 @@
 {
-  "questions": {
-    "scope": false,
-    "body": true
-  },
+  "scope": false,
+  "body": true,
   "emoji": false,
   "types": [
     {

test/fixtures/.sgcrc_inherit

@@ -44,11 +44,6 @@ test('read config from a specific path', (t) => {
 test('read config from a .sgcrc_default', (t) => {
   const globalConfig = json.readToObjSync(path.join(cwd, '.sgcrc_default'));
 
-  globalConfig.questions = {
-    scope: false,
-    body: true,
-  };
-
   t.deepEqual(getConfig(), globalConfig);
 });
 

test/fixtures/.sgcrc_inherit_all

@@ -2,8 +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 merge from 'lodash.merge';
 
 import getConfig from '../lib/getConfig';
 import questions, { choices } from '../lib/questions';
@@ -47,27 +45,6 @@ test('choices are rendered without emoji', (t) => {
   t.deepEqual(choicesList, withoutEmoji);
 });
 
-test('choices with inherit mode | all', (t) => {
-  const sgc = getConfig(path.join(fixtures, '.sgcrc_inherit_all'));
-  const sgcrc = json.readToObjSync(path.join(cwd, '.sgcrc_default'));
-
-  t.deepEqual(sgc, merge({}, sgcrc, sgc));
-});
-
-test('choices with inherit mode | some', (t) => {
-  const sgc = getConfig(path.join(fixtures, '.sgcrc_inherit'));
-  const sgcrc = json.readToObjSync(path.join(cwd, '.sgcrc_default'));
-
-  const ownConfig = {
-    emoji: true,
-  };
-
-  ownConfig.rules = sgcrc.rules;
-  ownConfig.questions = sgcrc.questions;
-
-  t.deepEqual(sgc, ownConfig);
-});
-
 test('choices are rendered with emoji (default)', (t) => {
   const sgc = getConfig(path.join(fixtures, '.sgcrc'));
 
@@ -129,5 +106,5 @@ test('CONFIRM EDITOR | check if it shows if it has to', (t) => {
   const config = getConfig();
   const questionsList = questions(config);
 
-  t.is(questionsList[3].when(), config.questions.body);
+  t.is(questionsList[3].when(), config.body);
 });