Merge pull request #183 from adamwathan/override-default-extractor

Add support for overriding the default extractor
FullHuman · Apr 20, 2019 · 0dfb5de · 0dfb5de
2 parents 3f80766 + 292acf5
commit 0dfb5de
Show file tree

Hide file tree

Showing 6 changed files with 83 additions and 43 deletions.
diff --git a/__tests__/purgecss.test.js b/__tests__/purgecss.test.js
@@ -339,6 +339,42 @@ describe('special characters, with custom Extractor as a function', () => {
     })
 })
 
+describe('special characters, overriding the default Extractor', () => {
+    let purgecssResult
+    class CustomExtractor {
+        static extract(content) {
+            return content.match(/[A-z0-9-:/]+/g)
+        }
+    }
+
+    beforeAll(() => {
+        purgecssResult = new Purgecss({
+            content: [`${root}special_characters/special_characters.js`],
+            css: [`${root}special_characters/special_characters.css`],
+            defaultExtractor: CustomExtractor
+        }).purge()[0].css
+    })
+
+    it('finds tailwind class', () => {
+        expect(purgecssResult.includes('md\\:w-1\\/3')).toBe(true)
+    })
+})
+
+describe('special characters, overriding the default Extractor with a function', () => {
+    let purgecssResult
+    beforeAll(() => {
+        purgecssResult = new Purgecss({
+            content: [`${root}special_characters/special_characters.js`],
+            css: [`${root}special_characters/special_characters.css`],
+            defaultExtractor: content => content.match(/[A-z0-9-:/]+/g),
+        }).purge()[0].css
+    })
+
+    it('finds tailwind class', () => {
+        expect(purgecssResult.includes('md\\:w-1\\/3')).toBe(true)
+    })
+})
+
 describe('nth-child', () => {
     let purgecssResult
     beforeAll(() => {

diff --git a/flow-typed/index.js b/flow-typed/index.js
@@ -8,6 +8,7 @@ type RawContent = {
 declare type Options = {
   content: Array<string | RawContent>,
   css: Array<string | RawContent>,
+  defaultExtractor?: Object,
   extractors?: Array<ExtractorsObj>,
   whitelist?: Array<string>,
   whitelistPatterns?: Array<RegExp>,
@@ -36,4 +37,4 @@ declare type AtRules = {
   fontFace: Array<Object>
 }
 
-declare type IgnoreType = "next" | "start" | "end"
+declare type IgnoreType = "next" | "start" | "end"
diff --git a/lib/purgecss.es.js b/lib/purgecss.es.js
@@ -303,10 +303,28 @@ var substr = 'ab'.substr(-1) === 'b' ? function (str, start, len) {
   return str.substr(start, len);
 };
 
+var DefaultExtractor =
+/*#__PURE__*/
+function () {
+  function DefaultExtractor() {
+    _classCallCheck(this, DefaultExtractor);
+  }
+
+  _createClass(DefaultExtractor, null, [{
+    key: "extract",
+    value: function extract(content) {
+      return content.match(/[A-Za-z0-9_-]+/g) || [];
+    }
+  }]);
+
+  return DefaultExtractor;
+}();
+
 //      
 var defaultOptions = {
   css: [],
   content: [],
+  defaultExtractor: DefaultExtractor,
   extractors: [],
   whitelist: [],
   output: undefined,
@@ -336,23 +354,6 @@ var CSS_WHITELIST = ['*', '::-webkit-scrollbar', '::selection', ':root', '::befo
 
 var SELECTOR_STANDARD_TYPES = ['class', 'id', 'universal', 'pseudo'];
 
-var DefaultExtractor =
-/*#__PURE__*/
-function () {
-  function DefaultExtractor() {
-    _classCallCheck(this, DefaultExtractor);
-  }
-
-  _createClass(DefaultExtractor, null, [{
-    key: "extract",
-    value: function extract(content) {
-      return content.match(/[A-Za-z0-9_-]+/g) || [];
-    }
-  }]);
-
-  return DefaultExtractor;
-}();
-
 var Purgecss =
 /*#__PURE__*/
 function () {
@@ -698,13 +699,13 @@ function () {
     key: "getFileExtractor",
     value: function getFileExtractor(filename) {
       var extractors = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-      if (!extractors.length) return DefaultExtractor;
+      if (!extractors.length) return this.options.defaultExtractor;
       var extractorObj = extractors.find(function (extractor) {
         return extractor.extensions.find(function (ext) {
           return filename.endsWith(ext);
         });
       }) || {
-        extractor: DefaultExtractor
+        extractor: this.options.defaultExtractor
       };
       return extractorObj.extractor;
     }

diff --git a/lib/purgecss.js b/lib/purgecss.js
@@ -307,10 +307,28 @@ var substr = 'ab'.substr(-1) === 'b' ? function (str, start, len) {
   return str.substr(start, len);
 };
 
+var DefaultExtractor =
+/*#__PURE__*/
+function () {
+  function DefaultExtractor() {
+    _classCallCheck(this, DefaultExtractor);
+  }
+
+  _createClass(DefaultExtractor, null, [{
+    key: "extract",
+    value: function extract(content) {
+      return content.match(/[A-Za-z0-9_-]+/g) || [];
+    }
+  }]);
+
+  return DefaultExtractor;
+}();
+
 //      
 var defaultOptions = {
   css: [],
   content: [],
+  defaultExtractor: DefaultExtractor,
   extractors: [],
   whitelist: [],
   output: undefined,
@@ -340,23 +358,6 @@ var CSS_WHITELIST = ['*', '::-webkit-scrollbar', '::selection', ':root', '::befo
 
 var SELECTOR_STANDARD_TYPES = ['class', 'id', 'universal', 'pseudo'];
 
-var DefaultExtractor =
-/*#__PURE__*/
-function () {
-  function DefaultExtractor() {
-    _classCallCheck(this, DefaultExtractor);
-  }
-
-  _createClass(DefaultExtractor, null, [{
-    key: "extract",
-    value: function extract(content) {
-      return content.match(/[A-Za-z0-9_-]+/g) || [];
-    }
-  }]);
-
-  return DefaultExtractor;
-}();
-
 var Purgecss =
 /*#__PURE__*/
 function () {
@@ -702,13 +703,13 @@ function () {
     key: "getFileExtractor",
     value: function getFileExtractor(filename) {
       var extractors = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-      if (!extractors.length) return DefaultExtractor;
+      if (!extractors.length) return this.options.defaultExtractor;
       var extractorObj = extractors.find(function (extractor) {
         return extractor.extensions.find(function (ext) {
           return filename.endsWith(ext);
         });
       }) || {
-        extractor: DefaultExtractor
+        extractor: this.options.defaultExtractor
       };
       return extractorObj.extractor;
     }

diff --git a/src/constants/defaultOptions.js b/src/constants/defaultOptions.js
@@ -1,8 +1,11 @@
 // @flow
 
+import DefaultExtractor from '../Extractors/DefaultExtractor'
+
 const defaultOptions: Options = {
     css: [],
     content: [],
+    defaultExtractor: DefaultExtractor,
     extractors: [],
     whitelist: [],
     output: undefined,

diff --git a/src/index.js b/src/index.js
@@ -25,8 +25,6 @@ import {
 import CSS_WHITELIST from './constants/cssWhitelist'
 import SELECTOR_STANDARD_TYPES from './constants/selectorTypes'
 
-import DefaultExtractor from './Extractors/DefaultExtractor'
-
 class Purgecss {
     options: Options
     root: Object
@@ -228,11 +226,11 @@ class Purgecss {
      * @param {array} extractors Array of extractors definition objects
      */
     getFileExtractor(filename: string, extractors: Array<ExtractorsObj> = []) {
-        if (!extractors.length) return DefaultExtractor
+        if (!extractors.length) return this.options.defaultExtractor
 
         const extractorObj = extractors.find(extractor =>
             extractor.extensions.find(ext => filename.endsWith(ext))
-        ) || { extractor: DefaultExtractor }
+        ) || { extractor: this.options.defaultExtractor }
         return extractorObj.extractor
     }