Merge 425317b into bfc8f86

docs/config/settings.md

@@ -54,20 +54,28 @@ module.exports = {
                 _description: 'Description for 2',
                 subgroup: 'Description for subgroup'
             },
-        }
+        },
         validations: {
             group1: {
                 // …
             },
             group2: {
                 // …
             }
+        },
+        converters: {
+            group1: {
+                // …
+            },
+            group2: {
+                // …
+            }
         }
     }
 }
 ```
 
-As can be seen in the example above the Roc settings meta object can have 3 properties; `descriptions`, `groups`, `validations`.
+As can be seen in the example above the Roc settings meta object can have 4 properties; `descriptions`, `groups`, `validations`, `converters`.
 
 ### `descriptions`
 Should mirror the groups and general structure of the normal settings object adding description to the properties. These descriptions will be shown when using the cli and when generation documentation for the settings.
@@ -85,3 +93,10 @@ Roc assumes that the validators used is either a RegExp or a function that will
 For convenience several types of validators exists in `roc` that can be imported from `roc/validators`. For a complete list of them please see [the JSDocs](/docs/JSDocs.md).
 
 See [roc.config.meta.js in roc-web for an example of how the configuration might look](https://github.com/vgno/roc-web/blob/master/src/roc/config/roc.config.meta.js#L62).
+
+### `converters`
+Roc will by default provide an automatic converter that will be based on the default value of the corresponding settings. In most cases will this be sufficient but in some instances a custom converter might be needed. This custom converter will in most cases get a string as input and be expected to return the correct type.
+
+Should mirror the groups and general structure of the normal settings object adding converters to the properties. These converters will be used by the cli to convert inputs given to the cli directly.
+
+For convenience several types of converters exists in `roc` that can be imported from `roc/converters`. For a complete list of them please see [the JSDocs](/docs/JSDocs.md).

src/cli/helpers.js

@@ -1,5 +1,5 @@
 import chalk from 'chalk';
-import { isPlainObject, isBoolean, isString, set, difference, isFunction, isRegExp } from 'lodash';
+import { isPlainObject, set, difference, isFunction } from 'lodash';
 import trimNewlines from 'trim-newlines';
 import redent from 'redent';
 
@@ -12,7 +12,6 @@ import { fileExists, getRocPackageDependencies, getRocPluginDependencies, getPac
 import onProperty from '../helpers/on-property';
 import { isValid, throwError } from '../validation';
 import { warning, infoLabel, errorLabel, warningLabel, feedbackMessage } from '../helpers/style';
-import { toArray, toRegExp } from '../converters';
 import { registerAction } from '../hooks/actions';
 import getSuggestions from '../helpers/get-suggestions';
 
@@ -433,7 +432,7 @@ export function getMappings(documentationObject = []) {
                 mappings[element.cli.substr(2)] = {
                     name: element.cli,
                     path: element.path,
-                    converter: getConverter(element.defaultValue, element.cli),
+                    converter: element.converter,
                     validator: element.validator
                 };
             });
@@ -447,37 +446,6 @@ export function getMappings(documentationObject = []) {
     return recursiveHelper(documentationObject);
 }
 
-// Convert values based on their default value
-function getConverter(value, name) {
-    if (isBoolean(value)) {
-        return (input) => {
-            if (isBoolean(input)) {
-                return input;
-            }
-            if (input === 'true' || input === 'false') {
-                return input === 'true';
-            }
-
-            console.log(feedbackMessage(
-                warningLabel('Warning', 'Conversion Failed'),
-                `Invalid value given for ${chalk.bold(name)}. Will use the default ${chalk.bold(value)}.`
-            ));
-
-            return value;
-        };
-    } else if (isRegExp(value)) {
-        return (input) => toRegExp(input);
-    } else if (Array.isArray(value)) {
-        return toArray;
-    } else if (Number.isInteger(value)) {
-        return (input) => parseInt(input, 10);
-    } else if (!isString(value) && (!value || Object.keys(value).length === 0)) {
-        return (input) => JSON.parse(input);
-    }
-
-    return (input) => input;
-}
-
 /**
  * Converts a set of options to {@link rocConfigSettings} object and command specific options.
  *

src/converters/automatic.js

@@ -0,0 +1,18 @@
+import { isBoolean, isString, isRegExp } from 'lodash';
+import { toArray, toRegExp, toBoolean, toInteger, toObject } from '../converters';
+
+export default function automaticConverter(value, name) {
+    if (isBoolean(value)) {
+        return (input) => toBoolean(input, value, name);
+    } else if (isRegExp(value)) {
+        return toRegExp;
+    } else if (Array.isArray(value)) {
+        return toArray;
+    } else if (Number.isInteger(value)) {
+        return toInteger;
+    } else if (!isString(value) && (!value || Object.keys(value).length === 0)) {
+        return toObject;
+    }
+
+    return (input) => input;
+}

src/converters/index.js

@@ -1,2 +1,6 @@
 export toArray from './to-array';
 export toRegExp from './to-regexp';
+export toBoolean from './to-boolean';
+export toInteger from './to-integer';
+export toObject from './to-object';
+export automatic from './automatic';

src/converters/to-boolean.js

@@ -0,0 +1,29 @@
+import chalk from 'chalk';
+import { isBoolean } from 'lodash';
+
+import { warningLabel, feedbackMessage } from '../helpers/style';
+
+/**
+ * Given an input the function will return a boolean.
+ *
+ * @param {object} input - The input to be converted.
+ * @param {boolean} defaultValue - Default value to use if conversion fails.
+ * @param {string} name - The name of of what is converted.
+ *
+ * @returns {bool} - The converted result.
+ */
+export default function toBoolean(input, defaultValue, name) {
+    if (isBoolean(input)) {
+        return input;
+    }
+    if (input === 'true' || input === 'false') {
+        return input === 'true';
+    }
+
+    console.log(feedbackMessage(
+        warningLabel('Warning', 'Conversion Failed'),
+        `Invalid value given for ${chalk.bold(name)}. Will use the default ${chalk.bold(defaultValue)}.`
+    ));
+
+    return defaultValue;
+}

src/converters/to-integer.js

@@ -0,0 +1,16 @@
+import { isInteger } from 'lodash';
+
+/**
+ * Given an input the function will return an number.
+ *
+ * @param {object} input - The input to be converted.
+ *
+ * @returns {number} - The converted result.
+ */
+export default function toInteger(input) {
+    if (isInteger(input)) {
+        return input;
+    }
+
+    return parseInt(input, 10);
+}

src/converters/to-object.js

@@ -0,0 +1,16 @@
+import { isPlainObject } from 'lodash';
+
+/**
+ * Given an input the function will return an object.
+ *
+ * @param {object} input - The input to be converted.
+ *
+ * @returns {object} - The converted result.
+ */
+export default function toObject(input) {
+    if (isPlainObject(input)) {
+        return input;
+    }
+
+    return JSON.parse(input);
+}

src/documentation/build-documentation-object.js

@@ -2,6 +2,7 @@ import { isPlainObject, isFunction } from 'lodash';
 
 import { toCliOption } from './helpers';
 import onProperty from '../helpers/on-property';
+import automaticConverter from '../converters/automatic';
 
 const defaultValidation = (input, info) => info ? {type: 'Unknown'} : true;
 
@@ -20,38 +21,41 @@ export default function buildDocumentationObject(initalObject, meta = {}, inital
         return Object.keys(object).map(callback).filter((value) => value !== undefined);
     };
 
-    const manageGroup = (object, name, group = {}, description = {}, validation = {}, parents, level, parentNames) => {
+    const manageGroup = (object, name, group = {}, description = {}, validation = {}, converters = {},
+        parents, level, parentNames) => {
         const groupDescription = isPlainObject(group) ? group._description || undefined : group;
         return {
             name,
             parentNames,
             level,
             description: groupDescription,
-            objects: recursiveHelper(object, group, description, validation, [], level + 1, parents,
+            objects: recursiveHelper(object, group, description, validation, converters, [], level + 1, parents,
                 parentNames.concat(name), true),
-            children: recursiveHelper(object, group, description, validation, [], level + 1, parents,
+            children: recursiveHelper(object, group, description, validation, converters, [], level + 1, parents,
                 parentNames.concat(name))
         };
     };
 
-    const manageLeaf = (object, name, description, validation = defaultValidation, parents) => {
+    const manageLeaf = (object, name, description, validation = defaultValidation, converter, parents) => {
         const { type = 'Unknown', required = false } = isFunction(validation) ?
             validation(null, true) :
             ({type: validation.toString(), req: false });
 
+        const cli = toCliOption(parents);
         return {
             name,
             description,
             type,
             required,
+            cli,
             path: parents.join('.'),
-            cli: toCliOption(parents),
             defaultValue: object,
-            validator: validation
+            validator: validation,
+            converter: converter || automaticConverter(object, cli)
         };
     };
 
-    function recursiveHelper(object, groups = {}, descriptions = {}, validations = {}, filter = [],
+    function recursiveHelper(object, groups = {}, descriptions = {}, validations = {}, converters = {}, filter = [],
         level = 0, initalParents = [], parentNames = [], leaves = false) {
         return allObjects(object, (key) => {
             // Make sure that we either have no filter or that there is a match
@@ -60,16 +64,24 @@ export default function buildDocumentationObject(initalObject, meta = {}, inital
                 const value = object[key];
                 if (isPlainObject(value) && Object.keys(value).length > 0 && !leaves) {
                     const group = isPlainObject(groups) ? groups[key] : {};
-                    return manageGroup(value, key, group, descriptions[key], validations[key], parents, level,
-                        parentNames);
+                    return manageGroup(value, key, group, descriptions[key], validations[key], converters[key],
+                        parents, level, parentNames);
                 } else if ((!isPlainObject(value) || Object.keys(value).length === 0) && leaves) {
-                    return manageLeaf(value, key, descriptions[key], validations[key], parents);
+                    return manageLeaf(value, key, descriptions[key], validations[key], converters[key], parents);
                 }
             }
         });
     }
 
-    return recursiveHelper(initalObject, meta.groups, meta.descriptions, meta.validations, initalFilter, initalLevel);
+    return recursiveHelper(
+        initalObject,
+        meta.groups,
+        meta.descriptions,
+        meta.validations,
+        meta.converters,
+        initalFilter,
+        initalLevel
+    );
 }
 
 /**

src/documentation/helpers.js

@@ -35,10 +35,11 @@ export function addPadding(string, length) {
  */
 export function toCliOption(configPaths) {
     // Runtime should be added directly
-    if (configPaths[0] === 'runtime') {
-        configPaths.shift();
-    }
-    return '--' + configPaths.join('-');
+    const paths = configPaths[0] === 'runtime' ?
+        configPaths.slice(1) :
+        configPaths;
+
+    return '--' + paths.join('-');
 }
 
 /**

test/cli/helpers.js

@@ -260,7 +260,6 @@ General options:
                 ));
             });
         });
-
         describe('getMappings', () => {
             it('should create correct number of mappings', () => {
                 const mappings = getMappings(complexDocumentObject);
@@ -272,43 +271,6 @@ General options:
                 expect(mappings['build-path'].name).toBe('--build-path');
                 expect(mappings['build-path'].path).toBe('build.path');
             });
-
-            describe('should create correct coverters', () => {
-                it('boolean', () => {
-                    const mappings = getMappings(complexDocumentObject);
-                    return consoleMockWrapper((log) => {
-                        expect(mappings['build-useDefaultReduxMiddlewares'].converter(true)).toBe(true);
-                        expect(mappings['build-useDefaultReduxMiddlewares'].converter(false)).toBe(false);
-
-                        expect(mappings['build-useDefaultReduxMiddlewares'].converter('true')).toBe(true);
-                        expect(mappings['build-useDefaultReduxMiddlewares'].converter('false')).toBe(false);
-
-                        expect(mappings['build-useDefaultReduxMiddlewares'].converter('asd')).toBe(true);
-                        expect(log.calls[0].arguments[0]).toInclude('Invalid value given');
-                    });
-                });
-
-                it('array', () => {
-                    const mappings = getMappings(complexDocumentObject);
-                    expect(mappings['build-assets'].converter('[1, 2, 3]')).toEqual([1, 2, 3]);
-                    expect(mappings['build-assets'].converter('1,2,3')).toEqual(['1', '2', '3']);
-                });
-
-                it('number', () => {
-                    const mappings = getMappings(complexDocumentObject);
-                    expect(mappings['build-port'].converter('1234')).toEqual(1234);
-                });
-
-                it('object', () => {
-                    const mappings = getMappings(complexDocumentObject);
-                    expect(mappings['build-obj'].converter('{"value": 12}')).toEqual({ value: 12 });
-                });
-
-                it('string', () => {
-                    const mappings = getMappings(complexDocumentObject);
-                    expect(mappings['build-outputName'].converter('some string')).toEqual('some string');
-                });
-            });
         });
     });
 });