Feat: add inherit mode (fixes #26)

Author: JPeer264

.babelrc

@@ -1,3 +1,6 @@
 {
-  "presets": ["env"]
+  "presets": ["env"],
+  "plugins": [
+    ["transform-object-rest-spread", { "useBuiltIns": true }]
+  ]
 }

README.md

@@ -45,6 +45,7 @@ You can even create a global config. Just go to your users home and create a `.s
 - [emoji](#emoji)
 - [types](#types)
 - [rules](#rules)
+- [inherit](#inherit)
 
 ### questions
 
@@ -180,3 +181,28 @@ 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

@@ -14,30 +14,48 @@ const getConfig = (altPath) => {
   const sgcrcDefaultConfig = json.readToObjSync(path.join(__dirname, '..', '.sgcrc'));
   const sgcrcTestDefaultConfig = json.readToObjSync(path.join(__dirname, '..', '.sgcrc_default'));
 
+  const sgcrcDefault = sgcrcDefaultConfig || sgcrcTestDefaultConfig;
+
   // priority order (1. highest priority):
   // 1. local config
   //   - 1. .sgcrc
   //   - 2. (package.json).sgc
   // 2. global config
-  // 3. default config from ../.sgcrc
-  // 4. In the test case ../.sgcrc is renamed to ../.sgcrc_default
-  let config = configObject
-              || packageConfig
-              || globalConfig
-              || sgcrcDefaultConfig
-              || sgcrcTestDefaultConfig;
+  // 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;
 
   // set defaults
-  const configDefaults = {
+  let configDefaults = {
     questions: {
       scope: false,
       moreInfo: true,
     },
   };
 
+  // inherit everything
+  if (config.inherit === true) {
+    configDefaults = sgcrcDefault;
+  }
+
+  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);
 
-  return config;
+  // next will remove "inherit" from the config
+  // eslint-disable-next-line
+  const { inherit, ...copiedConfig } = config;
+
+  return copiedConfig;
 };
 
 export default getConfig;

package.json

@@ -51,6 +51,7 @@
   "devDependencies": {
     "ava": "^0.18.2",
     "babel-cli": "^6.24.0",
+    "babel-plugin-transform-object-rest-spread": "^6.23.0",
     "babel-polyfill": "^6.23.0",
     "babel-preset-env": "^1.2.1",
     "coveralls": "^2.12.0",

test/fixtures/.sgcrc_inherit

@@ -0,0 +1,7 @@
+{
+  "emoji": true,
+  "inherit": [
+    "emoji",
+    "rules"
+  ]
+}

test/fixtures/.sgcrc_inherit_all

@@ -0,0 +1,4 @@
+{
+  "emoji": true,
+  "inherit": true
+}

test/questions.js

@@ -2,6 +2,8 @@ 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';
@@ -18,16 +20,24 @@ let globalExist = false;
 
 // rename global .sgcrc
 test.before(() => {
+  // rename global config
   if (fs.existsSync(path.join(homedir, '.sgcrc'))) {
     globalExist = true;
     fs.renameSync(path.join(homedir, '.sgcrc'), path.join(homedir, `.sgcrc.${randomString}-${datetime}.back`));
   }
+
+  // rename local sgcrc
+  fs.renameSync(path.join(cwd, '.sgcrc'), path.join(cwd, '.sgcrc_default'));
 });
 
 test.after.always(() => {
+  // rename global config
   if (globalExist) {
     fs.renameSync(path.join(homedir, `.sgcrc.${randomString}-${datetime}.back`), path.join(homedir, '.sgcrc'));
   }
+
+  // rename local sgcrc
+  fs.renameSync(path.join(cwd, '.sgcrc_default'), path.join(cwd, '.sgcrc'));
 });
 
 test('choices are rendered without emojis', (t) => {
@@ -37,6 +47,27 @@ test('choices are rendered without emojis', (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 emojis (default)', (t) => {
   const sgc = getConfig(path.join(fixtures, '.sgcrc'));
 

yarn.lock

@@ -501,6 +501,10 @@ babel-plugin-syntax-exponentiation-operator@^6.8.0:
   version "6.13.0"
   resolved "https://registry.yarnpkg.com/babel-plugin-syntax-exponentiation-operator/-/babel-plugin-syntax-exponentiation-operator-6.13.0.tgz#9ee7e8337290da95288201a6a57f4170317830de"
 
+babel-plugin-syntax-object-rest-spread@^6.8.0:
+  version "6.13.0"
+  resolved "https://registry.yarnpkg.com/babel-plugin-syntax-object-rest-spread/-/babel-plugin-syntax-object-rest-spread-6.13.0.tgz#fd6536f2bce13836ffa3a5458c4903a597bb3bf5"
+
 babel-plugin-syntax-trailing-function-commas@^6.13.0, babel-plugin-syntax-trailing-function-commas@^6.20.0:
   version "6.22.0"
   resolved "https://registry.yarnpkg.com/babel-plugin-syntax-trailing-function-commas/-/babel-plugin-syntax-trailing-function-commas-6.22.0.tgz#ba0360937f8d06e40180a43fe0d5616fff532cf3"
@@ -689,6 +693,13 @@ babel-plugin-transform-exponentiation-operator@^6.8.0:
     babel-plugin-syntax-exponentiation-operator "^6.8.0"
     babel-runtime "^6.22.0"
 
+babel-plugin-transform-object-rest-spread@^6.23.0:
+  version "6.23.0"
+  resolved "https://registry.yarnpkg.com/babel-plugin-transform-object-rest-spread/-/babel-plugin-transform-object-rest-spread-6.23.0.tgz#875d6bc9be761c58a2ae3feee5dc4895d8c7f921"
+  dependencies:
+    babel-plugin-syntax-object-rest-spread "^6.8.0"
+    babel-runtime "^6.22.0"
+
 babel-plugin-transform-regenerator@^6.6.0:
   version "6.22.0"
   resolved "https://registry.yarnpkg.com/babel-plugin-transform-regenerator/-/babel-plugin-transform-regenerator-6.22.0.tgz#65740593a319c44522157538d690b84094617ea6"