@wasm-fmt/shfmt 0.2.0 → 0.2.2

package/README.md

@@ -24,7 +24,6 @@ import { format } from "@wasm-fmt/shfmt";
 const source = `#!/bin/bash
 echo "hello world"
 `;
-
 const formatted = format(source);
 console.log(formatted);
 ```
@@ -44,6 +43,12 @@ const formatted = format(source, "script.sh", {
 });
 ```
 
+## Node.js < 22.19
+
+```JavaScript
+import { format } from "@wasm-fmt/shfmt/node";
+```
+
 ## Web
 
 For web environments, you need to initialize WASM module manually:

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@wasm-fmt/shfmt",
 	"description": "A wasm based shell script formatter",
 	"author": "magic-akari <akari.ccino@gmail.com>",
-	"version": "0.2.0",
+	"version": "0.2.2",
 	"license": "MIT",
 	"keywords": [
 		"wasm",
@@ -22,22 +22,23 @@
 	"type": "module",
 	"exports": {
 		".": {
-			"types": "./shfmt_entry.d.ts",
-			"webpack": "./shfmt_bundle.js",
-			"node": "./shfmt_node.js",
+			"types": "./shfmt.d.ts",
+			"webpack": "./shfmt.js",
+			"deno": "./shfmt.js",
+			"module-sync": "./shfmt_node.js",
 			"default": "./shfmt_esm.js"
 		},
 		"./esm": {
-			"types": "./shfmt_entry.d.ts",
+			"types": "./shfmt.d.ts",
 			"default": "./shfmt_esm.js"
 		},
 		"./node": {
-			"types": "./shfmt_entry.d.ts",
+			"types": "./shfmt.d.ts",
 			"default": "./shfmt_node.js"
 		},
 		"./bundler": {
-			"types": "./shfmt_entry.d.ts",
-			"default": "./shfmt_bundle.js"
+			"types": "./shfmt.d.ts",
+			"default": "./shfmt.js"
 		},
 		"./web": {
 			"types": "./shfmt_web.d.ts",

package/{shfmt_entry.d.ts → shfmt.d.ts}

@@ -1,3 +1,21 @@
+/**
+ * A wasm based shell script formatter
+ *
+ * @example
+ * ```ts
+ * ```javascript
+ * import { format } from "@wasm-fmt/shfmt";
+ *
+ * const source = `#!/bin/bash
+ * echo "hello world"
+ * `;
+ *
+ * const formatted = format(source);
+ * ```
+ *
+ * @module
+ */
+
 /**
  * Formats a shell script source code.
  * @param source - The shell script source code to format

package/shfmt.js

@@ -1,61 +1,9 @@
-/**
- * @import * as WASM from "./shfmt.wasm"
- */
+/* @ts-self-types="./shfmt.d.ts" */
+import wasm from "./shfmt.wasm";
+import { format as _format } from "./shfmt_binding.js";
 
-/**
- * @param {WASM} wasm
- * @param {string} source
- * @param {string} [path]
- * @param {object} [options]
- * @return {string}
- */
-export function format(wasm, source, path, options) {
-	try {
-		if (options) {
-			writeStringToWasmMemory(wasm, JSON.stringify(options));
-			wasm.set_options();
-		}
+wasm._initialize();
 
-		if (path) {
-			writeStringToWasmMemory(wasm, path);
-			wasm.set_path();
-		}
-
-		writeStringToWasmMemory(wasm, source);
-		const result = wasm.format();
-		if (result === 0) {
-			return source;
-		}
-
-		const ptr = wasm.output_ptr();
-		const length = wasm.output_len();
-		const text = readStringFromWasmMemory(wasm, ptr, length);
-
-		if (result === 1) {
-			return text;
-		}
-
-		throw new Error(text);
-	} finally {
-		wasm.dispose();
-	}
+export function format(source, path, options) {
+	return _format(wasm, source, path, options);
 }
-
-/**
- * @param {WASM} wasm
- * @param {string} str
- */
-function writeStringToWasmMemory(wasm, str) {
-	const bytes = encoder.encode(str);
-	const ptr = wasm.alloc(bytes.length);
-	const memory = new Uint8Array(wasm.memory.buffer, ptr, bytes.length);
-	memory.set(bytes);
-}
-
-function readStringFromWasmMemory(wasm, ptr, length) {
-	const memory = new Uint8Array(wasm.memory.buffer, ptr, length);
-	return decoder.decode(memory);
-}
-
-const encoder = new TextEncoder();
-const decoder = new TextDecoder();

package/shfmt_binding.js

@@ -0,0 +1,61 @@
+/**
+ * @import * as WASM from "./shfmt.wasm"
+ */
+
+/**
+ * @param {WASM} wasm
+ * @param {string} source
+ * @param {string} [path]
+ * @param {object} [options]
+ * @return {string}
+ */
+export function format(wasm, source, path, options) {
+	try {
+		if (options) {
+			writeStringToWasmMemory(wasm, JSON.stringify(options));
+			wasm.set_options();
+		}
+
+		if (path) {
+			writeStringToWasmMemory(wasm, path);
+			wasm.set_path();
+		}
+
+		writeStringToWasmMemory(wasm, source);
+		const result = wasm.format();
+		if (result === 0) {
+			return source;
+		}
+
+		const ptr = wasm.output_ptr();
+		const length = wasm.output_len();
+		const text = readStringFromWasmMemory(wasm, ptr, length);
+
+		if (result === 1) {
+			return text;
+		}
+
+		throw new Error(text);
+	} finally {
+		wasm.dispose();
+	}
+}
+
+/**
+ * @param {WASM} wasm
+ * @param {string} str
+ */
+function writeStringToWasmMemory(wasm, str) {
+	const bytes = encoder.encode(str);
+	const ptr = wasm.alloc(bytes.length);
+	const memory = new Uint8Array(wasm.memory.buffer, ptr, bytes.length);
+	memory.set(bytes);
+}
+
+function readStringFromWasmMemory(wasm, ptr, length) {
+	const memory = new Uint8Array(wasm.memory.buffer, ptr, length);
+	return decoder.decode(memory);
+}
+
+const encoder = new TextEncoder();
+const decoder = new TextDecoder();

package/shfmt_esm.js

@@ -1,11 +1,7 @@
-/* @ts-self-types="./shfmt_entry.d.ts" */
-/**
- * Loads the Wasm module via source phase import.
- * @module
- */
+/* @ts-self-types="./shfmt.d.ts" */
 // prettier-ignore
 import source wasmModule from "./shfmt.wasm";
-import { format as _format } from "./shfmt.js";
+import { format as _format } from "./shfmt_binding.js";
 /**
  * @import * as WASM from "./shfmt.wasm"
  */

package/shfmt_node.js

@@ -1,11 +1,6 @@
-/* @ts-self-types="./shfmt_entry.d.ts" */
-/**
- * Loads the Wasm module using Node's fs API.
- * Consider using `./esm` entry if your environment supports source phase import.
- * @module
- */
+/* @ts-self-types="./shfmt.d.ts" */
 import { readFileSync } from "node:fs";
-import { format as _format } from "./shfmt.js";
+import { format as _format } from "./shfmt_binding.js";
 
 const wasmUrl = new URL("shfmt.wasm", import.meta.url);
 const wasmBytes = readFileSync(wasmUrl);

package/shfmt_vite.js

@@ -1,11 +1,7 @@
 /* @ts-self-types="./shfmt_web.d.ts" */
-/**
- * Loads the Wasm module for Vite and bundlers supporting `?init` imports.
- * @module
- */
 import init from "./shfmt.wasm?init";
 import initAsync from "./shfmt_web.js";
-import { format as _format } from "./shfmt.js";
+import { format as _format } from "./shfmt_binding.js";
 
 let wasm, wasmModule;
 

package/shfmt_web.d.ts

@@ -1,5 +1,35 @@
+/**
+ * A wasm based shell script formatter
+ *
+ * @example
+ * ```ts
+ * ```javascript
+ * import init, { format } from "@wasm-fmt/shfmt";
+ *
+ * await init();
+ *
+ * const source = `#!/bin/bash
+ * echo "hello world"
+ * `;
+ *
+ * const formatted = format(source);
+ * ```
+ *
+ * @module
+ */
+
+/**
+ * Input types for asynchronous WASM initialization.
+ * Can be a URL/path to fetch, a Response object, raw bytes, or a pre-compiled WebAssembly.Module.
+ */
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+/**
+ * Input types for synchronous WASM initialization.
+ * Must be raw bytes (BufferSource) or a pre-compiled WebAssembly.Module.
+ */
 export type SyncInitInput = BufferSource | WebAssembly.Module;
+
 import type * as InitOutput from "./shfmt.wasm";
 
 /**
@@ -7,10 +37,11 @@ import type * as InitOutput from "./shfmt.wasm";
  * @param init_input - Optional URL/path to the WASM file, or any valid InitInput
  */
 export default function initAsync(init_input?: InitInput): Promise<InitOutput>;
+
 /**
  * Initializes the WASM module synchronously.
  * @param buffer_or_module - The WASM module or buffer source
  */
 export declare function initSync(buffer_or_module: BufferSource | WebAssembly.Module): InitOutput;
 
-export * from "shfmt_entry.d.ts";
+export * from "./shfmt.d.ts";

package/shfmt_web.js

@@ -1,10 +1,5 @@
 /* @ts-self-types="./shfmt_web.d.ts" */
-/**
- * Loads the Wasm module via Web Fetch API (browsers).
- * Requires calling init().
- * @module
- */
-import { format as _format } from "./shfmt.js";
+import { format as _format } from "./shfmt_binding.js";
 let wasm, wasmModule;
 
 async function load(module, imports) {

package/shfmt_bundle.js

@@ -1,9 +0,0 @@
-/* @ts-self-types="./shfmt_entry.d.ts" */
-import wasm from "./shfmt.wasm";
-import { format as _format } from "./shfmt.js";
-
-wasm._initialize();
-
-export function format(source, path, options) {
-	return _format(wasm, source, path, options);
-}