@fullhuman/postcss-purgecss 7.0.2 → 9.0.0

package/lib/postcss-purgecss.d.ts

@@ -34,8 +34,29 @@ export 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;
 };
@@ -82,7 +103,6 @@ export declare interface Extractors {
  */
 declare const purgeCSSPlugin: postcss.PluginCreator<UserDefinedOptions>;
 export default purgeCSSPlugin;
-export { purgeCSSPlugin }
 
 /**
  * Options used by PurgeCSS to remove unused CSS
@@ -123,7 +143,7 @@ export declare interface PurgeCSSUserDefinedOptions {
     /** {@inheritDoc purgecss#Options.skippedContentGlobs} */
     skippedContentGlobs?: Array<string>;
     /** {@inheritDoc purgecss#Options.dynamicAttributes} */
-    dynamicAttributes?: string[];
+    dynamicAttributes?: StringRegExpArray;
 }
 
 /**
@@ -143,6 +163,12 @@ export 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
  */
 export declare type StringRegExpArray = Array<RegExp | string>;

package/lib/postcss-purgecss.esm.js

@@ -1,5 +1,7 @@
+import * as fs from 'fs';
 import * as path from 'path';
-import { PurgeCSS, defaultOptions, standardizeSafelist, mergeExtractorSelectors } from 'purgecss';
+import { pathToFileURL } from 'url';
+import { PurgeCSS, standardizeSafelist, defaultOptions, mergeExtractorSelectors } from 'purgecss';
 
 /**
  * PostCSS Plugin for PurgeCSS
@@ -20,18 +22,38 @@ const PLUGIN_NAME = "postcss-purgecss";
 async function purgeCSS(opts, root, { result }) {
     const purgeCSS = new PurgeCSS();
     let configFileOptions;
-    try {
-        const t = path.resolve(process.cwd(), "purgecss.config.js");
-        configFileOptions = await import(t);
-    }
-    catch {
-        // no config file present
+    const t = path.resolve(process.cwd(), "purgecss.config.js");
+    // the config file is optional, but an existing one that fails to load
+    // (e.g. a syntax error) is reported instead of being silently ignored
+    if (fs.existsSync(t)) {
+        try {
+            const importedConfig = await import(pathToFileURL(t).href);
+            // Handle both ES modules (direct export) and CommonJS (default export)
+            configFileOptions =
+                importedConfig.default && typeof importedConfig.default === "object"
+                    ? importedConfig.default
+                    : importedConfig;
+        }
+        catch (err) {
+            throw new Error(`Error loading the config file ${t}: ${err}`, {
+                cause: err,
+            });
+        }
     }
+    // the safelists of the config file and of the plugin options add up
+    const configFileSafelist = standardizeSafelist(configFileOptions === null || configFileOptions === void 0 ? void 0 : configFileOptions.safelist);
+    const pluginSafelist = standardizeSafelist(opts === null || opts === void 0 ? void 0 : opts.safelist);
     const options = {
         ...defaultOptions,
         ...configFileOptions,
         ...opts,
-        safelist: standardizeSafelist((opts === null || opts === void 0 ? void 0 : opts.safelist) || (configFileOptions === null || configFileOptions === void 0 ? void 0 : configFileOptions.safelist)),
+        safelist: {
+            standard: [...configFileSafelist.standard, ...pluginSafelist.standard],
+            deep: [...configFileSafelist.deep, ...pluginSafelist.deep],
+            greedy: [...configFileSafelist.greedy, ...pluginSafelist.greedy],
+            keyframes: [...configFileSafelist.keyframes, ...pluginSafelist.keyframes],
+            variables: [...configFileSafelist.variables, ...pluginSafelist.variables],
+        },
     };
     if (opts && typeof opts.contentFunction === "function") {
         options.content = opts.contentFunction((root.source && root.source.input.file) || "");
@@ -86,4 +108,4 @@ const purgeCSSPlugin = function (opts) {
 };
 purgeCSSPlugin.postcss = true;
 
-export { purgeCSSPlugin as default, purgeCSSPlugin };
+export { purgeCSSPlugin as default };

package/lib/postcss-purgecss.js

@@ -1,8 +1,8 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
+var fs = require('fs');
 var path = require('path');
+var url = require('url');
 var purgecss = require('purgecss');
 
 function _interopNamespaceDefault(e) {
@@ -22,6 +22,7 @@ function _interopNamespaceDefault(e) {
     return Object.freeze(n);
 }
 
+var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
 var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
 
 /**
@@ -43,18 +44,38 @@ const PLUGIN_NAME = "postcss-purgecss";
 async function purgeCSS(opts, root, { result }) {
     const purgeCSS = new purgecss.PurgeCSS();
     let configFileOptions;
-    try {
-        const t = path__namespace.resolve(process.cwd(), "purgecss.config.js");
-        configFileOptions = await import(t);
-    }
-    catch {
-        // no config file present
+    const t = path__namespace.resolve(process.cwd(), "purgecss.config.js");
+    // the config file is optional, but an existing one that fails to load
+    // (e.g. a syntax error) is reported instead of being silently ignored
+    if (fs__namespace.existsSync(t)) {
+        try {
+            const importedConfig = await import(url.pathToFileURL(t).href);
+            // Handle both ES modules (direct export) and CommonJS (default export)
+            configFileOptions =
+                importedConfig.default && typeof importedConfig.default === "object"
+                    ? importedConfig.default
+                    : importedConfig;
+        }
+        catch (err) {
+            throw new Error(`Error loading the config file ${t}: ${err}`, {
+                cause: err,
+            });
+        }
     }
+    // the safelists of the config file and of the plugin options add up
+    const configFileSafelist = purgecss.standardizeSafelist(configFileOptions === null || configFileOptions === void 0 ? void 0 : configFileOptions.safelist);
+    const pluginSafelist = purgecss.standardizeSafelist(opts === null || opts === void 0 ? void 0 : opts.safelist);
     const options = {
         ...purgecss.defaultOptions,
         ...configFileOptions,
         ...opts,
-        safelist: purgecss.standardizeSafelist((opts === null || opts === void 0 ? void 0 : opts.safelist) || (configFileOptions === null || configFileOptions === void 0 ? void 0 : configFileOptions.safelist)),
+        safelist: {
+            standard: [...configFileSafelist.standard, ...pluginSafelist.standard],
+            deep: [...configFileSafelist.deep, ...pluginSafelist.deep],
+            greedy: [...configFileSafelist.greedy, ...pluginSafelist.greedy],
+            keyframes: [...configFileSafelist.keyframes, ...pluginSafelist.keyframes],
+            variables: [...configFileSafelist.variables, ...pluginSafelist.variables],
+        },
     };
     if (opts && typeof opts.contentFunction === "function") {
         options.content = opts.contentFunction((root.source && root.source.input.file) || "");
@@ -109,5 +130,4 @@ const purgeCSSPlugin = function (opts) {
 };
 purgeCSSPlugin.postcss = true;
 
-exports.default = purgeCSSPlugin;
-exports.purgeCSSPlugin = purgeCSSPlugin;
+module.exports = purgeCSSPlugin;

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@fullhuman/postcss-purgecss",
-  "version": "7.0.2",
+  "version": "9.0.0",
   "description": "PostCSS plugin for PurgeCSS",
   "author": "FoundrySH <no-reply@foundry.sh>",
   "homepage": "https://purgecss.com",
   "license": "MIT",
+  "engines": {
+    "node": ">=22.12.0"
+  },
   "main": "lib/postcss-purgecss.js",
   "module": "lib/postcss-purgecss.esm.js",
   "types": "lib/postcss-purgecss.d.ts",
@@ -19,18 +22,14 @@
     "type": "git",
     "url": "git+https://github.com/FullHuman/purgecss.git"
   },
-  "scripts": {
-    "build": "ts-node build.ts",
-    "test": "jest"
-  },
   "bugs": {
     "url": "https://github.com/FullHuman/purgecss/issues"
   },
   "dependencies": {
-    "purgecss": "^7.0.2"
+    "purgecss": "^9.0.0"
   },
   "devDependencies": {
-    "postcss": "^8.4.47"
+    "postcss": "^8.5.29"
   },
   "peerDependencies": {
     "postcss": "^8.0.0"
@@ -39,5 +38,8 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "e95398d961e03a809b5e3da75e3dae1813b46b68"
-}
+  "scripts": {
+    "build": "ts-node build.ts",
+    "test": "jest"
+  }
+}