astro-purgecss 1.0.0 → 1.1.1

package/README.md

@@ -56,13 +56,50 @@ export default {
 
 When you install this integration, things will be auto-wired for you. and all your generated css files should be purged from unused classes automagically.
 
-## What does this integration do, exactly?
+## 📖 Configuration
 
-This integration hooks into your astro build cycle, more precisely `astro:build:done`, it reads all your generated `HTML` and `CSS` files, and analyzes them using [Purgecss][purgecss] to remove any unsued CSS rules.
+[PurgeCSS][purgecss] has a list of options that allow you to customize its behavior. And this Astro integration allow you to pass those options easily in your `astro.config.mjs` file:
 
-## Change log
+```js
+export default defineConfig({
+  integrations: [
+    purgecss({
+      fontFace: true,
+      keyframes: true,
+      safelist: ['random', 'yep', 'button', /^nav-/],
+      blocklist: ['usedClass', /^nav-/]
+    })
+  ]
+});
+```
+
+### Available Options
+
+Here is a list of options, that are allowed to be passed in the config:
+
+```ts
+export type PurgeCSSOptions = {
+  fontFace?: boolean; // removes any unused @font-face if set to true
+  keyframes?: boolean; // removes unused keyframes by setting if set to true
+  rejected?: boolean; // scan through the removed list to see if there's anything wrong
+  rejectedCss?: boolean; // keeps the discarded CSS
+  variables?: boolean; // removes any unused CSS variables if set to true
+  safelist?: UserDefinedSafelist; // indicates which selectors are safe to leave in the final CSS
+  blocklist?: StringRegExpArray; // blocks the CSS selectors from appearing in the final output CSS
+};
+```
+
+To learn more about the available options, please refer to [PurgeCSS][purgecss-options] official docs.
+
+### Caveats
+
+- Certain options (ex: `css`, `content`), are not allowed to be passed in your `astro.config.mjs` config file, to not interfere with the internals of this integration.
+
+- If you are using `tailwind.css`, please read about purge limitations in this guide [writing-purgeable-html](https://v2.tailwindcss.com/docs/optimizing-for-production#writing-purgeable-html)
+
+## Changelog
 
-Please see the [changelog](CHANGELOG.md) for more information on what has changed recently.
+Please see the [Changelog](CHANGELOG.md) for more information on what has changed recently.
 
 ## Acknowledgements
 
@@ -70,6 +107,7 @@ Please see the [changelog](CHANGELOG.md) for more information on what has change
 
 [npm]: https://npmjs.com/package/astro-purgecss
 [purgecss]: https://purgecss.com
+[purgecss-options]: https://purgecss.com/configuration.html#options
 
 <!-- Readme Badges -->
 

package/dist/index.d.ts

@@ -1,2 +1,12 @@
 import type { AstroIntegration } from 'astro';
-export default function (): AstroIntegration;
+import { StringRegExpArray, UserDefinedSafelist } from 'purgecss';
+export declare type PurgeCSSOptions = {
+    fontFace?: boolean;
+    keyframes?: boolean;
+    rejected?: boolean;
+    rejectedCss?: boolean;
+    variables?: boolean;
+    safelist?: UserDefinedSafelist;
+    blocklist?: StringRegExpArray;
+};
+export default function (options?: PurgeCSSOptions): AstroIntegration;

package/dist/index.mjs

@@ -1,15 +1,17 @@
 import { PurgeCSS } from "purgecss";
 import { writeFile } from "node:fs/promises";
 import { fileURLToPath } from "node:url";
-function src_default() {
+function src_default(options = {}) {
   return {
     name: "astro-purgecss",
     hooks: {
       "astro:build:done": async ({ dir }) => {
         const outDir = fileURLToPath(dir);
         const purged = await new PurgeCSS().purge({
+          ...options,
           content: [`${outDir}/**/*.html`],
-          css: [`${outDir}/**/*.css`]
+          css: [`${outDir}/**/*.css`],
+          defaultExtractor: (content) => content.match(/[\w-/:]+(?<!:)/g) || []
         });
         await Promise.all(
           purged.filter(({ file }) => file.endsWith(".css")).map(async ({ css, file }) => await writeFile(file, css))

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "astro-purgecss",
   "description": "Remove unused CSS rules from your final Astro bundle",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "scripts": {
     "build": "astro-build --src src/**/*.ts",
     "postbuild": "npm run typecheck:emit",
@@ -33,10 +33,10 @@
   "exports": {
     ".": "./dist/index.mjs"
   },
+  "dependencies": {
+    "purgecss": "^4.1.3"
+  },
   "peerDependencies": {
     "astro": "^1.0.0"
-  },
-  "devDependencies": {
-    "purgecss": "^4.1.3"
   }
 }