feat: add exclude option (#53)

* feat: add option exclude

* feat: add option exclude

* fix: Resolving conflicts

Author: endday

README.md

@@ -67,7 +67,8 @@ Default:
     selectorBlackList: [],
     replace: true,
     mediaQuery: false,
-    minPixelValue: 0
+    minPixelValue: 0,
+    exclude: /node_modules/i
 }
 ```
 
@@ -87,7 +88,14 @@ Default:
 - `replace` (Boolean) Replaces rules containing rems instead of adding fallbacks.
 - `mediaQuery` (Boolean) Allow px to be converted in media queries.
 - `minPixelValue` (Number) Set the minimum pixel value to replace.
-
+- `exclude` (String, Regexp, Function) The file path to ignore and leave as px.
+    - If value is string, it checks to see if file path contains the string.
+        - `'exclude'` will match `\project\postcss-pxtorem\exclude\path`
+    - If value is regexp, it checks to see if file path matches the regexp.
+        - `/exclude/i` will match `\project\postcss-pxtorem\exclude\path`
+    - If value is function, you can use exclude function to return a true and the file will be ignored.
+        - the callback will pass the file path as  a parameter, it should returns a Boolean result.
+        - `function (file) { return file.indexOf('exclude') !== -1; }`
 
 ### Use with gulp-postcss and autoprefixer
 

index.js

@@ -1,8 +1,7 @@
-"use strict";
-
 const postcss = require("postcss");
 const pxRegex = require("./lib/pixel-unit-regex");
 const filterPropList = require("./lib/filter-prop-list");
+const type = require("./lib/type");
 
 const defaults = {
   rootValue: 16,
@@ -11,7 +10,8 @@ const defaults = {
   propList: ["font", "font-size", "line-height", "letter-spacing"],
   replace: true,
   mediaQuery: false,
-  minPixelValue: 0
+  minPixelValue: 0,
+  exclude: null
 };
 
 const legacyOptions = {
@@ -29,6 +29,17 @@ module.exports = postcss.plugin("postcss-pxtorem", options => {
   const satisfyPropList = createPropListMatcher(opts.propList);
 
   return css => {
+    const exclude = opts.exclude;
+    const filePath = css.source.input.file;
+    if (
+      exclude &&
+      ((type.isFunction(exclude) && exclude(filePath)) ||
+        (type.isString(exclude) && filePath.indexOf(exclude) !== -1) ||
+        filePath.match(exclude) !== null)
+    ) {
+      return;
+    }
+
     const rootValue =
       typeof opts.rootValue === "function"
         ? opts.rootValue(css.source.input)

lib/type.js

@@ -0,0 +1,23 @@
+var type = function (s) {
+    return Object.prototype.toString.call(s).slice(8, -1).toLowerCase();
+};
+
+var types = [
+    'String',
+    'Array',
+    'Undefined',
+    'Boolean',
+    'Number',
+    'Function',
+    'Symbol',
+    'Object'
+];
+
+types.forEach(function (str) {
+    type['is' + str] = function (val) {
+        return type(val) === str.toLowerCase();
+    };
+});
+
+module.exports = type;
+

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "postcss-pxtorem",
   "description": "A CSS post-processor that converts px to rem.",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "author": "cuth",
   "license": "MIT",
   "repository": {

package.json

@@ -494,3 +494,31 @@ describe("filter-prop-list", function() {
     expect(filterPropList.notEndWith(propList).join()).toBe(expected);
   });
 });
+
+describe('exclude', function () {
+    it('should ignore file path with exclude RegEx', function () {
+        var options = {
+            exclude: /exclude/i
+        };
+        var processed = postcss(pxtorem(options)).process(basicCSS, { from: 'exclude/path' }).css;
+        expect(processed).toBe(basicCSS);
+    });
+
+    it('should not ignore file path with exclude String', function () {
+        var options = {
+            exclude: 'exclude'
+        };
+        var processed = postcss(pxtorem(options)).process(basicCSS, { from: 'exclude/path' }).css;
+        expect(processed).toBe(basicCSS);
+    });
+
+    it('should not ignore file path with exclude function', function () {
+        var options = {
+            exclude: function (file) {
+                return file.indexOf('exclude') !== -1;
+            }
+        };
+        var processed = postcss(pxtorem(options)).process(basicCSS, { from: 'exclude/path' }).css;
+        expect(processed).toBe(basicCSS);
+    });
+});