wgslmin-wasm

WGSL minifier for WebGPU shaders - WebAssembly build.

This package provides a WASM build of the wgsl-minifier that runs in browsers and Node.js.

Installation

``bash
npm install wgslmin-wasm
`

Browser Usage

`html



`

$3

`javascript
import { initialize, minify } from 'wgslmin-wasm';

await initialize({ wasmURL: '/path/to/wgslmin.wasm' });

const result = minify(source, {
minifyWhitespace: true,
minifyIdentifiers: true,
minifySyntax: true,
});
`

Node.js Usage

`javascript
const { initialize, minify } = require('wgslmin-wasm');

await initialize(); // Automatically finds wgslmin.wasm

const result = minify(source);
console.log(result.code);
`

API

$3

Initialize the WASM module. Must be called before minify().

`typescript
interface InitializeOptions {
wasmURL?: string | URL; // Path or URL to wgslmin.wasm
wasmModule?: WebAssembly.Module; // Pre-compiled module
}
`

$3

Minify WGSL source code.

`typescript
interface MinifyOptions {
minifyWhitespace?: boolean; // Remove whitespace (default: true)
minifyIdentifiers?: boolean; // Rename identifiers (default: true)
minifySyntax?: boolean; // Optimize syntax (default: true)
mangleExternalBindings?: boolean; // Mangle uniform/storage names (default: false)
keepNames?: string[]; // Names to preserve from renaming
}

interface MinifyResult {
code: string; // Minified code
errors: MinifyError[]; // Parse/minification errors
originalSize: number; // Input size in bytes
minifiedSize: number; // Output size in bytes
}
`

$3

Returns true if the WASM module is initialized.

$3

The version of the minifier.

Options

$3

Remove unnecessary whitespace and newlines.

$3

Rename local variables, function parameters, and helper functions to shorter names. Entry points and API-facing declarations are preserved.

$3

Apply syntax-level optimizations like numeric literal shortening.

$3

Control how var and var names are handled:

- false (default): Original names are preserved in declarations, short aliases are used internally. This maintains compatibility with WebGPU's binding reflection APIs.
- true: Names are mangled directly for smaller output, but breaks binding reflection.

`javascript
// Input
const shader =
@group(0) @binding(0) var uniforms: f32;
fn getValue() -> f32 { return uniforms * 2.0; }
;

// With mangleExternalBindings: false (default)
// Output: "@group(0) @binding(0) var uniforms:f32;let a=uniforms;fn b()->f32{return a*2.0;}"

// With mangleExternalBindings: true
// Output: "@group(0) @binding(0) var a:f32;fn b()->f32{return a*2.0;}"
`

$3

Array of identifier names that should not be renamed:

`javascript
minify(source, {
minifyIdentifiers: true,
keepNames: ['myHelper', 'computeValue'],
});
`

Using with Bundlers

$3

`javascript
import { initialize, minify } from 'wgslmin-wasm';
import wasmURL from 'wgslmin-wasm/wgslmin.wasm?url';

await initialize({ wasmURL });
`

$3

`javascript
import { initialize, minify } from 'wgslmin-wasm';

// Configure webpack to handle .wasm files
await initialize({ wasmURL: new URL('wgslmin-wasm/wgslmin.wasm', import.meta.url) });
`

Pre-compiling WASM

For better performance when creating multiple instances:

`javascript
const wasmModule = await WebAssembly.compileStreaming(
fetch('/wgslmin.wasm')
);

// Share module across workers
await initialize({ wasmModule });
``

Performance

- WASM binary: ~3.6MB
- Initialization: ~100ms (first load)
- Transform: <1ms for typical shaders

License

MIT