astro-purgecss 3.1.0 → 3.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Codiume
+
+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/README.md

@@ -15,25 +15,34 @@
 the `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren’t sure which package manager you’re using, run the first command.) Then, follow the prompts, and type “y” in the terminal (meaning “yes”) for each one.
 
 ```bash
+# Using PNPM
+pnpm astro add astro-purgecss
 # Using NPM
 npx astro add astro-purgecss
 # Using Yarn
 yarn astro add astro-purgecss
-# Using PNPM
-pnpm astro add astro-purgecss
 ```
 
 ### Manual Install
 
-First, install the `astro-purgecss` package using your package manager. (If you aren’t sure which package manager you’re using, run the first command.)
+First, install the `purgecss` & `astro-purgecss` packages using your package manager. (If you aren’t sure which package manager you’re using, run the first command.)
+
+Using PNPM
 
 ```bash
-# Using NPM
-npm install astro-purgecss
-# Using Yarn
-yarn add astro-purgecss
-# Using PNPM
-pnpm install astro-purgecss
+pnpm install purgecss astro-purgecss
+```
+
+Using NPM
+
+```bash
+npm install purgecss astro-purgecss
+```
+
+Using Yarn
+
+```bash
+yarn add purgecss astro-purgecss
 ```
 
 Then, apply this integration to your `astro.config.mjs` file using the integrations property:
@@ -105,6 +114,8 @@ We have also setup an example repository available here: [example-purgecss](../.
 
 - Some options 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 [inline styles](https://docs.astro.build/en/guides/styling/#scoped-styles), this plugin won't be able to purge those css rules, due to astro's way of handling scoped css rules.
+
 - 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

package/package.json

@@ -1,13 +1,7 @@
 {
   "name": "astro-purgecss",
   "description": "Remove unused CSS rules from your final Astro bundle",
-  "version": "3.1.0",
-  "scripts": {
-    "build": "astro-build --src src/index.ts",
-    "postbuild": "npm run typecheck:emit",
-    "typecheck": "tsc --noEmit",
-    "typecheck:emit": "tsc --declaration --emitDeclarationOnly"
-  },
+  "version": "3.2.0",
   "type": "module",
   "types": "dist/index.d.ts",
   "author": "codiume",
@@ -38,10 +32,17 @@
       }
     }
   },
-  "dependencies": {
-    "purgecss": "^5.0.0"
+  "devDependencies": {
+    "astro-build": "1.0.0"
   },
   "peerDependencies": {
-    "astro": "^3.0.0"
+    "astro": "^3.0.0",
+    "purgecss": "^5.0.0"
+  },
+  "scripts": {
+    "build": "astro-build --src src/index.ts",
+    "postbuild": "npm run typecheck:emit",
+    "typecheck": "tsc --noEmit",
+    "typecheck:emit": "tsc --declaration --emitDeclarationOnly"
   }
-}
+}

package/dist/index.d.ts

@@ -1,13 +0,0 @@
-import type { AstroIntegration } from 'astro';
-import { type RawContent, type StringRegExpArray, type UserDefinedSafelist } from 'purgecss';
-export type PurgeCSSOptions = {
-    fontFace?: boolean;
-    keyframes?: boolean;
-    rejected?: boolean;
-    rejectedCss?: boolean;
-    variables?: boolean;
-    safelist?: UserDefinedSafelist;
-    blocklist?: StringRegExpArray;
-    content?: Array<string | RawContent>;
-};
-export default function (options?: PurgeCSSOptions): AstroIntegration;