@visulima/packem-rollup 1.0.0-alpha.7 → 1.0.0-alpha.70

package/README.md

@@ -41,6 +41,93 @@ pnpm add @visulima/packem-rollup
 
 ## Usage
 
+### Data URI Plugin
+
+The `dataUriPlugin` converts files to data URIs for inline embedding. It supports configurable SVG encoding strategies via query parameters.
+
+```typescript
+import { dataUriPlugin } from "@visulima/packem-rollup";
+
+export default {
+    plugins: [dataUriPlugin()],
+};
+```
+
+#### Query Parameters
+
+- `?data-uri` - Basic data URI conversion
+- `?data-uri&encoding=css` - Use CSS-optimized SVG encoding
+- `?data-uri&encoding=tiny` - Use tiny SVG encoding (default)
+- `?data-uri&srcset` - Encode spaces as %20 for srcset compatibility
+
+#### Examples
+
+```typescript
+// Tiny SVG encoding (default)
+import icon from "./icon.svg?data-uri";
+
+// CSS-optimized SVG encoding
+import icon from "./icon.svg?data-uri&encoding=css";
+
+// Tiny SVG with srcset compatibility
+import icon from "./icon.svg?data-uri&srcset";
+
+// CSS encoding with srcset compatibility
+import icon from "./icon.svg?data-uri&encoding=css&srcset";
+```
+
+### Lazy Barrel Plugin
+
+The `lazyBarrelPlugin` implements lazy barrel optimization similar to Rspack's `lazyBarrel` experiment. It identifies side-effect-free barrel files and marks their re-export dependencies as lazy, only building them when their exports are actually requested.
+
+```typescript
+import { lazyBarrelPlugin } from "@visulima/packem-rollup";
+
+export default {
+    plugins: [
+        lazyBarrelPlugin({
+            sideEffectsCheck: true,
+            lazyThreshold: 2,
+            include: [/\.ts$/, /\.js$/],
+            exclude: [/\.test\.ts$/],
+        }),
+    ],
+};
+```
+
+#### Features
+
+- **Barrel Detection**: Automatically identifies files with multiple re-exports
+- **Side Effects Checking**: Reads package.json to check `sideEffects` field
+- **Lazy Loading**: Generates lazy loading code for unused exports
+- **Configurable Threshold**: Set minimum exports to consider a file as a barrel
+- **Filtering**: Include/exclude specific file patterns
+
+#### How It Works
+
+1. **Analysis**: Parses module code to detect barrel export patterns
+2. **Side Effects Check**: Verifies if the module is marked as side-effect-free
+3. **Lazy Marking**: Marks re-export dependencies as lazy for deferred building
+4. **Code Generation**: Creates lazy loading wrappers for unused exports
+5. **Optimization**: Only builds modules when their exports are actually requested
+
+### URL Plugin
+
+The `urlPlugin` handles asset URLs, either inlining them as data URIs or copying them to a destination directory. SVG files are optimized using the shared `svgEncoder` utility before being base64 encoded.
+
+```typescript
+import { urlPlugin } from "@visulima/packem-rollup";
+
+export default {
+    plugins: [
+        urlPlugin({
+            limit: 14336, // 14kb
+            fileName: "[hash][extname]",
+        }),
+    ],
+};
+```
+
 ## Related
 
 ## Supported Node.js Versions
@@ -56,8 +143,8 @@ If you would like to help take a look at the [list of issues](https://github.com
 
 ## Credits
 
--   [Daniel Bannert](https://github.com/prisis)
--   [All Contributors](https://github.com/visulima/packem/graphs/contributors)
+- [Daniel Bannert](https://github.com/prisis)
+- [All Contributors](https://github.com/visulima/packem/graphs/contributors)
 
 ## License