un-ts
diff --git a/Collapse file
‎.changeset/witty-actors-dress.md‎
Copy file name to clipboard
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff b/Collapse file
‎.changeset/witty-actors-dress.md‎
Copy file name to clipboard
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
diff --git a/Collapse file
‎README.md‎
Copy file name to clipboard
+33-22Lines changed: 33 additions & 22 deletions
Display the source diff
Display the rich diff b/Collapse file
‎README.md‎
Copy file name to clipboard
+33-22Lines changed: 33 additions & 22 deletions
Display the source diff
Display the rich diff
diff --git a/Collapse file
‎benchmark/benchmark.txt‎
Copy file name to clipboard
+17-17Lines changed: 17 additions & 17 deletions b/Collapse file
‎benchmark/benchmark.txt‎
Copy file name to clipboard
+17-17Lines changed: 17 additions & 17 deletions
diff --git a/Collapse file
‎eslint.config.js‎
Copy file name to clipboard
+6Lines changed: 6 additions & 0 deletions b/Collapse file
‎eslint.config.js‎
Copy file name to clipboard
+6Lines changed: 6 additions & 0 deletions
diff --git a/Collapse file
‎main.wasm‎
Copy file name to clipboard
0 Bytes b/Collapse file
‎main.wasm‎
Copy file name to clipboard
0 Bytes
diff --git a/Collapse file
‎package.json‎
Copy file name to clipboard
+4Lines changed: 4 additions & 0 deletions b/Collapse file
‎package.json‎
Copy file name to clipboard
+4Lines changed: 4 additions & 0 deletions
diff --git a/Collapse file
‎src/processor.ts‎
Copy file name to clipboard
+39-15Lines changed: 39 additions & 15 deletions b/Collapse file
‎src/processor.ts‎
Copy file name to clipboard
+39-15Lines changed: 39 additions & 15 deletions
diff --git a/Collapse file
‎target.json‎
Copy file name to clipboard
+1-1Lines changed: 1 addition & 1 deletion b/Collapse file
‎target.json‎
Copy file name to clipboard
+1-1Lines changed: 1 addition & 1 deletion
@@ -0,0 +1,5 @@
+---
+"sh-syntax": patch
+---
+
+feat: support more ways to load `wasm` on browser
@@ -20,6 +20,8 @@ A WASM shell parser and formatter with bash support, based on [mvdan/sh](https:/
 - [Usage](#usage)
   - [Install](#install)
   - [API](#api)
+    - [node](#node)
+    - [browser](#browser)
 - [Benchmark](#benchmark)
 - [Sponsors](#sponsors)
 - [Backers](#backers)
@@ -40,8 +42,9 @@ npm i sh-syntax
 
 ### API
 
+#### node
+
 ```js
-// node
 import { parse, print } from 'sh-syntax'
 
 const text = "echo 'Hello World!'"
@@ -52,14 +55,22 @@ const newText = await print(ast, {
 })
 ```
 
+#### browser
+
 ```js
-// browser
 import { getProcessor } from 'sh-syntax'
 
+// choose your own way to load the WASM file
+
+// with `fetch`
 const processor = getProcessor(() =>
-  fetch('sh-syntax/main.wasm').then(res => res.arrayBuffer()),
+  fetch('https://cdn.jsdelivr.net/npm/sh-syntax@latest/main.wasm'),
 )
 
+// with `wasm?init` via `vite`
+import initWasm from 'sh-syntax/wasm?init'
+const processor = getProcessor(initWasm)
+
 const parse = (text, options) => processor(text, options)
 
 const print = (textOrAst, options) => {
@@ -81,34 +92,34 @@ const newText = await print(ast, { originalText: text })
 ## Benchmark
 
 ```console
-clk: ~3.10 GHz
+clk: ~2.81 GHz
 cpu: Apple M1 Max
 runtime: node 18.20.8 (arm64-darwin)
 
 benchmark                   avg (min … max) p75 / p99    (min … top 1%)
 ------------------------------------------- -------------------------------
-sh-syntax                     36.97 ms/iter  37.32 ms     █
-                      (36.50 ms … 37.53 ms)  37.38 ms █   █              ██
-                    (601.05 kb … 711.16 kb) 641.13 kb █▁▁██▁▁▁█▁▁██▁█▁▁▁▁██
-                  4.88 ipc (  0.63% stalls)  99.64% L1 data cache
-        118.27M cycles 577.63M instructions  38.24% retired LD/ST (220.90M)
-
-sh-syntax (synckit)           37.13 ms/iter  37.04 ms      █
-                      (36.69 ms … 38.15 ms)  38.05 ms ▅ ▅  █
-                    (291.31 kb …   4.70 mb) 553.03 kb █▇█▇▇█▁▇▁▁▁▁▁▁▁▁▇▁▁▁▇
-                  1.04 ipc ( 11.15% stalls)  38.89% L1 data cache
-        406.85k cycles 423.12k instructions  20.01% retired LD/ST ( 84.65k)
-
-mvdan-sh                      78.00 ms/iter  74.63 ms     █
-                     (70.44 ms … 127.50 ms)  78.25 ms     █  █
-                    (  1.11 mb …   9.87 mb)   7.88 mb █▁▁▁█▁▁██▁███▁▁▁▁▁▁▁█
-                  5.18 ipc (  1.02% stalls)  99.05% L1 data cache
-        244.60M cycles   1.27G instructions  34.47% retired LD/ST (436.51M)
+sh-syntax                     18.33 ms/iter  18.56 ms   ▃        ▃█
+                      (17.48 ms … 20.83 ms)  19.09 ms ▂▂█    ▂   ██▂  ▂ ▂
+                    ( 28.52 kb …   9.82 mb) 890.46 kb ███▆▆▁▁█▁▁▆███▁▆█▁█▆▆
+                  5.07 ipc (  1.22% stalls)  99.36% L1 data cache
+         56.96M cycles 288.57M instructions  39.27% retired LD/ST (113.32M)
+
+sh-syntax (synckit)           18.38 ms/iter  18.82 ms ▂▂▂           ▂▂ █▂
+                      (17.63 ms … 19.06 ms)  19.04 ms ███▅          ██ ██▅▅
+                    (291.31 kb … 312.45 kb) 292.09 kb ████▇▇▇▇▁▁▁▁▇▁██▇████
+                  1.11 ipc ( 11.51% stalls)  40.34% L1 data cache
+        434.86k cycles 484.78k instructions  19.58% retired LD/ST ( 94.92k)
+
+mvdan-sh                      79.47 ms/iter  78.95 ms  █
+                     (71.22 ms … 126.09 ms)  80.84 ms ▅█ ▅▅▅    ▅    ▅▅▅  ▅
+                    (  8.18 mb …   9.70 mb)   8.83 mb ██▁███▁▁▁▁█▁▁▁▁███▁▁█
+                  5.18 ipc (  1.05% stalls)  99.04% L1 data cache
+        249.41M cycles   1.29G instructions  34.41% retired LD/ST (444.42M)
 
 summary
   sh-syntax
    1x faster than sh-syntax (synckit)
-   2.11x faster than mvdan-sh
+   4.34x faster than mvdan-sh
 ```
 
 See [benchmark](./benchmark/benchmark.txt) for more details.
 
@@ -1,28 +1,28 @@
-clk: ~3.10 GHz
+clk: ~2.81 GHz
 cpu: Apple M1 Max
 runtime: node 18.20.8 (arm64-darwin)
 
 benchmark                   avg (min … max) p75 / p99    (min … top 1%)
 ------------------------------------------- -------------------------------
-sh-syntax                     36.97 ms/iter  37.32 ms     █
-                      (36.50 ms … 37.53 ms)  37.38 ms █   █              ██
-                    (601.05 kb … 711.16 kb) 641.13 kb █▁▁██▁▁▁█▁▁██▁█▁▁▁▁██
-                  4.88 ipc (  0.63% stalls)  99.64% L1 data cache
-        118.27M cycles 577.63M instructions  38.24% retired LD/ST (220.90M)
+sh-syntax                     18.33 ms/iter  18.56 ms   ▃        ▃█
+                      (17.48 ms … 20.83 ms)  19.09 ms ▂▂█    ▂   ██▂  ▂ ▂
+                    ( 28.52 kb …   9.82 mb) 890.46 kb ███▆▆▁▁█▁▁▆███▁▆█▁█▆▆
+                  5.07 ipc (  1.22% stalls)  99.36% L1 data cache
+         56.96M cycles 288.57M instructions  39.27% retired LD/ST (113.32M)
 
-sh-syntax (synckit)           37.13 ms/iter  37.04 ms      █
-                      (36.69 ms … 38.15 ms)  38.05 ms ▅ ▅  █
-                    (291.31 kb …   4.70 mb) 553.03 kb █▇█▇▇█▁▇▁▁▁▁▁▁▁▁▇▁▁▁▇
-                  1.04 ipc ( 11.15% stalls)  38.89% L1 data cache
-        406.85k cycles 423.12k instructions  20.01% retired LD/ST ( 84.65k)
+sh-syntax (synckit)           18.38 ms/iter  18.82 ms ▂▂▂           ▂▂ █▂
+                      (17.63 ms … 19.06 ms)  19.04 ms ███▅          ██ ██▅▅
+                    (291.31 kb … 312.45 kb) 292.09 kb ████▇▇▇▇▁▁▁▁▇▁██▇████
+                  1.11 ipc ( 11.51% stalls)  40.34% L1 data cache
+        434.86k cycles 484.78k instructions  19.58% retired LD/ST ( 94.92k)
 
-mvdan-sh                      78.00 ms/iter  74.63 ms     █
-                     (70.44 ms … 127.50 ms)  78.25 ms     █  █
-                    (  1.11 mb …   9.87 mb)   7.88 mb █▁▁▁█▁▁██▁███▁▁▁▁▁▁▁█
-                  5.18 ipc (  1.02% stalls)  99.05% L1 data cache
-        244.60M cycles   1.27G instructions  34.47% retired LD/ST (436.51M)
+mvdan-sh                      79.47 ms/iter  78.95 ms  █
+                     (71.22 ms … 126.09 ms)  80.84 ms ▅█ ▅▅▅    ▅    ▅▅▅  ▅
+                    (  8.18 mb …   9.70 mb)   8.83 mb ██▁███▁▁▁▁█▁▁▁▁███▁▁█
+                  5.18 ipc (  1.05% stalls)  99.04% L1 data cache
+        249.41M cycles   1.29G instructions  34.41% retired LD/ST (444.42M)
 
 summary
   sh-syntax
    1x faster than sh-syntax (synckit)
-   2.11x faster than mvdan-sh
+   4.34x faster than mvdan-sh
@@ -14,4 +14,10 @@ export default [
       '@stylistic/js/multiline-comment-style': ['error', 'starred-block'],
     },
   },
+  {
+    files: ['test/{fixtures,processor}.spec.ts'],
+    rules: {
+      'sonarjs/no-empty-test-file': 'off',
+    },
+  },
 ]
@@ -33,6 +33,10 @@
         "default": "./lib/index.cjs"
       }
     },
+    "./browser": {
+      "types": "./lib/browser.d.ts",
+      "default": "./lib/browser.js"
+    },
     "./main.wasm": "./main.wasm",
     "./package.json": "./package.json",
     "./vendors/wasm_exec": "./vendors/wasm_exec.cjs",
 
@@ -24,14 +24,26 @@ export class ParseError extends Error implements IParseError {
   }
 }
 
+export type GetWebAssemblySource = () =>
+  | BufferSource
+  | Promise<BufferSource | Response>
+  | Response
+
+export type GetWebAssemblyInstance = (
+  imports: WebAssembly.Imports,
+) => Promise<WebAssembly.Instance> | WebAssembly.Instance
+
+let encoder: TextEncoder | undefined
+let decoder: TextDecoder | undefined
+
 export const getProcessor = (
-  getWasmFile: () => BufferSource | Promise<BufferSource>,
+  getWasm: GetWebAssemblyInstance | GetWebAssemblySource,
 ) => {
-  let wasmFile: BufferSource | undefined
-  let wasmFilePromise: Promise<BufferSource> | undefined
+  let wasmBufferSource: BufferSource | undefined
+  let wasmBufferSourcePromise: Promise<BufferSource> | undefined
 
-  const encoder = new TextEncoder()
-  const decoder = new TextDecoder()
+  encoder ??= new TextEncoder()
+  decoder ??= new TextDecoder()
 
   function processor(text: string, options?: ShOptions): Promise<File>
   function processor(
@@ -98,11 +110,16 @@ export const getProcessor = (
       functionNextLine = false,
     }: ShOptions & { print?: boolean; originalText?: string } = {},
   ) {
-    if (!wasmFile) {
-      if (!wasmFilePromise) {
-        wasmFilePromise = Promise.resolve(getWasmFile())
-      }
-      wasmFile = await wasmFilePromise
+    if (!wasmBufferSource && !wasmBufferSourcePromise && getWasm.length === 0) {
+      wasmBufferSourcePromise = Promise.resolve(
+        (getWasm as GetWebAssemblySource)(),
+      ).then(source =>
+        'arrayBuffer' in source ? source.arrayBuffer() : source,
+      )
+    }
+
+    if (wasmBufferSourcePromise) {
+      wasmBufferSource = await wasmBufferSourcePromise
     }
 
     if (typeof textOrAst !== 'string' && !print) {
@@ -117,7 +134,14 @@ export const getProcessor = (
 
     const go = new Go()
 
-    const wasm = await WebAssembly.instantiate(wasmFile, go.importObject)
+    const wasm =
+      getWasm.length === 0
+        ? await WebAssembly.instantiate(wasmBufferSource!, go.importObject)
+        : {
+            instance: await (getWasm as GetWebAssemblyInstance)(
+              go.importObject,
+            ),
+          }
 
     /**
      * Do not await this promise, because it only resolves once the go main()
@@ -159,9 +183,9 @@ export const getProcessor = (
       ) => number
     }
 
-    const filePath = encoder.encode(filepath)
-    const text = encoder.encode(originalText || (textOrAst as string))
-    const uStopAt = encoder.encode(stopAt)
+    const filePath = encoder!.encode(filepath)
+    const text = encoder!.encode(originalText || (textOrAst as string))
+    const uStopAt = encoder!.encode(stopAt)
 
     const filePathPointer = wasmAlloc(filePath.byteLength)
     new Uint8Array(memory.buffer).set(filePath, filePathPointer)
@@ -207,7 +231,7 @@ export const getProcessor = (
     const result = new Uint8Array(memory.buffer).subarray(resultPointer)
     const end = result.indexOf(0)
 
-    const string = decoder.decode(result.subarray(0, end))
+    const string = decoder!.decode(result.subarray(0, end))
 
     // naive check whether the string is a json
     if (!string.startsWith('{"') || !string.endsWith('}')) {
 
@@ -3,7 +3,7 @@
     "wasm"
   ],
   "ldflags": [
-    "--initial-memory=52428800",
+    "--initial-memory=10485760",
     "--max-memory=1073741824",
     "-zstack-size=1048576"
   ]
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"sh-syntax": patch
 +---
++
 +feat: support more ways to load `wasm` on browser
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"wasm"`
`4`	`4`	`],`
`5`	`5`	`"ldflags": [`
`6`		`- "--initial-memory=52428800",`
	`6`	`+ "--initial-memory=10485760",`
`7`	`7`	`"--max-memory=1073741824",`
`8`	`8`	`"-zstack-size=1048576"`
`9`	`9`	`]`