@fullhuman/postcss-purgecss 4.1.3 → 5.0.0

package/lib/postcss-purgecss.d.ts

@@ -1,38 +1,164 @@
-import * as postcss from "postcss";
-type StringRegExpArray = Array<RegExp | string>;
-type ComplexSafelist = {
-  standard?: StringRegExpArray;
-  deep?: RegExp[];
-  greedy?: RegExp[];
-  variables?: StringRegExpArray;
-  keyframes?: StringRegExpArray;
-};
-type UserDefinedSafelist = StringRegExpArray | ComplexSafelist;
-interface RawContent$0<T = string> {
-  extension: string;
-  raw: T;
-}
-type ExtractorFunction$0<T = string> = (content: T) => string[];
-interface Extractors$0 {
-  extensions: string[];
-  extractor: ExtractorFunction$0;
-}
-interface UserDefinedOptions$0 {
-  content?: Array<string | RawContent$0>;
-  contentFunction?: (sourceFile: string) => Array<string | RawContent$0>;
-  defaultExtractor?: ExtractorFunction$0;
-  extractors?: Array<Extractors$0>;
-  fontFace?: boolean;
-  keyframes?: boolean;
-  output?: string;
-  rejected?: boolean;
-  stdin?: boolean;
-  stdout?: boolean;
-  variables?: boolean;
-  safelist?: UserDefinedSafelist;
-  blocklist?: StringRegExpArray;
-  skippedContentGlobs?: Array<string>;
-  dynamicAttributes?: string[];
-}
-declare const purgeCSSPlugin: postcss.PluginCreator<UserDefinedOptions$0>;
-export { purgeCSSPlugin as default };
+/**
+ * PostCSS Plugin for PurgeCSS
+ *
+ * Most bundlers and frameworks to build websites are using PostCSS.
+ * The easiest way to configure PurgeCSS is with its PostCSS plugin.
+ *
+ * @packageDocumentation
+ */
+
+import * as postcss from 'postcss';
+
+/**
+ * @public
+ */
+declare type ComplexSafelist = {
+    standard?: StringRegExpArray;
+    /**
+     * You can safelist selectors and their children based on a regular
+     * expression with `safelist.deep`
+     *
+     * @example
+     *
+     * ```ts
+     * const purgecss = await new PurgeCSS().purge({
+     *   content: [],
+     *   css: [],
+     *   safelist: {
+     *     deep: [/red$/]
+     *   }
+     * })
+     * ```
+     *
+     * In this example, selectors such as `.bg-red .child-of-bg` will be left
+     * in the final CSS, even if `child-of-bg` is not found.
+     *
+     */
+    deep?: RegExp[];
+    greedy?: RegExp[];
+    variables?: StringRegExpArray;
+    keyframes?: StringRegExpArray;
+};
+
+/**
+ * @public
+ */
+declare type ExtractorFunction<T = string> = (content: T) => ExtractorResult;
+
+/**
+ * @public
+ */
+declare type ExtractorResult = ExtractorResultDetailed | string[];
+
+/**
+ * @public
+ */
+declare interface ExtractorResultDetailed {
+    attributes: {
+        names: string[];
+        values: string[];
+    };
+    classes: string[];
+    ids: string[];
+    tags: string[];
+    undetermined: string[];
+}
+
+/**
+ * @public
+ */
+declare interface Extractors {
+    extensions: string[];
+    extractor: ExtractorFunction;
+}
+
+/**
+ * PostCSS Plugin for PurgeCSS
+ *
+ * @param opts - PurgeCSS Options
+ * @returns the postCSS plugin
+ *
+ * @public
+ */
+declare const purgeCSSPlugin: postcss.PluginCreator<UserDefinedOptions>;
+export default purgeCSSPlugin;
+
+/**
+ * @public
+ */
+declare interface RawContent<T = string> {
+    extension: string;
+    raw: T;
+}
+
+/**
+ * @public
+ */
+declare interface RawCSS {
+    raw: string;
+    name?: string;
+}
+
+/**
+ * @public
+ */
+declare type StringRegExpArray = Array<RegExp | string>;
+
+/**
+ * {@inheritDoc purgecss#UserDefinedOptions}
+ *
+ * @public
+ */
+export declare interface UserDefinedOptions extends Omit<UserDefinedOptions_2, "content" | "css"> {
+    content?: UserDefinedOptions_2["content"];
+    contentFunction?: (sourceFile: string) => Array<string | RawContent>;
+}
+
+/**
+ * Options used by PurgeCSS to remove unused CSS
+ *
+ * @public
+ */
+declare interface UserDefinedOptions_2 {
+    /** {@inheritDoc Options.content} */
+    content: Array<string | RawContent>;
+    /** {@inheritDoc Options.css} */
+    css: Array<string | RawCSS>;
+    /** {@inheritDoc Options.defaultExtractor} */
+    defaultExtractor?: ExtractorFunction;
+    /** {@inheritDoc Options.extractors} */
+    extractors?: Array<Extractors>;
+    /** {@inheritDoc Options.fontFace} */
+    fontFace?: boolean;
+    /** {@inheritDoc Options.keyframes} */
+    keyframes?: boolean;
+    /** {@inheritDoc Options.output} */
+    output?: string;
+    /** {@inheritDoc Options.rejected} */
+    rejected?: boolean;
+    /** {@inheritDoc Options.rejectedCss} */
+    rejectedCss?: boolean;
+    /** {@inheritDoc Options.sourceMap } */
+    sourceMap?: boolean | (postcss.SourceMapOptions & { to?: string });
+    /** {@inheritDoc Options.stdin} */
+    stdin?: boolean;
+    /** {@inheritDoc Options.stdout} */
+    stdout?: boolean;
+    /** {@inheritDoc Options.variables} */
+    variables?: boolean;
+    /** {@inheritDoc Options.safelist} */
+    safelist?: UserDefinedSafelist;
+    /** {@inheritDoc Options.blocklist} */
+    blocklist?: StringRegExpArray;
+    /** {@inheritDoc Options.skippedContentGlobs} */
+    skippedContentGlobs?: Array<string>;
+    /** {@inheritDoc Options.dynamicAttributes} */
+    dynamicAttributes?: string[];
+}
+
+/**
+ * @public
+ */
+declare type UserDefinedSafelist = StringRegExpArray | ComplexSafelist;
+
+export { }

package/lib/postcss-purgecss.esm.js

@@ -1 +1 @@
-import e,{defaultOptions as t,standardizeSafelist as s,mergeExtractorSelectors as o}from"purgecss";const r=function(r){if(void 0===r)throw new Error("PurgeCSS plugin does not have the correct options");return{postcssPlugin:"postcss-purgecss",OnceExit:(n,c)=>async function(r,n,{result:c}){const i=new e,a={...t,...r,safelist:s(null==r?void 0:r.safelist)};r&&"function"==typeof r.contentFunction&&(a.content=r.contentFunction(n.source&&n.source.input.file||"")),i.options=a;const{content:p,extractors:u}=a,l=p.filter((e=>"string"==typeof e)),f=p.filter((e=>"object"==typeof e)),m=await i.extractSelectorsFromFiles(l,u),g=await i.extractSelectorsFromString(f,u),d=o(m,g);i.walkThroughCSS(n,d),i.options.fontFace&&i.removeUnusedFontFaces(),i.options.keyframes&&i.removeUnusedKeyframes(),i.options.variables&&i.removeUnusedCSSVariables(),i.options.rejected&&i.selectorsRemoved.size>0&&(c.messages.push({type:"purgecss",plugin:"postcss-purgecss",text:`purging ${i.selectorsRemoved.size} selectors:\n          ${Array.from(i.selectorsRemoved).map((e=>e.trim())).join("\n  ")}`}),i.selectorsRemoved.clear())}(r,n,c)}};r.postcss=!0;export{r as default};
+import*as e from"path";import{PurgeCSS as s,defaultOptions as t,standardizeSafelist as o,mergeExtractorSelectors as r}from"purgecss";const n=function(n){if(void 0===n)throw new Error("PurgeCSS plugin does not have the correct options");return{postcssPlugin:"postcss-purgecss",OnceExit:(c,i)=>async function(n,c,{result:i}){const a=new s;let l;try{const s=e.resolve(process.cwd(),"purgecss.config.js");l=await import(s)}catch{}const p={...t,...l,...n,safelist:o((null==n?void 0:n.safelist)||(null==l?void 0:l.safelist))};n&&"function"==typeof n.contentFunction&&(p.content=n.contentFunction(c.source&&c.source.input.file||"")),a.options=p,p.variables&&(a.variablesStructure.safelist=p.safelist.variables||[]);const{content:u,extractors:f}=p,m=u.filter((e=>"string"==typeof e)),g=u.filter((e=>"object"==typeof e)),v=await a.extractSelectorsFromFiles(m,f),d=await a.extractSelectorsFromString(g,f),S=r(v,d);a.walkThroughCSS(c,S),a.options.fontFace&&a.removeUnusedFontFaces(),a.options.keyframes&&a.removeUnusedKeyframes(),a.options.variables&&a.removeUnusedCSSVariables(),a.options.rejected&&a.selectorsRemoved.size>0&&(i.messages.push({type:"purgecss",plugin:"postcss-purgecss",text:`purging ${a.selectorsRemoved.size} selectors:\n          ${Array.from(a.selectorsRemoved).map((e=>e.trim())).join("\n  ")}`}),a.selectorsRemoved.clear())}(n,c,i)}};n.postcss=!0;export{n as default};

package/lib/postcss-purgecss.js

@@ -1 +1 @@
-"use strict";var e=require("purgecss");function t(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var s=t(e);const o=function(t){if(void 0===t)throw new Error("PurgeCSS plugin does not have the correct options");return{postcssPlugin:"postcss-purgecss",OnceExit:(o,r)=>async function(t,o,{result:r}){const n=new s.default,c={...e.defaultOptions,...t,safelist:e.standardizeSafelist(null==t?void 0:t.safelist)};t&&"function"==typeof t.contentFunction&&(c.content=t.contentFunction(o.source&&o.source.input.file||"")),n.options=c;const{content:i,extractors:a}=c,u=i.filter((e=>"string"==typeof e)),l=i.filter((e=>"object"==typeof e)),p=await n.extractSelectorsFromFiles(u,a),f=await n.extractSelectorsFromString(l,a),d=e.mergeExtractorSelectors(p,f);n.walkThroughCSS(o,d),n.options.fontFace&&n.removeUnusedFontFaces(),n.options.keyframes&&n.removeUnusedKeyframes(),n.options.variables&&n.removeUnusedCSSVariables(),n.options.rejected&&n.selectorsRemoved.size>0&&(r.messages.push({type:"purgecss",plugin:"postcss-purgecss",text:`purging ${n.selectorsRemoved.size} selectors:\n          ${Array.from(n.selectorsRemoved).map((e=>e.trim())).join("\n  ")}`}),n.selectorsRemoved.clear())}(t,o,r)}};o.postcss=!0,module.exports=o;
+"use strict";var e=require("path"),t=require("purgecss");function r(e){if(e&&e.__esModule)return e;var t=Object.create(null);return e&&Object.keys(e).forEach((function(r){if("default"!==r){var s=Object.getOwnPropertyDescriptor(e,r);Object.defineProperty(t,r,s.get?s:{enumerable:!0,get:function(){return e[r]}})}})),t.default=e,Object.freeze(t)}var s=r(e);const o=function(e){if(void 0===e)throw new Error("PurgeCSS plugin does not have the correct options");return{postcssPlugin:"postcss-purgecss",OnceExit:(o,n)=>async function(e,o,{result:n}){const c=new t.PurgeCSS;let i;try{const e=s.resolve(process.cwd(),"purgecss.config.js");i=await function(e){return Promise.resolve().then((function(){return r(require(e))}))}(e)}catch{}const a={...t.defaultOptions,...i,...e,safelist:t.standardizeSafelist((null==e?void 0:e.safelist)||(null==i?void 0:i.safelist))};e&&"function"==typeof e.contentFunction&&(a.content=e.contentFunction(o.source&&o.source.input.file||"")),c.options=a,a.variables&&(c.variablesStructure.safelist=a.safelist.variables||[]);const{content:u,extractors:l}=a,f=u.filter((e=>"string"==typeof e)),p=u.filter((e=>"object"==typeof e)),d=await c.extractSelectorsFromFiles(f,l),g=await c.extractSelectorsFromString(p,l),v=t.mergeExtractorSelectors(d,g);c.walkThroughCSS(o,v),c.options.fontFace&&c.removeUnusedFontFaces(),c.options.keyframes&&c.removeUnusedKeyframes(),c.options.variables&&c.removeUnusedCSSVariables(),c.options.rejected&&c.selectorsRemoved.size>0&&(n.messages.push({type:"purgecss",plugin:"postcss-purgecss",text:`purging ${c.selectorsRemoved.size} selectors:\n          ${Array.from(c.selectorsRemoved).map((e=>e.trim())).join("\n  ")}`}),c.selectorsRemoved.clear())}(e,o,n)}};o.postcss=!0,module.exports=o;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullhuman/postcss-purgecss",
-  "version": "4.1.3",
+  "version": "5.0.0",
   "description": "PostCSS plugin for PurgeCSS",
   "author": "FoundrySH <no-reply@foundry.sh>",
   "homepage": "https://purgecss.com",
@@ -20,16 +20,17 @@
     "url": "git+https://github.com/FullHuman/purgecss.git"
   },
   "scripts": {
-    "test": "echo \"Error: run tests from root\" && exit 1"
+    "build": "ts-node build.ts",
+    "test": "jest"
   },
   "bugs": {
     "url": "https://github.com/FullHuman/purgecss/issues"
   },
   "dependencies": {
-    "purgecss": "^4.1.3"
+    "purgecss": "^5.0.0"
   },
   "devDependencies": {
-    "postcss": "^8.3.0"
+    "postcss": "^8.4.4"
   },
   "peerDependencies": {
     "postcss": "^8.0.0"
@@ -37,6 +38,5 @@
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
-  },
-  "gitHead": "37e5053a446880d12fd2f55abfc362c3dac9c49c"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-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/lib/postcss-purgecss.esm.d.ts

@@ -1,38 +0,0 @@
-import * as postcss from "postcss";
-type StringRegExpArray = Array<RegExp | string>;
-type ComplexSafelist = {
-  standard?: StringRegExpArray;
-  deep?: RegExp[];
-  greedy?: RegExp[];
-  variables?: StringRegExpArray;
-  keyframes?: StringRegExpArray;
-};
-type UserDefinedSafelist = StringRegExpArray | ComplexSafelist;
-interface RawContent$0<T = string> {
-  extension: string;
-  raw: T;
-}
-type ExtractorFunction$0<T = string> = (content: T) => string[];
-interface Extractors$0 {
-  extensions: string[];
-  extractor: ExtractorFunction$0;
-}
-interface UserDefinedOptions$0 {
-  content?: Array<string | RawContent$0>;
-  contentFunction?: (sourceFile: string) => Array<string | RawContent$0>;
-  defaultExtractor?: ExtractorFunction$0;
-  extractors?: Array<Extractors$0>;
-  fontFace?: boolean;
-  keyframes?: boolean;
-  output?: string;
-  rejected?: boolean;
-  stdin?: boolean;
-  stdout?: boolean;
-  variables?: boolean;
-  safelist?: UserDefinedSafelist;
-  blocklist?: StringRegExpArray;
-  skippedContentGlobs?: Array<string>;
-  dynamicAttributes?: string[];
-}
-declare const purgeCSSPlugin: postcss.PluginCreator<UserDefinedOptions$0>;
-export { purgeCSSPlugin as default };