purgecss-from-pug 5.0.0 → 7.0.1-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Full Human
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,11 +1,22 @@
 # `purgecss-from-pug`
 
-> TODO: description
+A PurgeCSS extractor for PUG files that automatically generates a list of used CSS selectors from your PUG files. This extractor can be used with PurgeCSS to eliminate unused CSS and reduce the size of your production builds.
 
 ## Usage
 
 ```
-const purgecssFromPug = require('purgecss-from-pug');
+import { PurgeCSS } from 'purgecss'
+import { purgeCSSFromPug } from 'purgecss-from-pug'
+const options = {
+  content: [], // files to extract the selectors from
+  css: [], // css
+  extractors: [
+    {
+      extractor: purgeCSSFromPug,
+      extensions: ['pug']
+    },
+  ]
+}
 
-// TODO: DEMONSTRATE API
+const purgecss = await new PurgeCSS().purge();
 ```

package/lib/purgecss-from-pug.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Pug extractor for PurgeCSS
+ *
+ * A PurgeCSS extractor for PUG files that automatically generates a list of
+ * used CSS selectors. This extractor can be used with PurgeCSS to eliminate
+ * unused CSS and reduce the size of your production builds.
+ *
+ * @packageDocumentation
+ */
+
+import type { ExtractorResultDetailed } from 'purgecss';
+
 /**
  * Get the potential selectors from Pug code
  *
@@ -6,7 +18,6 @@
  *
  * @public
  */
-declare const purgeFromPug: (content: string) => string[];
-export default purgeFromPug;
+export declare const purgeCSSFromPug: (content: string) => ExtractorResultDetailed;
 
 export { }

package/lib/purgecss-from-pug.esm.js

@@ -1 +1,68 @@
-import s from"pug-lexer";const a=a=>{const e=s(a),t=[];for(const s of e)switch(s.type){case"tag":case"id":case"class":t.push(...s.val.split(" "));break;case"attribute":if("class"===s.name||"id"===s.name){if("string"!=typeof s.val)continue;t.push(...(s.mustEscape?s.val.replace(/"/g,""):s.val).split(" "))}}return t};export{a as default};
+import lex from 'pug-lexer';
+
+/**
+ * Pug extractor for PurgeCSS
+ *
+ * A PurgeCSS extractor for PUG files that automatically generates a list of
+ * used CSS selectors. This extractor can be used with PurgeCSS to eliminate
+ * unused CSS and reduce the size of your production builds.
+ *
+ * @packageDocumentation
+ */
+const getAttributeTokenValues = (token) => {
+    if (typeof token.val === "string") {
+        return (token.mustEscape ? token.val.replace(/"/g, "") : token.val).split(" ");
+    }
+    return [];
+};
+/**
+ * Get the potential selectors from Pug code
+ *
+ * @param content - Pug code
+ * @returns the attributes, classes, ids, and tags from the Pug code
+ *
+ * @public
+ */
+const purgeCSSFromPug = (content) => {
+    const tokens = lex(content);
+    const extractorResult = {
+        attributes: {
+            // always add to attributes, to handle things like [class*=foo]
+            names: ["class", "id"],
+            values: ["true", "false"],
+        },
+        classes: [],
+        ids: [],
+        tags: [],
+        undetermined: [],
+    };
+    for (const token of tokens) {
+        if (token.type === "tag") {
+            extractorResult.tags.push(token.val);
+        }
+        else if (token.type === "class") {
+            extractorResult.classes.push(...token.val.split(" "));
+            extractorResult.attributes.values.push(...token.val.split(" "));
+        }
+        else if (token.type === "id") {
+            extractorResult.ids.push(token.val);
+            extractorResult.attributes.values.push(token.val);
+        }
+        else if (token.type === "attribute") {
+            const tokenValues = getAttributeTokenValues(token);
+            if (token.name === "class") {
+                extractorResult.classes.push(...tokenValues);
+            }
+            else if (token.name === "id") {
+                extractorResult.ids.push(...tokenValues);
+            }
+            else {
+                extractorResult.attributes.names.push(token.name);
+            }
+            extractorResult.attributes.values.push(...tokenValues);
+        }
+    }
+    return extractorResult;
+};
+
+export { purgeCSSFromPug };

package/lib/purgecss-from-pug.js

@@ -1 +1,70 @@
-"use strict";function e(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var t=e(require("pug-lexer"));module.exports=e=>{const a=t.default(e),s=[];for(const e of a)switch(e.type){case"tag":case"id":case"class":s.push(...e.val.split(" "));break;case"attribute":if("class"===e.name||"id"===e.name){if("string"!=typeof e.val)continue;s.push(...(e.mustEscape?e.val.replace(/"/g,""):e.val).split(" "))}}return s};
+'use strict';
+
+var lex = require('pug-lexer');
+
+/**
+ * Pug extractor for PurgeCSS
+ *
+ * A PurgeCSS extractor for PUG files that automatically generates a list of
+ * used CSS selectors. This extractor can be used with PurgeCSS to eliminate
+ * unused CSS and reduce the size of your production builds.
+ *
+ * @packageDocumentation
+ */
+const getAttributeTokenValues = (token) => {
+    if (typeof token.val === "string") {
+        return (token.mustEscape ? token.val.replace(/"/g, "") : token.val).split(" ");
+    }
+    return [];
+};
+/**
+ * Get the potential selectors from Pug code
+ *
+ * @param content - Pug code
+ * @returns the attributes, classes, ids, and tags from the Pug code
+ *
+ * @public
+ */
+const purgeCSSFromPug = (content) => {
+    const tokens = lex(content);
+    const extractorResult = {
+        attributes: {
+            // always add to attributes, to handle things like [class*=foo]
+            names: ["class", "id"],
+            values: ["true", "false"],
+        },
+        classes: [],
+        ids: [],
+        tags: [],
+        undetermined: [],
+    };
+    for (const token of tokens) {
+        if (token.type === "tag") {
+            extractorResult.tags.push(token.val);
+        }
+        else if (token.type === "class") {
+            extractorResult.classes.push(...token.val.split(" "));
+            extractorResult.attributes.values.push(...token.val.split(" "));
+        }
+        else if (token.type === "id") {
+            extractorResult.ids.push(token.val);
+            extractorResult.attributes.values.push(token.val);
+        }
+        else if (token.type === "attribute") {
+            const tokenValues = getAttributeTokenValues(token);
+            if (token.name === "class") {
+                extractorResult.classes.push(...tokenValues);
+            }
+            else if (token.name === "id") {
+                extractorResult.ids.push(...tokenValues);
+            }
+            else {
+                extractorResult.attributes.names.push(token.name);
+            }
+            extractorResult.attributes.values.push(...tokenValues);
+        }
+    }
+    return extractorResult;
+};
+
+exports.purgeCSSFromPug = purgeCSSFromPug;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "purgecss-from-pug",
-  "version": "5.0.0",
+  "version": "7.0.1-alpha.0",
   "description": "Pug extractor for PurgeCSS",
   "author": "Ffloriel",
   "homepage": "https://github.com/FullHuman/purgecss#readme",
@@ -31,5 +31,6 @@
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
-  }
+  },
+  "gitHead": "5a51b05a191ba48b5e55440ac2e66822f9e182fe"
 }