Merge pull request michalkvasnicak#20 from michalkvasnicak/feature/1.0

Feature/1.0

Author: michalkvasnicak

README.md

@@ -53,23 +53,32 @@ npm install --save-dev babel-plugin-css-modules-transform
 **With custom options [css-modules-require-hook options](https://github.com/css-modules/css-modules-require-hook#tuning-options)**
 
 
-```json
+```js
 {
     "plugins": [
         [
             "css-modules-transform", {
+                "append": [
+                    "npm-module-name",
+                    "./path/to/module-exporting-a-function.js"
+                ],
+                "camelCase": false,
+                "createImportedName": "npm-module-name",
+                "createImportedName": "./path/to/module-exporting-a-function.js",
+                "devMode": false,
+                "extensions": [".css", ".scss", ".less"], // list extensions to process; defaults to .css
                 "generateScopedName": "[name]__[local]___[hash:base64:5]", // in case you don't want to use a function
                 "generateScopedName": "./path/to/module-exporting-a-function.js", // in case you want to use a function
                 "generateScopedName": "npm-module-name",
+                "ignore": "*css",
+                "ignore": "./path/to/module-exporting-a-function-or-regexp.js",
                 "preprocessCss": "./path/to/module-exporting-a-function.js",
                 "preprocessCss": "npm-module-name",
                 "processCss": "./path/to/module-exporting-a-function.js",
                 "processCss": "npm-module-name",
-                "extensions": [".css", ".scss", ".less"], // list extensions to process; defaults to .css
-                "append": [
-                    "npm-module-name",
-                    "./path/to/module-exporting-a-function.js"
-                ],
+                "processOpts": "npm-module-name",
+                "processOpts": "./path/to/module/exporting-a-plain-object.js",
+                "mode": "string",
                 "prepend": [
                     "npm-module-name",
                     "./path/to/module-exporting-a-function.js"

src/index.js

@@ -1,13 +1,9 @@
 import { resolve, dirname, basename, extname, isAbsolute, join, relative } from 'path';
-
-import mkdirp from 'mkdirp';
-// *
 import { writeFileSync, appendFileSync } from 'fs';
-/* /
-const writeFileSync = (file, content) => {
-    console.log(`Will save ${file}\n${content.replace(/^/gm, '  ')}`);
-};
-// */
+import mkdirp from 'mkdirp';
+
+// options resolvers
+import * as requireHooksOptions from './options_resolvers';
 
 const writeCssFile = (filename, content) => {
     mkdirp.sync(dirname(filename));
@@ -18,18 +14,6 @@ const appendCssFile = (filename, content) => {
     appendFileSync(filename, content);
 };
 
-const simpleRequires = [
-    'createImportedName',
-    'generateScopedName',
-    'processCss',
-    'preprocessCss'
-];
-
-const complexRequires = [
-    'append',
-    'prepend'
-];
-
 const defaultOptions = {
     generateScopedName: '[name]__[local]___[hash:base64:5]'
 };
@@ -56,16 +40,23 @@ export default function transformCssModules({ types: t }) {
             const from = resolveModulePath(filepath);
             filePathOrModuleName = resolve(from, filePathOrModuleName);
         }
-        return require(filePathOrModuleName);
+
+        // css-modules-require-hooks throws if file is ignored
+        try {
+            return require(filePathOrModuleName);
+        } catch (e) {
+            return {}; // return empty object, this simulates result of ignored stylesheet file
+        }
     }
 
     // is css modules require hook initialized?
     let initialized = false;
 
     let matchExtensions = /\.css$/i;
+
     function matcher(extensions = ['.css']) {
-        const extensionsPatern = extensions.join('|').replace(/\./g, '\\\.');
-        return new RegExp(`(${extensionsPatern})$`, 'i');
+        const extensionsPattern = extensions.join('|').replace(/\./g, '\\\.');
+        return new RegExp(`(${extensionsPattern})$`, 'i');
     }
 
     return {
@@ -129,9 +120,11 @@ export default function transformCssModules({ types: t }) {
 
                 const pushStylesCreator = (toWrap) => (css, filepath) => {
                     let processed;
+
                     if (typeof toWrap === 'function') {
                         processed = toWrap(css, filepath);
                     }
+
                     if (typeof processed !== 'string') processed = css;
 
                     if (!state.$$css.styles.has(filepath)) {
@@ -142,83 +135,19 @@ export default function transformCssModules({ types: t }) {
                     return processed;
                 };
 
-                // check if there are simple requires and if they are functions
-                simpleRequires.forEach(key => {
-                    if (typeof currentConfig[key] !== 'string') {
-                        return;
-                    }
-
-                    const modulePath = resolve(process.cwd(), currentConfig[key]);
-
-                    // this one can be require or string
-                    if (key === 'generateScopedName') {
-                        try {
-                            // if it is existing file, require it, otherwise use value
-                            currentConfig[key] = require(modulePath);
-                        } catch (e) {
-                            try {
-                                currentConfig[key] = require(currentConfig[key]);
-                            } catch (_e) {
-                                // do nothing, because it is not a valid path
-                            }
-                        }
-
-                        if (typeof currentConfig[key] !== 'function' && typeof currentConfig[key] !== 'string') {
-                            throw new Error(`Configuration '${key}' is not a string or function.`);
-                        }
-
+                // resolve options
+                Object.keys(requireHooksOptions).forEach(key => {
+                    // skip undefined options
+                    if (currentConfig[key] === undefined) {
                         return;
                     }
 
-                    if (currentConfig.hasOwnProperty(key)) {
-                        try {
-                            currentConfig[key] = require(modulePath);
-                        } catch (e) {
-                            try {
-                                currentConfig[key] = require(currentConfig[key]);
-                            } catch (_e) {
-                                // do nothing because it is not a valid path
-                            }
-                        }
-
-                        if (typeof currentConfig[key] !== 'function') {
-                            throw new Error(`Module '${modulePath}' does not exist or is not a function.`);
-                        }
-                    }
+                    currentConfig[key] = requireHooksOptions[key](currentConfig[key], currentConfig);
                 });
 
                 // wrap or define processCss function that collect generated css
                 currentConfig.processCss = pushStylesCreator(currentConfig.processCss);
 
-                complexRequires.forEach(key => {
-                    if (!currentConfig.hasOwnProperty(key)) {
-                        return;
-                    }
-
-                    if (!Array.isArray(currentConfig[key])) {
-                        throw new Error(`Configuration '${key}' has to be an array.`);
-                    }
-
-                    currentConfig[key].forEach((plugin, index) => {
-                        // first try to load it using npm
-                        try {
-                            currentConfig[key][index] = require(plugin);
-                        } catch (e) {
-                            try {
-                                currentConfig[key][index] = require(resolve(process.cwd(), plugin));
-                            } catch (_e) {
-                                // do nothing
-                            }
-                        }
-
-                        if (typeof currentConfig[key][index] !== 'function') {
-                            throw new Error(`Configuration '${key}' has to be valid path to a module at index ${index} or it does not export a function.`);
-                        }
-
-                        currentConfig[key][index] = currentConfig[key][index]();
-                    });
-                });
-
                 require('css-modules-require-hook')(currentConfig);
 
                 initialized = true;

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';