compress-shader-literals 1.0.1 → 1.1.3

package/README.md

@@ -9,61 +9,39 @@
 [![npm downloads](https://img.shields.io/npm/dm/compress-shader-literals?color=success)](https://www.npmjs.com/package/compress-shader-literals)
 [![license](https://img.shields.io/npm/l/compress-shader-literals?color=blue)](./LICENSE)
 
-Your shaders ship to users as strings. This strips the comments and whitespace out of them at build time, before your bundler ever sees them — in any bundler.
+A build-time minifier that strips comments and whitespace from GLSL & WGSL shaders written as template literals in your JS/TS — in any bundler, with no renaming, no toolchain, and no runtime cost.
 
 ![Alt Preview](./assets/preview.png)
 
-## Stats
-
-Measured on the real shaders shipped by popular libraries:
-
-<!-- STATS:START -->
-
-| Package               | Shaders |    Before |     After |     Saved |
-| --------------------- | ------: | --------: | --------: | --------: |
-| `three`               |     281 | 240,772 B | 203,428 B | **15.5%** |
-| `@jayf0x/fluidity-js` |       9 |  11,095 B |   7,788 B | **29.8%** |
-| `ogl`                 |      22 |   6,109 B |   5,335 B | **12.7%** |
-| `shader-park-core`    |      18 |  10,794 B |   9,033 B | **16.3%** |
-| `curtainsjs`          |       7 |   3,406 B |   2,563 B | **24.8%** |
-| **Total**             |     337 | 272,176 B | 228,147 B | **16.2%** |
-
-_Auto-generated by [`tests/e2e.js`](tests/e2e.js) · packages [verified](tests/validate.js) loadable · 2026-06-28_
-
-<!-- STATS:END -->
-
-<!-- <a href="https://star-history.com/#jayf0x/compress-shader-literals&Date">
-  <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=jayf0x/compress-shader-literals&type=Date&theme=dark&legend=top-left" />
-    <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=jayf0x/compress-shader-literals&type=Date&legend=top-left" />
-    <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=jayf0x/compress-shader-literals&type=Date&legend=top-left" />
-  </picture>
-</a> -->
-
 ## Install
 
 ```sh
-npm i -D compress-shader-literals
-# or: bun add -d compress-shader-literals
+bun add -d compress-shader-literals
+# or: npm i -D compress-shader-literals
 ```
 
+## About
+
+Shader comments and indentation are dead weight in the bundle — the GPU ignores them, the browser still downloads them. This strips them at build time.
+
+- Removes comments, collapses whitespace. Nothing else.
+- No renaming, no dead-code removal — output stays valid and readable.
+- Runs before your bundler's own minifier.
+
 ## Usage
 
-Pick your bundler — same plugin, same options:
+One [unplugin](https://github.com/unjs/unplugin) plugin, same API for every bundler:
 
 ```js
 import { compressShaderLiterals } from 'compress-shader-literals';
 
-// Vite        vite.config.js
+// vite.config.js
 export default { plugins: [compressShaderLiterals.vite({ outputRatio: true })] };
-
-// Rollup      rollup.config.js   →  compressShaderLiterals.rollup({ ... })
-// webpack     webpack.config.js  →  compressShaderLiterals.webpack({ ... })
-// esbuild     build script       →  compressShaderLiterals.esbuild({ ... })
-// Rspack / Rolldown / Farm       →  .rspack() / .rolldown() / .farm()
 ```
 
-It finds tagged and comment-prefixed literals — and yes, the comment form keeps your editor's syntax highlighting:
+For Rollup, webpack, esbuild, Rspack, Rolldown or Farm, call the matching method — `.rollup()`, `.webpack()`, `.esbuild()`, `.rspack()`, `.rolldown()`, `.farm()` — with the same options.
+
+Finds tagged and comment-prefixed literals. The comment form keeps editor syntax highlighting:
 
 ```ts
 const vert = glsl`
@@ -78,18 +56,16 @@ const frag = /* wgsl */ `
 `;
 ```
 
-Both collapse to a single tight line. No comments, no padding, no touched source files.
-
 **Options**
 
-| Option        | Default                      | Description                                        |
-| ------------- | ---------------------------- | -------------------------------------------------- |
-| `tags`        | `['glsl', 'wgsl', 'shader']` | Tag names / comment markers to match               |
-| `include`     | `[/\.[jt]sx?$/]`             | Files to process                                   |
-| `exclude`     | `[/node_modules/, /dist/]`   | Files to skip                                      |
-| `outputRatio` | `false`                      | Print a bytes-saved summary after build            |
-| `transform`   | built-in `minifyShader`      | Custom minifier — `(shader: string) => string`     |
-| `debug`       | `false`                      | Log each file's discovered literals to the console |
+| Option        | Default                      | Description                                         |
+| ------------- | ---------------------------- | --------------------------------------------------- |
+| `tags`        | `['glsl', 'wgsl', 'shader']` | Tag names / comment markers to match                |
+| `include`     | `[/\.[mc]?[jt]sx?$/]`        | Files to process — the JS/TS family Babel can parse |
+| `exclude`     | `[/node_modules/, /dist/]`   | Files to skip — dependencies are skipped by default |
+| `outputRatio` | `false`                      | Print a bytes-saved summary after build             |
+| `transform`   | built-in `minifyShader`      | Custom minifier — `(shader: string) => string`      |
+| `debug`       | `false`                      | Log each file's discovered literals to the console  |
 
 **Programmatic API** — the two core helpers are exported for tooling authors (validators, ESLint rules, CLIs), no plugin required:
 
@@ -102,16 +78,31 @@ extractShaderLiterals('const v = glsl`void main() {}`');
 minifyShader('// comment\nvoid  main() {}'); // → 'void main() {}'
 ```
 
-## How it works
+## Stats
+
+Real shaders shipped by popular libraries, run through the built-in minifier:
 
-Nothing clever, which is the point:
+<!-- STATS:START -->
+
+| Package            | Shaders |    Before |     After |     Saved |
+| ------------------ | ------: | --------: | --------: | --------: |
+| `three`            |     281 | 240,772 B | 203,428 B | **15.5%** |
+| `ogl`              |      22 |   6,109 B |   5,335 B | **12.7%** |
+| `shader-park-core` |      18 |  10,794 B |   9,033 B | **16.3%** |
+| `curtainsjs`       |       7 |   3,406 B |   2,563 B | **24.8%** |
+| **Total**          |     328 | 261,081 B | 220,359 B | **15.6%** |
+
+_328 shaders · 303/303 parseable GLSL verified valid after minify · [how this is measured](docs/stats.md) · 2026-06-29_
 
-1. Parses each matched file with Babel (TS/JSX aware).
-2. Finds tagged and comment-prefixed shader literals.
-3. Strips comments + collapses whitespace via [`magic-string`](https://github.com/Rich-Harris/magic-string), so **sourcemaps stay intact**.
-4. Runs as a `pre` transform, so your bundler's own minifier still sees the result.
+<!-- STATS:END -->
+
+## How it works
 
-One [unplugin](https://github.com/unjs/unplugin) covers **Vite, Rollup, webpack, esbuild, Rspack, Rolldown & Farm**.
+1. Parses each matched file with Babel — `.js`, `.jsx`, `.ts`, `.tsx`, `.mjs`, `.cjs`, `.mts`, `.cts` (not `.vue`/`.svelte`/`.glsl`, which aren't whole-file JS).
+2. Finds tagged (`` glsl`…` ``) and comment-prefixed (`/* glsl */ \`…\``) literals, skipping any with `${…}` interpolation.
+3. Strips comments and collapses each run of whitespace to a single space or newline — never to nothing, so adjacent tokens stay separated and `#version`/`#define` lines survive.
+4. Rewrites the literal in place with [magic-string](https://github.com/Rich-Harris/magic-string), so sourcemaps stay intact.
+5. Runs as a `pre` transform, so your bundler's own minifier still sees the result.
 
 ## Issues & compatibility
 

package/dist/index.cjs

@@ -1,3 +1,3 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));let c=require("@rollup/pluginutils"),l=require("byte-snap"),u=require("magic-string");u=s(u,1);let d=require("unplugin"),f=require("@babel/parser"),p=require("@babel/traverse");p=s(p,1);var m=[`glsl`,`wgsl`,`shader`],h=[/\.[jt]sx?$/],g=[/node_modules/,/dist/],_=e=>RegExp(`^\\s*(${e.join(`|`)})\\s*$`),v=p.default.default||p.default,y=(e,t=m)=>{let n=new Set(t),r=_(t),i=[];try{v((0,f.parse)(e,{sourceType:`module`,plugins:[`typescript`,`jsx`,`decorators-legacy`],allowReturnOutsideFunction:!0}),{TaggedTemplateExpression(e){let{tag:t,quasi:r}=e.node,a=null;t.type===`Identifier`&&n.has(t.name)?a=t.name:t.type===`MemberExpression`&&t.property.type===`Identifier`&&n.has(t.property.name)&&(a=t.property.name),a&&r.expressions.length===0&&i.push({tag:a,value:r.quasis[0].value.raw,start:r.start,end:r.end})},TemplateLiteral(e){let t=e.node;if(t.expressions.length>0)return;let n=t.leadingComments||e.parentPath?.node?.leadingComments||[];for(let e of n){if(!e||e.type!==`CommentBlock`)continue;let n=e.value.match(r);if(n){i.push({tag:n[1],value:t.quasis[0].value.raw,start:t.start,end:t.end});break}}}})}catch(e){if(e.name!==`SyntaxError`)throw e}return i},b=e=>e.replace(/\r\n/g,`
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));let c=require("@rollup/pluginutils"),l=require("byte-snap"),u=require("magic-string");u=s(u,1);let d=require("unplugin"),f=require("@babel/parser"),p=require("@babel/traverse");p=s(p,1);var m=[`glsl`,`wgsl`,`shader`],h=[/\.[mc]?[jt]sx?$/],g=[/node_modules/,/dist/],_=e=>RegExp(`^\\s*(${e.join(`|`)})\\s*$`),v=p.default.default||p.default,y=(e,t=m)=>{let n=new Set(t),r=_(t),i=[];try{v((0,f.parse)(e,{sourceType:`module`,plugins:[`typescript`,`jsx`,`decorators-legacy`],allowReturnOutsideFunction:!0}),{TaggedTemplateExpression(e){let{tag:t,quasi:r}=e.node,a=null;t.type===`Identifier`&&n.has(t.name)?a=t.name:t.type===`MemberExpression`&&t.property.type===`Identifier`&&n.has(t.property.name)&&(a=t.property.name),a&&r.expressions.length===0&&i.push({tag:a,value:r.quasis[0].value.raw,start:r.start,end:r.end})},TemplateLiteral(e){let t=e.node;if(t.expressions.length>0)return;let n=t.leadingComments||e.parentPath?.node?.leadingComments||[];for(let e of n){if(!e||e.type!==`CommentBlock`)continue;let n=e.value.match(r);if(n){i.push({tag:n[1],value:t.quasis[0].value.raw,start:t.start,end:t.end});break}}}})}catch(e){if(e.name!==`SyntaxError`)throw e}return i},b=e=>e.replace(/\r\n/g,`
 `).replace(/\/\*[\s\S]*?\*\//g,``).replace(/\/\/.*$/gm,``).replace(/[ \t]+/g,` `).replace(/\n{2,}/g,`
 `).trim(),x=(0,d.createUnplugin)((e={})=>{let t=e.tags||m,n=e.transform||b,r=(0,c.createFilter)(e.include||h,e.exclude||g),i=``,a=``;return{name:`compress-shader-literals`,enforce:`pre`,transform(o,s){if(!r(s)||!t.some(e=>o.includes(e)))return null;let c=y(o,t);if(c.length===0)return null;e.debug&&console.log(`[compress-shader-literals] ${s}: ${c.length} literal(s) — ${c.map(e=>e.tag).join(`, `)}`);let l=new u.default(o),d=!1;for(let t of c){let r=n(t.value);t.value!==r&&(l.overwrite(t.start,t.end,`\`${r}\``),d=!0),e.outputRatio&&(i+=t.value,a+=r)}return d?{code:l.toString(),map:l.generateMap({hires:!0,source:s})}:null},buildEnd(){e.outputRatio&&i&&(0,l.diff)(l.snap.text(i),l.snap.text(a)).print()}}});exports.compressShaderLiterals=x,exports.extractShaderLiterals=y,exports.minifyShader=b;

package/dist/index.d.ts

@@ -6,7 +6,7 @@ type FilterPattern = string | RegExp | ReadonlyArray<string | RegExp> | null;
 export interface CompressShaderLiteralsOptions {
   /** Tag names / comment markers to match. Default: `['glsl', 'wgsl', 'shader']` */
   tags?: string[];
-  /** Files to process. Default: `[/\.[jt]sx?$/]` */
+  /** Files to process. Default: `[/\.[mc]?[jt]sx?$/]` (the JS/TS family Babel can parse). */
   include?: FilterPattern;
   /** Files to skip. Default: `[/node_modules/, /dist/]` */
   exclude?: FilterPattern;

package/dist/index.js

@@ -9,7 +9,7 @@ var s = [
 	"glsl",
 	"wgsl",
 	"shader"
-], c = [/\.[jt]sx?$/], l = [/node_modules/, /dist/], u = (e) => RegExp(`^\\s*(${e.join("|")})\\s*$`), d = o.default || o, f = (e, t = s) => {
+], c = [/\.[mc]?[jt]sx?$/], l = [/node_modules/, /dist/], u = (e) => RegExp(`^\\s*(${e.join("|")})\\s*$`), d = o.default || o, f = (e, t = s) => {
 	let n = new Set(t), r = u(t), i = [];
 	try {
 		d(a(e, {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "compress-shader-literals",
-  "version": "1.0.1",
+  "version": "1.1.3",
   "type": "module",
-  "description": "Size matters. Minify GLSL/WGSL shader template literals at build time — universal plugin for Vite, Rollup, webpack, esbuild & more.",
+  "description": "Minify GLSL/WGSL shaders in your JS/TS at build time. Drop-in plugin for Vite, Rollup, webpack, esbuild, Rspack, Rolldown & Farm.",
   "keywords": [
     "shader",
     "glsl",