rollup-plugin-purgecss 4.1.3 → 6.0.0

package/__tests__/index.test.ts

@@ -1,5 +1,5 @@
-import fs from "fs";
-import path from "path";
+import * as fs from "fs";
+import * as path from "path";
 import { rollup } from "rollup";
 import purgecss from "./../src/";
 

package/build.ts

@@ -0,0 +1,25 @@
+import {
+  buildRollup,
+  createRollupConfig,
+  extractAPI,
+} from "../../scripts/build";
+import { promises as asyncFs } from "fs";
+import * as path from "path";
+
+(async () => {
+  await asyncFs.rm(path.resolve(__dirname, "lib"), {
+    recursive: true,
+    force: true,
+  });
+  const rollupConfig = createRollupConfig("rollup-plugin-purgecss", [
+    "fs",
+    "rollup-pluginutils",
+    "purgecss",
+  ]);
+  await buildRollup(rollupConfig);
+  await extractAPI(__dirname);
+  await asyncFs.rm(path.resolve(__dirname, "lib", ".temp"), {
+    recursive: true,
+    force: true,
+  });
+})();

package/jest.config.ts

@@ -0,0 +1,2 @@
+import { createConfig } from "./../../jest.config";
+export default createConfig(__dirname, "rollup-plugin-purgecss");

package/lib/rollup-plugin-purgecss.d.ts

@@ -1,43 +1,164 @@
-import { Plugin } from "rollup";
-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;
-}
-type OutputFunction = (css: string, styles: string[]) => void;
-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 | OutputFunction | boolean;
-  rejected?: boolean;
-  stdin?: boolean;
-  stdout?: boolean;
-  variables?: boolean;
-  safelist?: UserDefinedSafelist;
-  blocklist?: StringRegExpArray;
-  skippedContentGlobs?: Array<string>;
-  dynamicAttributes?: string[];
-  insert?: boolean;
-  include?: string | RegExp | (string | RegExp)[];
-  exclude?: string | RegExp | (string | RegExp)[];
-  dest?: string;
-}
-declare function pluginPurgeCSS(options: UserDefinedOptions$0): Plugin;
-export { pluginPurgeCSS as default };
+import { Plugin as Plugin_2 } from 'rollup';
+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;
+}
+
+/**
+ * @public
+ */
+export declare type OutputFunction = (css: string, styles: string[]) => void;
+
+/**
+ *
+ * @param options - options
+ * @returns
+ *
+ * @public
+ */
+declare function pluginPurgeCSS(options: UserDefinedOptions): Plugin_2;
+export default pluginPurgeCSS;
+
+/**
+ * @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 type UserDefinedOptions = Omit<UserDefinedOptions_2, "css" | "output" | "rejectedCss"> & {
+    contentFunction?: (sourceFile: string) => Array<string | RawContent>;
+    output: UserDefinedOptions_2["output"] | OutputFunction | boolean;
+    insert?: boolean;
+    include?: string | RegExp | (string | RegExp)[];
+    exclude?: string | RegExp | (string | RegExp)[];
+    dest?: string;
+};
+
+/**
+ * Options used by PurgeCSS to remove unused CSS
+ *
+ * @public
+ */
+declare interface UserDefinedOptions_2 {
+    /** {@inheritDoc purgecss#Options.content} */
+    content: Array<string | RawContent>;
+    /** {@inheritDoc purgecss#Options.css} */
+    css: Array<string | RawCSS>;
+    /** {@inheritDoc purgecss#Options.defaultExtractor} */
+    defaultExtractor?: ExtractorFunction;
+    /** {@inheritDoc purgecss#Options.extractors} */
+    extractors?: Array<Extractors>;
+    /** {@inheritDoc purgecss#Options.fontFace} */
+    fontFace?: boolean;
+    /** {@inheritDoc purgecss#Options.keyframes} */
+    keyframes?: boolean;
+    /** {@inheritDoc purgecss#Options.output} */
+    output?: string;
+    /** {@inheritDoc purgecss#Options.rejected} */
+    rejected?: boolean;
+    /** {@inheritDoc purgecss#Options.rejectedCss} */
+    rejectedCss?: boolean;
+    /** {@inheritDoc purgecss#Options.sourceMap } */
+    sourceMap?: boolean | (postcss.SourceMapOptions & { to?: string });
+    /** {@inheritDoc purgecss#Options.stdin} */
+    stdin?: boolean;
+    /** {@inheritDoc purgecss#Options.stdout} */
+    stdout?: boolean;
+    /** {@inheritDoc purgecss#Options.variables} */
+    variables?: boolean;
+    /** {@inheritDoc purgecss#Options.safelist} */
+    safelist?: UserDefinedSafelist;
+    /** {@inheritDoc purgecss#Options.blocklist} */
+    blocklist?: StringRegExpArray;
+    /** {@inheritDoc purgecss#Options.skippedContentGlobs} */
+    skippedContentGlobs?: Array<string>;
+    /** {@inheritDoc purgecss#Options.dynamicAttributes} */
+    dynamicAttributes?: string[];
+}
+
+/**
+ * @public
+ */
+declare type UserDefinedSafelist = StringRegExpArray | ComplexSafelist;
+
+export { }

package/lib/rollup-plugin-purgecss.esm.js

@@ -1 +1 @@
-import t from"fs";import{PurgeCSS as e}from"purgecss";import{createFilter as n}from"rollup-pluginutils";function r(r){const u=n(r.include||["**/*.css"],r.exclude||"node_modules/**"),s=[];let o="";return{name:"purgecss",transform:async(t,n)=>{if(!u(n))return null;let o=(await(new e).purge({content:r.content,css:[{raw:t}]}))[0].css;return s.push(o),o=JSON.stringify(o),r.insert||(t=r.output?'"";':o),{code:`export default ${t}`,map:{mappings:""}}},generateBundle(){if(!(r.insert||s.length&&!1!==r.output))return;const e=s.reduce(((t,e)=>t+e),"");return"string"==typeof r.output?t.writeFileSync(r.output,e):"function"==typeof r.output?r.output(e,s):!r.insert&&o?((o.endsWith(".js")||o.endsWith(".ts"))&&(o=o.slice(0,-3)),o=`${o}.css`,t.writeFileSync(o,e)):void 0}}}export{r as default};
+import*as t from"fs";import{PurgeCSS as e}from"purgecss";import{createFilter as n}from"rollup-pluginutils";function r(r){const u=n(r.include||["**/*.css"],r.exclude||"node_modules/**"),s=[];let o="";return{name:"purgecss",transform:async(t,n)=>{if(!u(n))return null;let o=(await(new e).purge({content:r.content,css:[{raw:t}]}))[0].css;return s.push(o),o=JSON.stringify(o),r.insert||(t=r.output?'"";':o),{code:`export default ${t}`,map:{mappings:""}}},generateBundle(){if(!(r.insert||s.length&&!1!==r.output))return;const e=s.reduce(((t,e)=>t+e),"");return"string"==typeof r.output?t.writeFileSync(r.output,e):"function"==typeof r.output?r.output(e,s):!r.insert&&o?((o.endsWith(".js")||o.endsWith(".ts"))&&(o=o.slice(0,-3)),o=`${o}.css`,t.writeFileSync(o,e)):void 0}}}export{r as default};

package/lib/rollup-plugin-purgecss.js

@@ -1 +1 @@
-"use strict";var e=require("fs"),t=require("purgecss"),u=require("rollup-pluginutils");function r(e){return e&&"object"==typeof e&&"default"in e?e:{default:e}}var n=r(e);module.exports=function(e){const r=u.createFilter(e.include||["**/*.css"],e.exclude||"node_modules/**"),s=[];let i="";return{name:"purgecss",transform:async(u,n)=>{if(!r(n))return null;let i=(await(new t.PurgeCSS).purge({content:e.content,css:[{raw:u}]}))[0].css;return s.push(i),i=JSON.stringify(i),e.insert||(u=e.output?'"";':i),{code:`export default ${u}`,map:{mappings:""}}},generateBundle(){if(!(e.insert||s.length&&!1!==e.output))return;const t=s.reduce(((e,t)=>e+t),"");return"string"==typeof e.output?n.default.writeFileSync(e.output,t):"function"==typeof e.output?e.output(t,s):!e.insert&&i?((i.endsWith(".js")||i.endsWith(".ts"))&&(i=i.slice(0,-3)),i=`${i}.css`,n.default.writeFileSync(i,t)):void 0}}};
+"use strict";var e=require("fs"),t=require("purgecss"),r=require("rollup-pluginutils");function u(e){if(e&&e.__esModule)return e;var t=Object.create(null);return e&&Object.keys(e).forEach((function(r){if("default"!==r){var u=Object.getOwnPropertyDescriptor(e,r);Object.defineProperty(t,r,u.get?u:{enumerable:!0,get:function(){return e[r]}})}})),t.default=e,Object.freeze(t)}var n=u(e);module.exports=function(e){const u=r.createFilter(e.include||["**/*.css"],e.exclude||"node_modules/**"),s=[];let i="";return{name:"purgecss",transform:async(r,n)=>{if(!u(n))return null;let i=(await(new t.PurgeCSS).purge({content:e.content,css:[{raw:r}]}))[0].css;return s.push(i),i=JSON.stringify(i),e.insert||(r=e.output?'"";':i),{code:`export default ${r}`,map:{mappings:""}}},generateBundle(){if(!(e.insert||s.length&&!1!==e.output))return;const t=s.reduce(((e,t)=>e+t),"");return"string"==typeof e.output?n.writeFileSync(e.output,t):"function"==typeof e.output?e.output(t,s):!e.insert&&i?((i.endsWith(".js")||i.endsWith(".ts"))&&(i=i.slice(0,-3)),i=`${i}.css`,n.writeFileSync(i,t)):void 0}}};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rollup-plugin-purgecss",
-  "version": "4.1.3",
+  "version": "6.0.0",
   "description": "Rollup plugin for purgecss",
   "main": "lib/rollup-plugin-purgecss.js",
   "module": "./lib/rollup-plugin-purgecss.es.js",
@@ -10,7 +10,8 @@
     "test": "__tests__"
   },
   "scripts": {
-    "test": "echo \"Error: run tests from root\" && exit 1"
+    "build": "ts-node build.ts",
+    "test": "jest"
   },
   "repository": {
     "type": "git",
@@ -30,12 +31,11 @@
   },
   "homepage": "https://purgecss.com",
   "dependencies": {
-    "purgecss": "^4.1.3",
+    "purgecss": "^5.0.0",
     "rollup-pluginutils": "^2.8.0"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
-  },
-  "gitHead": "37e5053a446880d12fd2f55abfc362c3dac9c49c"
+  }
 }

package/src/index.ts

@@ -1,13 +1,22 @@
-import fs from "fs";
+import * as fs from "fs";
 import { PurgeCSS } from "purgecss";
 import { Plugin } from "rollup";
 import { createFilter } from "rollup-pluginutils";
 import { UserDefinedOptions } from "./types";
 
+export * from "./types";
+
+/**
+ *
+ * @param options - options
+ * @returns
+ *
+ * @public
+ */
 function pluginPurgeCSS(options: UserDefinedOptions): Plugin {
   const filter = createFilter(
     options.include || ["**/*.css"],
-    options.exclude || "node_modules/**"
+    options.exclude || "node_modules/**",
   );
 
   const styles: string[] = [];

package/src/types/index.ts

@@ -1,42 +1,26 @@
-import {
-  StringRegExpArray,
-  UserDefinedSafelist,
-} from "../../../purgecss/src/types/index";
+import type {
+  RawContent,
+  UserDefinedOptions as PurgeCSSUserDefinedOptions,
+} from "purgecss";
 
-export interface RawContent<T = string> {
-  extension: string;
-  raw: T;
-}
-export interface RawCSS {
-  raw: string;
-}
-type ExtractorFunction<T = string> = (content: T) => string[];
-export interface Extractors {
-  extensions: string[];
-  extractor: ExtractorFunction;
-}
+/**
+ * @public
+ */
+export type OutputFunction = (css: string, styles: string[]) => void;
 
-type OutputFunction = (css: string, styles: string[]) => void;
-
-export interface UserDefinedOptions {
-  content: Array<string | RawContent>;
+/**
+ * {@inheritDoc purgecss#UserDefinedOptions}
+ *
+ * @public
+ */
+export type UserDefinedOptions = Omit<
+  PurgeCSSUserDefinedOptions,
+  "css" | "output" | "rejectedCss"
+> & {
   contentFunction?: (sourceFile: string) => Array<string | RawContent>;
-  defaultExtractor?: ExtractorFunction;
-  extractors?: Array<Extractors>;
-  fontFace?: boolean;
-  keyframes?: boolean;
-  output?: string | OutputFunction | boolean;
-  rejected?: boolean;
-  stdin?: boolean;
-  stdout?: boolean;
-  variables?: boolean;
-  safelist?: UserDefinedSafelist;
-  blocklist?: StringRegExpArray;
-  skippedContentGlobs?: Array<string>;
-  dynamicAttributes?: string[];
-
+  output: PurgeCSSUserDefinedOptions["output"] | OutputFunction | boolean;
   insert?: boolean;
   include?: string | RegExp | (string | RegExp)[];
   exclude?: string | RegExp | (string | RegExp)[];
   dest?: string;
-}
+};

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "./../../tsconfig.json",
+  "compilerOptions": {
+      "declaration": true,
+      "outDir": "./lib",
+      "declarationDir": "./.temp/",
+      "baseUrl": ".",
+      "paths": {
+        "purgecss": ["../purgecss/src"],
+      }
+  },
+  "include": ["./src/**/*", "./../purgecss/src/*"],
+  "exclude": ["./lib"]
+}

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/rollup-plugin-purgecss.esm.d.ts

@@ -1,43 +0,0 @@
-import { Plugin } from "rollup";
-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;
-}
-type OutputFunction = (css: string, styles: string[]) => void;
-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 | OutputFunction | boolean;
-  rejected?: boolean;
-  stdin?: boolean;
-  stdout?: boolean;
-  variables?: boolean;
-  safelist?: UserDefinedSafelist;
-  blocklist?: StringRegExpArray;
-  skippedContentGlobs?: Array<string>;
-  dynamicAttributes?: string[];
-  insert?: boolean;
-  include?: string | RegExp | (string | RegExp)[];
-  exclude?: string | RegExp | (string | RegExp)[];
-  dest?: string;
-}
-declare function pluginPurgeCSS(options: UserDefinedOptions$0): Plugin;
-export { pluginPurgeCSS as default };