@wasm-fmt/gofmt 0.6.1 → 0.7.0

package/README.md

@@ -32,6 +32,12 @@ const formatted = format(source);
 console.log(formatted);
 ```
 
+## Node.js < 22.19
+
+```JavaScript
+import { format } from "@wasm-fmt/gofmt/node";
+```
+
 ## Web
 
 For web environments, you need to initialize WASM module manually:

package/gofmt.d.ts

@@ -0,0 +1,27 @@
+/**
+ * A wasm based golang formatter
+ *
+ * @example
+ * ```ts
+ * ```javascript
+ * import { format } from "@wasm-fmt/gofmt";
+ *
+ * const source = `
+ * package main
+ * import "fmt"
+ * func main(){fmt.Println("Hello, 世界")
+ * }
+ * `;
+ *
+ * const formatted = format(source);
+ * ```
+ *
+ * @module
+ */
+
+/**
+ * Formats a Go source code.
+ * @param input - The Go source code to format
+ * @returns The formatted Go source code
+ */
+export declare function format(input: string): string;

package/gofmt.js

@@ -1,49 +1,9 @@
-/**
- * @import * as WASM from "./gofmt.wasm"
- */
+/* @ts-self-types="./gofmt.d.ts" */
+import wasm from "./gofmt.wasm";
+import { format as _format } from "./gofmt_binding.js";
 
-/**
- * @param {WASM} wasm
- * @param {string} source
- * @return {string}
- */
-export function format(wasm, source) {
-	try {
-		writeStringToWasmMemory(wasm, source);
-		const result = wasm.format();
-		if (result === 0) {
-			return source;
-		}
+wasm._initialize();
 
-		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);
+export function format(source) {
+	return _format(wasm, source);
 }
-
-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/gofmt_binding.js

@@ -0,0 +1,49 @@
+/**
+ * @import * as WASM from "./gofmt.wasm"
+ */
+
+/**
+ * @param {WASM} wasm
+ * @param {string} source
+ * @return {string}
+ */
+export function format(wasm, source) {
+	try {
+		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/gofmt_esm.js

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

package/gofmt_node.js

@@ -1,11 +1,6 @@
-/* @ts-self-types="./gofmt_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="./gofmt.d.ts" */
 import { readFileSync } from "node:fs";
-import { format as _format } from "./gofmt.js";
+import { format as _format } from "./gofmt_binding.js";
 
 const wasmUrl = new URL("gofmt.wasm", import.meta.url);
 const wasmBytes = readFileSync(wasmUrl);

package/gofmt_vite.js

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

package/gofmt_web.d.ts

@@ -1,9 +1,38 @@
 /**
- * gofmt entry with initialization functions.
+ * A wasm based golang formatter
+ *
+ * @example
+ * ```ts
+ * ```javascript
+ * import init, { format } from "@wasm-fmt/gofmt";
+ *
+ * await init();
+ *
+ * const source = `
+ * package main
+ * import "fmt"
+ * func main(){fmt.Println("Hello, 世界")
+ * }
+ * `;
+ *
+ * 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 "./gofmt.wasm";
 
 /**
@@ -17,4 +46,4 @@ export default function initAsync(init_input?: InitInput): Promise<InitOutput>;
  */
 export declare function initSync(buffer_or_module: BufferSource | WebAssembly.Module): InitOutput;
 
-export * from "./gofmt_entry.d.ts";
+export * from "./gofmt.d.ts";

package/gofmt_web.js

@@ -1,10 +1,5 @@
 /* @ts-self-types="./gofmt_web.d.ts" */
-/**
- * Loads the Wasm module via Web Fetch API (browsers).
- * Requires calling init().
- * @module
- */
-import { format as _format } from "./gofmt.js";
+import { format as _format } from "./gofmt_binding.js";
 let wasm, wasmModule;
 
 async function load(module, imports) {
@@ -55,32 +50,32 @@ function finalize_init(instance, module) {
 	return wasm;
 }
 
-export function initSync(module) {
+export function initSync(buffer_or_module) {
 	if (wasm !== void 0) return wasm;
 
-	if (!(module instanceof WebAssembly.Module)) {
-		module = new WebAssembly.Module(module);
+	if (!(buffer_or_module instanceof WebAssembly.Module)) {
+		buffer_or_module = new WebAssembly.Module(buffer_or_module);
 	}
-	const instance = new WebAssembly.Instance(module);
-	return finalize_init(instance, module);
+	const instance = new WebAssembly.Instance(buffer_or_module);
+	return finalize_init(instance, buffer_or_module);
 }
 
-export default async function initAsync(module_or_path) {
+export default async function initAsync(init_input) {
 	if (wasm !== void 0) return wasm;
 
-	if (module_or_path === void 0) {
-		module_or_path = new URL("gofmt.wasm", import.meta.url);
+	if (init_input === void 0) {
+		init_input = new URL("gofmt.wasm", import.meta.url);
 	}
 
 	if (
-		typeof module_or_path === "string" ||
-		(typeof Request === "function" && module_or_path instanceof Request) ||
-		(typeof URL === "function" && module_or_path instanceof URL)
+		typeof init_input === "string" ||
+		(typeof Request === "function" && init_input instanceof Request) ||
+		(typeof URL === "function" && init_input instanceof URL)
 	) {
-		module_or_path = fetch(module_or_path);
+		init_input = fetch(init_input);
 	}
 
-	const { instance, module } = await load(await module_or_path);
+	const { instance, module } = await load(await init_input);
 
 	return finalize_init(instance, module);
 }

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@wasm-fmt/gofmt",
 	"description": "A wasm based golang formatter",
 	"author": "magic-akari <akari.ccino@gamil.com>",
-	"version": "0.6.1",
+	"version": "0.7.0",
 	"license": "MIT",
 	"keywords": [
 		"wasm",
@@ -20,22 +20,23 @@
 	"type": "module",
 	"exports": {
 		".": {
-			"types": "./gofmt_entry.d.ts",
-			"webpack": "./gofmt_bundle.js",
-			"node": "./gofmt_node.js",
+			"types": "./gofmt.d.ts",
+			"webpack": "./gofmt.js",
+			"deno": "./gofmt.js",
+			"module-sync": "./gofmt_node.js",
 			"default": "./gofmt_esm.js"
 		},
 		"./esm": {
-			"types": "./gofmt_entry.d.ts",
+			"types": "./gofmt.d.ts",
 			"default": "./gofmt_esm.js"
 		},
 		"./node": {
-			"types": "./gofmt_entry.d.ts",
+			"types": "./gofmt.d.ts",
 			"default": "./gofmt_node.js"
 		},
 		"./bundler": {
-			"types": "./gofmt_entry.d.ts",
-			"default": "./gofmt_bundle.js"
+			"types": "./gofmt.d.ts",
+			"default": "./gofmt.js"
 		},
 		"./web": {
 			"types": "./gofmt_web.d.ts",

package/gofmt_bundle.js

@@ -1,16 +0,0 @@
-import wasm from "./gofmt.wasm";
-import { format as _format } from "./gofmt.js";
-
-wasm._initialize();
-
-export function initSync() {
-	return wasm;
-}
-
-export default async function initAsync() {
-	return wasm;
-}
-
-export function format(source) {
-	return _format(wasm, source);
-}

package/gofmt_entry.d.ts

@@ -1,11 +0,0 @@
-/**
- * gofmt default entry for formatting Go source code.
- * @module
- */
-
-/**
- * Formats a Go source code.
- * @param input - The Go source code to format
- * @returns The formatted Go source code
- */
-export declare function format(input: string): string;