add options resolvers, fixes michalkvasnicak#10

Author: michalkvasnicak

src/options_resolvers/append.js

@@ -0,0 +1,29 @@
+import { isFunction, isModulePath, requireLocalFileOrNodeModule } from '../utils';
+
+/**
+ * Resolves append option for css-modules-require-hook
+ *
+ * @param {*} value
+ * @returns {Function}
+ */
+export default function append(value/* , currentConfig */) {
+    if (Array.isArray(value)) {
+        return value.map((option, index) => {
+            if (isFunction(option)) {
+                return option();
+            } else if (isModulePath(option)) {
+                const requiredOption = requireLocalFileOrNodeModule(option);
+
+                if (!isFunction(requiredOption)) {
+                    throw new Error(`Configuration 'append[${index}]' module is not exporting a function`);
+                }
+
+                return requiredOption();
+            }
+
+            throw new Error(`Configuration 'append[${index}]' is not a function or a valid module path`);
+        });
+    }
+
+    throw new Error(`Configuration 'append' is not an array`);
+}

src/options_resolvers/camelCase.js

@@ -0,0 +1,15 @@
+import { isBoolean } from '../utils';
+
+/**
+ * Resolves camelCase option for css-modules-require-hook
+ *
+ * @param {*} value
+ * @returns {boolean}
+ */
+export default function camelCase(value/* , currentConfig */) {
+    if (!isBoolean(value)) {
+        throw new Error(`Configuration 'camelCase' is not a boolean`);
+    }
+
+    return value;
+}

src/options_resolvers/createImportedName.js

@@ -0,0 +1,23 @@
+import { isFunction, isModulePath, requireLocalFileOrNodeModule } from '../utils';
+
+/**
+ * Resolves createImportedName css-modules-require-hook option
+ *
+ * @param {String|Function} value
+ * @returns {Function}
+ */
+export default function createImportedName(value/* , currentConfig */) {
+    if (isFunction(value)) {
+        return value;
+    } else if (isModulePath(value)) {
+        const requiredOption = requireLocalFileOrNodeModule(value);
+
+        if (!isFunction(requiredOption)) {
+            throw new Error(`Configuration file for 'createImportedName' is not exporting a function`);
+        }
+
+        return requiredOption;
+    }
+
+    throw new Error(`Configuration 'createImportedName' is not a function nor a valid module path`);
+}

src/options_resolvers/devMode.js

@@ -0,0 +1,15 @@
+import { isBoolean } from '../utils';
+
+/**
+ * Resolves devMode option for css-modules-require-hook
+ *
+ * @param {*} value
+ * @returns {boolean}
+ */
+export default function devMode(value/* , currentConfig */) {
+    if (!isBoolean(value)) {
+        throw new Error(`Configuration 'devMode' is not a boolean`);
+    }
+
+    return value;
+}

src/options_resolvers/extensions.js

@@ -0,0 +1,21 @@
+import { isString } from '../utils';
+
+/**
+ * Resolves extensions for css-modules-require-hook
+ *
+ * @param {*} value
+ * @returns {Array.<String>}
+ */
+export default function extensions(value/* , currentConfig */) {
+    if (Array.isArray(value)) {
+        return value.map((extension, index) => {
+            if (!isString(extension)) {
+                throw new Error(`Configuration 'extensions[${index}]' is not a string`);
+            }
+
+            return extension;
+        });
+    }
+
+    throw new Error(`Configuration 'extensions' is not an array`);
+}

src/options_resolvers/generateScopedName.js

@@ -0,0 +1,24 @@
+import { isModulePath, isFunction, isString, requireLocalFileOrNodeModule } from '../utils';
+
+/**
+ * Resolves generateScopedName option for css-modules-require-hook
+ *
+ * @param {String|Function} value
+ *
+ * @returns {String|Function}
+ */
+export default function generateScopedName(value/* ,currentConfig */) {
+    if (isModulePath(value)) {
+        const requiredModule = requireLocalFileOrNodeModule(value);
+
+        if (isString(requiredModule) || isFunction(requiredModule)) {
+            return requiredModule;
+        }
+
+        throw new Error(`Configuration file for 'generateScopedName' is not exporting a string nor a function`);
+    } else if (isString(value) || isFunction(value)) {
+        return value;
+    } else {
+        throw new Error(`Configuration 'generateScopedName' is not a function, string nor valid path to module`);
+    }
+}

src/options_resolvers/ignore.js

@@ -0,0 +1,25 @@
+import { isFunction, isModulePath, isRegExp, isString, requireLocalFileOrNodeModule } from '../utils';
+
+/**
+ * Resolves ignore option for css-modules-require-hook
+ *
+ * @param {*} value
+ * @returns {Function|String|RegExp}
+ */
+export default function ignore(value/* , currentConfig */) {
+    if (isFunction(value) || isRegExp(value)) {
+        return value;
+    } else if (isModulePath(value)) {
+        const requiredOption = requireLocalFileOrNodeModule(value);
+
+        if (isFunction(requiredOption) || isString(requiredOption) || isRegExp(requiredOption)) {
+            return requiredOption;
+        }
+
+        throw new Error(`Configuration file for 'generateScopedName' is not exporting a string nor a function`);
+    } else if (isString(value)) {
+        return value;
+    } else {
+        throw new Error(`Configuration 'ignore' is not a function, string, RegExp nor valid path to module`);
+    }
+}

src/options_resolvers/index.js

@@ -0,0 +1,13 @@
+export { default as append } from './append';
+export { default as camelCase } from './camelCase';
+export { default as createImportedName } from './createImportedName';
+export { default as devMode } from './devMode';
+export { default as generateScopedName } from './generateScopedName';
+export { default as ignore } from './ignore';
+export { default as mode } from './mode';
+export { default as prepend } from './prepend';
+export { default as preprocessCss } from './preprocessCss';
+export { default as processCss } from './processCss';
+export { default as processOpts } from './processOpts';
+export { default as rootDir } from './rootDir';
+export { default as use } from './use';

src/options_resolvers/mode.js

@@ -0,0 +1,15 @@
+import { isString } from '../utils';
+
+/**
+ * Resolves mode option for css-modules-require-hook
+ *
+ * @param {*} value
+ * @returns {boolean}
+ */
+export default function mode(value/* , currentConfig */) {
+    if (!isString(value)) {
+        throw new Error(`Configuration 'mode' is not a string`);
+    }
+
+    return value;
+}

src/options_resolvers/prepend.js

@@ -0,0 +1,29 @@
+import { isFunction, isModulePath, requireLocalFileOrNodeModule } from '../utils';
+
+/**
+ * Resolves prepend option for css-modules-require-hook
+ *
+ * @param {*} value
+ * @returns {Function}
+ */
+export default function prepend(value/* , currentConfig */) {
+    if (Array.isArray(value)) {
+        return value.map((option, index) => {
+            if (isFunction(option)) {
+                return option();
+            } else if (isModulePath(option)) {
+                const requiredOption = requireLocalFileOrNodeModule(option);
+
+                if (!isFunction(requiredOption)) {
+                    throw new Error(`Configuration 'prepend[${index}]' module is not exporting a function`);
+                }
+
+                return requiredOption();
+            }
+
+            throw new Error(`Configuration 'prepend[${index}]' is not a function or a valid module path`);
+        });
+    }
+
+    throw new Error(`Configuration 'prepend' is not an array`);
+}

src/options_resolvers/preprocessCss.js

@@ -0,0 +1,24 @@
+import { isModulePath, isFunction, requireLocalFileOrNodeModule } from '../utils';
+
+/**
+ * Resolves preprocessCss option for css-modules-require-hook
+ *
+ * @param {String|Function} value
+ *
+ * @returns {String|Function}
+ */
+export default function preprocessCss(value/* ,currentConfig */) {
+    if (isModulePath(value)) {
+        const requiredModule = requireLocalFileOrNodeModule(value);
+
+        if (isFunction(requiredModule)) {
+            return requiredModule;
+        }
+
+        throw new Error(`Configuration file for 'preprocessCss' is not exporting a function`);
+    } else if (isFunction(value)) {
+        return value;
+    } else {
+        throw new Error(`Configuration 'preprocessCss' is not a function nor a valid path to module`);
+    }
+}

src/options_resolvers/processCss.js

@@ -0,0 +1,24 @@
+import { isModulePath, isFunction, requireLocalFileOrNodeModule } from '../utils';
+
+/**
+ * Resolves processCss option for css-modules-require-hook
+ *
+ * @param {String|Function} value
+ *
+ * @returns {String|Function}
+ */
+export default function processCss(value/* ,currentConfig */) {
+    if (isModulePath(value)) {
+        const requiredModule = requireLocalFileOrNodeModule(value);
+
+        if (isFunction(requiredModule)) {
+            return requiredModule;
+        }
+
+        throw new Error(`Configuration file for 'processCss' is not exporting a function`);
+    } else if (isFunction(value)) {
+        return value;
+    } else {
+        throw new Error(`Configuration 'processCss' is not a function nor a valid path to module`);
+    }
+}

src/options_resolvers/processOpts.js

@@ -0,0 +1,24 @@
+import { isModulePath, isPlainObject, requireLocalFileOrNodeModule } from '../utils';
+
+/**
+ * Resolves processOpts option for css-modules-require-hook
+ *
+ * @param {String|Function} value
+ *
+ * @returns {String|Function}
+ */
+export default function processOpts(value/* ,currentConfig */) {
+    if (isModulePath(value)) {
+        const requiredModule = requireLocalFileOrNodeModule(value);
+
+        if (isPlainObject(requiredModule)) {
+            return requiredModule;
+        }
+
+        throw new Error(`Configuration file for 'processOpts' is not exporting a plain object`);
+    } else if (isPlainObject(value)) {
+        return value;
+    } else {
+        throw new Error(`Configuration 'processOpts' is not a plain object nor a valid path to module`);
+    }
+}

src/options_resolvers/rootDir.js

@@ -0,0 +1,21 @@
+import { isAbsolute } from 'path';
+import { statSync } from 'fs';
+import { isString } from '../utils';
+
+/**
+ * Resolves mode option for css-modules-require-hook
+ *
+ * @param {*} value
+ * @returns {boolean}
+ */
+export default function rootDir(value/* , currentConfig */) {
+    if (!isString(value)) {
+        throw new Error(`Configuration 'rootDir' is not a string`);
+    }
+
+    if (!isAbsolute(value) || !statSync(value).isDirectory()) {
+        throw new Error(`Configuration 'rootDir' is not containg a valid absolute path`);
+    }
+
+    return value;
+}

src/options_resolvers/use.js

@@ -0,0 +1,29 @@
+import { isFunction, isModulePath, requireLocalFileOrNodeModule } from '../utils';
+
+/**
+ * Resolves use option for css-modules-require-hook
+ *
+ * @param {*} value
+ * @returns {Function}
+ */
+export default function use(value/* , currentConfig */) {
+    if (Array.isArray(value)) {
+        return value.map((option, index) => {
+            if (isFunction(option)) {
+                return option();
+            } else if (isModulePath(option)) {
+                const requiredOption = requireLocalFileOrNodeModule(option);
+
+                if (!isFunction(requiredOption)) {
+                    throw new Error(`Configuration 'use[${index}]' module is not exporting a function`);
+                }
+
+                return requiredOption();
+            }
+
+            throw new Error(`Configuration 'use[${index}]' is not a function or a valid module path`);
+        });
+    }
+
+    throw new Error(`Configuration 'use' is not an array`);
+}

test/fixtures/require.ignored.expected.js

@@ -0,0 +1,3 @@
+'use strict';
+
+var styles = {};

test/options_resolvers/append.spec.js

@@ -0,0 +1,17 @@
+import { expect } from 'chai';
+
+import append from '../../src/options_resolvers/append';
+
+describe('options_resolvers/append', () => {
+    it('should throw if append is not an array', () => {
+        expect(
+            () => append({})
+        ).to.throw();
+    });
+
+    it('should throw if append does not contain functions', () => {
+        expect(
+            () => append(['test/fixtures/append.module.js'])
+        ).to.throw();
+    });
+});

test/options_resolvers/camelCase.spec.js

@@ -0,0 +1,13 @@
+import { expect } from 'chai';
+
+import camelCase from '../../src/options_resolvers/camelCase';
+
+describe('options_resolvers/camelCase', () => {
+    it('should throw if camelCase value is not a boolean', () => {
+        expect(
+            () => camelCase(null)
+        ).to.throw();
+
+        expect(camelCase(true)).to.be.equal(true);
+    });
+});

test/options_resolvers/devMode.spec.js

@@ -0,0 +1,13 @@
+import { expect } from 'chai';
+
+import devMode from '../../src/options_resolvers/devMode';
+
+describe('options_resolvers/devMode', () => {
+    it('should throw if devMode value is not a boolean', () => {
+        expect(
+            () => devMode(null)
+        ).to.throw();
+
+        expect(devMode(true)).to.be.equal(true);
+    });
+});