rollup-plugin-purgecss 8.0.0 → 9.0.0

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

@@ -26,8 +26,29 @@ declare type ComplexSafelist = {
      * in the final CSS, even if `child-of-bg` is not found.
      *
      */
-    deep?: RegExp[];
-    greedy?: RegExp[];
+    deep?: StringRegExpArray;
+    /**
+     * You can safelist whole selectors if any part of that selector matches a
+     * pattern with `safelist.greedy`
+     *
+     * @example
+     *
+     * ```ts
+     * const purgecss = await new PurgeCSS().purge({
+     *   content: [],
+     *   css: [],
+     *   safelist: {
+     *     greedy: [/red$/]
+     *   }
+     * })
+     * ```
+     *
+     * In this example, selectors such as `button.bg-red.nonexistent-class`
+     * will be left in the final CSS, even if `button` and `nonexistent-class`
+     * are not found.
+     *
+     */
+    greedy?: StringRegExpArray;
     variables?: StringRegExpArray;
     keyframes?: StringRegExpArray;
 };
@@ -96,6 +117,12 @@ declare interface RawCSS {
 }
 
 /**
+ * Strings and regular expressions an option is matched against. A string
+ * matches a value exactly, except a string written between slashes, like
+ * `"/^btn-/"` or `"/^btn-/i"`, which is parsed as a regular expression. This
+ * form lets configuration files that cannot contain regular expressions, such
+ * as `postcss.config.json`, use patterns.
+ *
  * @public
  */
 declare type StringRegExpArray = Array<RegExp | string>;
@@ -107,7 +134,7 @@ declare type StringRegExpArray = Array<RegExp | string>;
  */
 export declare type UserDefinedOptions = Omit<UserDefinedOptions_2, "css" | "output" | "rejectedCss"> & {
     contentFunction?: (sourceFile: string) => Array<string | RawContent>;
-    output: UserDefinedOptions_2["output"] | OutputFunction | boolean;
+    output?: UserDefinedOptions_2["output"] | OutputFunction | boolean;
     insert?: boolean;
     include?: string | RegExp | (string | RegExp)[];
     exclude?: string | RegExp | (string | RegExp)[];
@@ -153,7 +180,7 @@ declare interface UserDefinedOptions_2 {
     /** {@inheritDoc purgecss#Options.skippedContentGlobs} */
     skippedContentGlobs?: Array<string>;
     /** {@inheritDoc purgecss#Options.dynamicAttributes} */
-    dynamicAttributes?: string[];
+    dynamicAttributes?: StringRegExpArray;
 }
 
 /**

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

@@ -1,6 +1,6 @@
 import * as fs from 'fs';
 import { PurgeCSS } from 'purgecss';
-import { createFilter } from 'rollup-pluginutils';
+import { createFilter } from '@rollup/pluginutils';
 
 /**
  *
@@ -19,7 +19,9 @@ function pluginPurgeCSS(options) {
             if (!filter(id))
                 return null;
             const v = await new PurgeCSS().purge({
-                content: options.content,
+                ...options,
+                // `output` is an option of the plugin, not of PurgeCSS
+                output: undefined,
                 css: [
                     {
                         raw: code,

package/lib/rollup-plugin-purgecss.js

@@ -2,7 +2,7 @@
 
 var fs = require('fs');
 var purgecss = require('purgecss');
-var rollupPluginutils = require('rollup-pluginutils');
+var pluginutils = require('@rollup/pluginutils');
 
 function _interopNamespaceDefault(e) {
     var n = Object.create(null);
@@ -31,7 +31,7 @@ var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
  * @public
  */
 function pluginPurgeCSS(options) {
-    const filter = rollupPluginutils.createFilter(options.include || ["**/*.css"], options.exclude || "node_modules/**");
+    const filter = pluginutils.createFilter(options.include || ["**/*.css"], options.exclude || "node_modules/**");
     const styles = [];
     let dest = "";
     return {
@@ -40,7 +40,9 @@ function pluginPurgeCSS(options) {
             if (!filter(id))
                 return null;
             const v = await new purgecss.PurgeCSS().purge({
-                content: options.content,
+                ...options,
+                // `output` is an option of the plugin, not of PurgeCSS
+                output: undefined,
                 css: [
                     {
                         raw: code,

package/package.json

@@ -1,18 +1,17 @@
 {
   "name": "rollup-plugin-purgecss",
-  "version": "8.0.0",
+  "version": "9.0.0",
   "description": "Rollup plugin for purgecss",
   "main": "lib/rollup-plugin-purgecss.js",
-  "module": "./lib/rollup-plugin-purgecss.es.js",
-  "jsnext:main": "./lib/rollup-plugin-purgecss.es.js",
+  "module": "./lib/rollup-plugin-purgecss.esm.js",
+  "jsnext:main": "./lib/rollup-plugin-purgecss.esm.js",
   "directories": {
     "lib": "lib",
     "test": "__tests__"
   },
-  "scripts": {
-    "build": "ts-node build.ts",
-    "test": "jest"
-  },
+  "files": [
+    "lib"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/FullHuman/purgecss.git"
@@ -26,17 +25,29 @@
   ],
   "author": "Ffloriel",
   "license": "MIT",
+  "engines": {
+    "node": ">=22.12.0"
+  },
   "bugs": {
     "url": "https://github.com/FullHuman/purgecss/issues"
   },
   "homepage": "https://purgecss.com",
   "dependencies": {
-    "purgecss": "^5.0.0",
-    "rollup-pluginutils": "^2.8.0"
+    "@rollup/pluginutils": "^5.4.0",
+    "purgecss": "^9.0.0"
+  },
+  "devDependencies": {
+    "rollup": "^4.66.0"
+  },
+  "peerDependencies": {
+    "rollup": "^3.0.0 || ^4.0.0"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "9269dbc8b589832bab90d29f5821fc4cf55077d6"
-}
+  "scripts": {
+    "build": "ts-node build.ts",
+    "test": "jest"
+  }
+}

package/__tests__/assets/actual_a.css

@@ -1,8 +0,0 @@
-html, body {
-    color: red;
-}
-
-.used, 
-.there {
-    color: green;
-}

package/__tests__/assets/expect_a.css

@@ -1,8 +0,0 @@
-html, body {
-    color: red;
-}
-
-.used, 
-.there {
-    color: green;
-}

package/__tests__/assets/test_a.css

@@ -1,12 +0,0 @@
-html, body {
-    color: red;
-}
-
-.used, 
-.there {
-    color: green;
-}
-
-.unused {
-    color: #ff00ff;
-}

package/__tests__/assets/test_a.html

@@ -1,8 +0,0 @@
-<html>
-    <body>
-        <a href="#">Hello</a>
-        <div class="used"></div>
-        <div id="here"></div>
-        <div class="there"></div>
-    </body>
-</html>

package/__tests__/fixtures/basic/index.js

@@ -1,5 +0,0 @@
-import "../../assets/test_a.css";
-
-export default function noop() {
-  return;
-}

package/__tests__/index.test.ts

@@ -1,27 +0,0 @@
-import * as fs from "fs";
-import * as path from "path";
-import { rollup } from "rollup";
-import purgecss from "./../src/";
-
-describe("rollup-plugin-purgecss", () => {
-  it("remove unused css", async () => {
-    const bundle = await rollup({
-      input: path.resolve(__dirname, "fixtures/basic/index.js"),
-      plugins: [
-        purgecss({
-          content: [path.resolve(__dirname, "assets/test_a.html")],
-          output: path.resolve(__dirname, "assets/actual_a.css"),
-        }),
-      ],
-    });
-    await bundle.generate({ format: "cjs", exports: "auto" });
-
-    const actualA = fs
-      .readFileSync(path.resolve(__dirname, "assets/actual_a.css"))
-      .toString();
-    const expectA = fs
-      .readFileSync(path.resolve(__dirname, "assets/expect_a.css"))
-      .toString();
-    expect(actualA).toEqual(expectA);
-  });
-});

package/build.ts

@@ -1,25 +0,0 @@
-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

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

package/src/index.ts

@@ -1,80 +0,0 @@
-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/**",
-  );
-
-  const styles: string[] = [];
-  let dest = "";
-
-  return {
-    name: "purgecss",
-    transform: async (code, id) => {
-      if (!filter(id)) return null;
-
-      const v = await new PurgeCSS().purge({
-        content: options.content,
-        css: [
-          {
-            raw: code,
-          },
-        ],
-      });
-      let css = v[0].css;
-
-      styles.push(css);
-
-      css = JSON.stringify(css);
-      if (options.insert) {
-        // do thing
-      } else if (!options.output) {
-        code = css;
-      } else {
-        code = `"";`;
-      }
-
-      return {
-        code: `export default ${code}`,
-        map: { mappings: "" },
-      };
-    },
-    generateBundle() {
-      if (!options.insert && (!styles.length || options.output === false)) {
-        return;
-      }
-      const css = styles.reduce((acc, value) => {
-        return acc + value;
-      }, "");
-      if (typeof options.output === "string") {
-        return fs.writeFileSync(options.output, css);
-      }
-      if (typeof options.output === "function") {
-        return options.output(css, styles);
-      }
-      if (!options.insert && dest) {
-        if (dest.endsWith(".js") || dest.endsWith(".ts")) {
-          dest = dest.slice(0, -3);
-        }
-        dest = `${dest}.css`;
-        return fs.writeFileSync(dest, css);
-      }
-    },
-  };
-}
-
-export default pluginPurgeCSS;

package/src/types/index.ts

@@ -1,26 +0,0 @@
-import type {
-  RawContent,
-  UserDefinedOptions as PurgeCSSUserDefinedOptions,
-} from "purgecss";
-
-/**
- * @public
- */
-export type OutputFunction = (css: string, styles: string[]) => void;
-
-/**
- * {@inheritDoc purgecss#UserDefinedOptions}
- *
- * @public
- */
-export type UserDefinedOptions = Omit<
-  PurgeCSSUserDefinedOptions,
-  "css" | "output" | "rejectedCss"
-> & {
-  contentFunction?: (sourceFile: string) => Array<string | RawContent>;
-  output: PurgeCSSUserDefinedOptions["output"] | OutputFunction | boolean;
-  insert?: boolean;
-  include?: string | RegExp | (string | RegExp)[];
-  exclude?: string | RegExp | (string | RegExp)[];
-  dest?: string;
-};

package/tsconfig.json

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