ignore option implementation

Author: mightyaleksey

lib/index.js

@@ -2,7 +2,9 @@ const assign = require('lodash').assign;
 const attachHook = require('./attachHook');
 const dirname = require('path').dirname;
 const genericNames = require('generic-names');
+const globToRegex = require('glob-to-regexp');
 const identity = require('lodash').identity;
+const negate = require('lodash').negate;
 const readFileSync = require('fs').readFileSync;
 const relative = require('path').relative;
 const resolve = require('path').resolve;
@@ -15,8 +17,25 @@ const ExtractImports = require('postcss-modules-extract-imports');
 const Scope = require('postcss-modules-scope');
 const Parser = require('postcss-modules-parser');
 
+/**
+ * @param  {function|regex|string} ignore glob, regex or function
+ * @return {function}
+ */
+function buildExceptionChecker(ignore) {
+  if (ignore instanceof RegExp) {
+    return filepath => ignore.test(filepath);
+  }
+
+  if (typeof ignore === 'string') {
+    return filepath => globToRegex(ignore).test(filepath);
+  }
+
+  return ignore || negate(identity);
+}
+
 module.exports = function setupHook({
   extensions = '.css',
+  ignore,
   preprocessCss = identity,
   processCss,
   to,
@@ -96,5 +115,7 @@ module.exports = function setupHook({
     return tokens;
   };
 
-  attachHook(filename => fetch(filename, filename), '.css', () => false);
+  const isException = buildExceptionChecker(ignore);
+
+  attachHook(filename => fetch(filename, filename), '.css', isException);
 };

lib/validate.js

@@ -5,7 +5,7 @@ const keys = require('lodash').keys;
 const rules = {
   // hook
   extensions:         'array|string',
-  ignore:             'function|regex',
+  ignore:             'function|regex|string',
   preprocessCss:      'function',
   processCss:         'function',
   to:                 'string',
@@ -22,6 +22,7 @@ const rules = {
 const tests = {
   array:    require('lodash').isArray,
   function: require('lodash').isFunction,
+  regex:    require('lodash').isRegExp,
   string:   require('lodash').isString,
 };
 

package.json

@@ -33,6 +33,7 @@
   "dependencies": {
     "debug": "^2.2.0",
     "generic-names": "^1.0.1",
+    "glob-to-regexp": "^0.1.0",
     "icss-replace-symbols": "^1.0.2",
     "lodash": "^4.3.0",
     "lookup-fs": "^1.0.0",

test/api/append.js

@@ -15,8 +15,8 @@ suite('api/append', () => {
     });
 
     teardown(() => {
-      dropCache('./api/fixture/oceanic.css');
       detachHook('.css');
+      dropCache('./api/fixture/oceanic.css');
     });
   });
 });

test/api/extensions.js

@@ -12,8 +12,8 @@ suite('api/extensions', () => {
     setup(() => hook({}));
 
     teardown(() => {
-      dropCache('./api/fixture/oceanic.css');
       detachHook('.css');
+      dropCache('./api/fixture/oceanic.css');
     });
   });
 });

test/api/fixture/typography.css

@@ -0,0 +1,6 @@
+@import url(http://fonts.googleapis.com/css?family=Vollkorn:400,400italic,700,700italic&subset=latin);
+
+.common
+{
+  font: 1.3em 'Vollkorn', Palatino, Times;
+}

test/api/generateScopedName.js

@@ -50,7 +50,7 @@ suite('api/generateScopedName', () => {
   });
 
   teardown(() => {
-    dropCache('./api/fixture/oceanic.css');
     detachHook('.css');
+    dropCache('./api/fixture/oceanic.css');
   });
 });

test/api/ignore.js

@@ -0,0 +1,53 @@
+const detachHook = require('../sugar').detachHook;
+const dropCache = require('../sugar').dropCache;
+
+suite('api/ignore', () => {
+  suite('glob', () => {
+    setup(() => hook({
+      ignore: '*oceanic*',
+    }));
+
+    test('should return tokens', () => {
+      assert.deepEqual(require('./fixture/typography.css'), {
+        common: '_test_api_fixture_typography__common',
+      });
+    });
+
+    test('should throw an exception', () => {
+      assert.throws(() => require('./fixture/oceanic.css'));
+    });
+  });
+
+  suite('function', () => {
+    setup(() => hook({
+      ignore: filename => /typography/.test(filename),
+    }));
+
+    test('should return tokens', () => {
+      assert.throws(() => require('./fixture/typography.css'));
+    });
+
+    test('should throw an exception', () => {
+      assert.deepEqual(require('./fixture/oceanic.css'), {
+        color: '_test_api_fixture_oceanic__color',
+      });
+    });
+  });
+
+  suite('regex', () => {
+    setup(() => hook({
+      ignore: /\.css$/,
+    }));
+
+    test('should throw an exception', () => {
+      assert.throws(() => require('./fixture/typography.css'));
+      assert.throws(() => require('./fixture/oceanic.css'));
+    });
+  });
+
+  teardown(() => {
+    detachHook('.css');
+    dropCache('./api/fixture/oceanic.css');
+    dropCache('./api/fixture/typography.css');
+  });
+});

test/api/prepend.js

@@ -15,8 +15,8 @@ suite('api/prepend', () => {
     });
 
     teardown(() => {
-      dropCache('./api/fixture/oceanic.css');
       detachHook('.css');
+      dropCache('./api/fixture/oceanic.css');
     });
   });
 });

test/api/preprocessCss.js

@@ -13,7 +13,7 @@ suite('api/preprocessCss', () => {
   });
 
   teardown(() => {
-    dropCache('./api/fixture/oceanic.css');
     detachHook('.css');
+    dropCache('./api/fixture/oceanic.css');
   });
 });