@wasm-fmt/gofmt 0.5.1 → 0.6.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.6.0]
+
+### Breaking
+- **Entry point change:** The default entry point has been restructured. If you are upgrading from a version below 0.6.0 and want the previous behavior, import from `@wasm-fmt/gofmt/web` instead of the default entry point.

package/README.md

@@ -16,8 +16,28 @@ npx jsr add @fmt/gofmt
 
 # Usage
 
-```JavaScript
-import init, { format } from "@wasm-fmt/gofmt";
+## Node.js / Deno / Bun / Bundler
+
+```javascript
+import { format } from "@wasm-fmt/gofmt";
+
+const source = `
+package main
+import "fmt"
+func main(){fmt.Println("Hello, 世界")
+}
+`;
+
+const formatted = format(source);
+console.log(formatted);
+```
+
+## Web
+
+For web environments, you need to initialize WASM module manually:
+
+```javascript
+import init, { format } from "@wasm-fmt/gofmt/web";
 
 await init();
 
@@ -32,12 +52,24 @@ const formatted = format(source);
 console.log(formatted);
 ```
 
-Vite users tip:
+### Vite
 
 ```JavaScript
 import init, { format } from "@wasm-fmt/gofmt/vite";
+
+await init();
+// ...
 ```
 
+## Entry Points
+
+- `.` - Auto-detects environment (Node.js uses node, Webpack uses bundler, default is ESM)
+- `./node` - Node.js environment (no init required)
+- `./esm` - ESM environments like Deno (no init required)
+- `./bundler` - Bundlers like Webpack (no init required)
+- `./web` - Web browsers (requires manual init)
+- `./vite` - Vite bundler (requires manual init)
+
 # Build from source
 
 ```bash
@@ -49,8 +81,8 @@ import init, { format } from "@wasm-fmt/gofmt/vite";
 git clone https://github.com/wasm-fmt/gofmt.git
 
 # 4. build
-pnpm build
+npm run build
 
-# 5. test
-pnpm run /^test:/
+# 6. test
+npm run test:node
 ```

package/gofmt.d.wasm.ts

@@ -1,3 +1,7 @@
+/**
+ * WebAssembly module for gofmt.
+ * @module
+ */
 export declare const memory: WebAssembly.Memory;
 export declare function _initialize(): void;
 export declare function alloc(size: number): number;

package/gofmt_entry.d.ts

@@ -1,14 +1,11 @@
-export type InitInput =
-	| RequestInfo
-	| URL
-	| Response
-	| BufferSource
-	| WebAssembly.Module;
-export type SyncInitInput = BufferSource | WebAssembly.Module;
-import type * as InitOutput from "./gofmt.d.wasm.ts";
+/**
+ * gofmt default entry for formatting Go source code.
+ * @module
+ */
 
-export default function initAsync(
-	init_input?: InitInput | Promise<InitInput>,
-): Promise<InitOutput>;
-export declare function initSync(buffer_or_module: SyncInitInput): InitOutput;
+/**
+ * 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_esm.js

@@ -1,3 +1,9 @@
+/* @ts-self-types="./gofmt_entry.d.ts" */
+/**
+ * Loads the Wasm module via source phase import.
+ * @module
+ */
+// prettier-ignore
 import source wasmModule from "./gofmt.wasm";
 import { format as _format } from "./gofmt.js";
 /**
@@ -9,17 +15,9 @@ const instance = new WebAssembly.Instance(wasmModule);
 /**
  * @type {WASM}
  */
-let wasm = instance.exports;
+const wasm = instance.exports;
 wasm._initialize();
 
-export function initSync() {
-	return wasm;
-}
-
-export default async function initAsync() {
-	return wasm;
-}
-
 export function format(source) {
 	return _format(wasm, source);
 }

package/gofmt_node.js

@@ -1,101 +1,26 @@
 /* @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
+ */
+import { readFileSync } from "node:fs";
 import { format as _format } from "./gofmt.js";
 
-let wasm, wasmModule;
+const wasmUrl = new URL("gofmt.wasm", import.meta.url);
+const wasmBytes = readFileSync(wasmUrl);
+const wasmModule = new WebAssembly.Module(wasmBytes);
 
-export function initSync(buffer_or_module) {
-	if (wasm !== void 0) return wasm;
+/**
+ * @import * as WASM from "./gofmt.wasm"
+ */
 
-	if (!(buffer_or_module instanceof WebAssembly.Module)) {
-		buffer_or_module = new WebAssembly.Module(buffer_or_module);
-	}
-
-	return finalize_init(
-		new WebAssembly.Instance(buffer_or_module),
-		buffer_or_module,
-	);
-}
-
-export default async function initAsync(init_input) {
-	if (wasm !== void 0) return wasm;
-
-	if (init_input === void 0) {
-		init_input = new URL("gofmt.wasm", import.meta.url);
-	}
-
-	if (typeof init_input === "string") {
-		init_input = new URL(init_input);
-	}
-
-	if (init_input instanceof URL && init_input.protocol === "file:") {
-		const [{ readFile }, { fileURLToPath }] = await Promise.all([
-			import("fs/promises"),
-			import("url"),
-		]);
-		init_input = readFile(fileURLToPath(init_input));
-	} else if (
-		(typeof Request === "function" && init_input instanceof Request) ||
-		init_input instanceof URL
-	) {
-		init_input = fetch(init_input);
-	}
-
-	const { instance, module } = await load(await init_input);
-
-	return finalize_init(instance, module);
-}
-
-async function load(module, imports) {
-	if (typeof Response === "function" && module instanceof Response) {
-		if (typeof WebAssembly.instantiateStreaming === "function") {
-			try {
-				return await WebAssembly.instantiateStreaming(module, imports);
-			} catch (e) {
-				const validResponse =
-					module.ok && expectedResponseType(module.type);
-
-				if (
-					validResponse &&
-					module.headers.get("Content-Type") !== "application/wasm"
-				) {
-					console.warn(
-						"`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n",
-						e,
-					);
-				} else {
-					throw e;
-				}
-			}
-		}
-
-		const bytes = await module.arrayBuffer();
-		return await WebAssembly.instantiate(bytes, imports);
-	} else {
-		const instance = await WebAssembly.instantiate(module, imports);
-
-		if (instance instanceof WebAssembly.Instance) {
-			return { instance, module };
-		} else {
-			return instance;
-		}
-	}
-
-	function expectedResponseType(type) {
-		switch (type) {
-			case "basic":
-			case "cors":
-			case "default":
-				return true;
-		}
-		return false;
-	}
-}
-
-function finalize_init(instance, module) {
-	wasm = instance.exports, wasmModule = module;
-	wasm._initialize();
-	return wasm;
-}
+const instance = new WebAssembly.Instance(wasmModule);
+/**
+ * @type {WASM}
+ */
+const wasm = instance.exports;
+wasm._initialize();
 
 export function format(source) {
 	return _format(wasm, source);

package/gofmt_vite.js

@@ -1,9 +1,37 @@
-/* @ts-self-types="./gofmt_entry.d.ts" */
+/* @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 wasm_url from "./gofmt.wasm?url";
+import { format as _format } from "./gofmt.js";
 
-export default function (input = wasm_url) {
-	return initAsync(input);
+let wasm, wasmModule;
+
+function finalize_init(instance, module) {
+	wasm = instance.exports;
+	wasmModule = module;
+	wasm._initialize();
+	return wasm;
+}
+
+export default async function initAsync() {
+	if (wasm !== void 0) return wasm;
+	const instance = await init();
+	return finalize_init(instance);
 }
 
-export * from "./gofmt_web.js";
+export function initSync(module) {
+	if (wasm !== void 0) return wasm;
+
+	if (!(module instanceof WebAssembly.Module)) {
+		module = new WebAssembly.Module(module);
+	}
+	const instance = new WebAssembly.Instance(module);
+	return finalize_init(instance, module);
+}
+
+export function format(source) {
+	return _format(wasm, source);
+}

package/gofmt_web.d.ts

@@ -0,0 +1,20 @@
+/**
+ * gofmt entry with initialization functions.
+ * @module
+ */
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+import type * as InitOutput from "./gofmt.wasm";
+
+/**
+ * Initializes the WASM module asynchronously.
+ * @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 "gofmt_entry.d.ts";

package/gofmt_web.js

@@ -1,4 +1,9 @@
-/* @ts-self-types="./gofmt_entry.d.ts" */
+/* @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";
 let wasm, wasmModule;
 
@@ -8,13 +13,9 @@ async function load(module, imports) {
 			try {
 				return await WebAssembly.instantiateStreaming(module, imports);
 			} catch (e) {
-				const validResponse =
-					module.ok && expectedResponseType(module.type);
+				const validResponse = module.ok && expectedResponseType(module.type);
 
-				if (
-					validResponse &&
-					module.headers.get("Content-Type") !== "application/wasm"
-				) {
+				if (validResponse && module.headers.get("Content-Type") !== "application/wasm") {
 					console.warn(
 						"`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n",
 						e,
@@ -49,7 +50,7 @@ async function load(module, imports) {
 }
 
 function finalize_init(instance, module) {
-	wasm = instance.exports, wasmModule = module;
+	((wasm = instance.exports), (wasmModule = module));
 	wasm._initialize();
 	return wasm;
 }

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.5.1",
+	"version": "0.6.0",
 	"license": "MIT",
 	"keywords": [
 		"wasm",
@@ -21,18 +21,37 @@
 	"exports": {
 		".": {
 			"types": "./gofmt_entry.d.ts",
+			"webpack": "./gofmt_bundle.js",
 			"node": "./gofmt_node.js",
+			"default": "./gofmt_esm.js"
+		},
+		"./esm": {
+			"types": "./gofmt_entry.d.ts",
+			"default": "./gofmt_esm.js"
+		},
+		"./node": {
+			"types": "./gofmt_entry.d.ts",
+			"default": "./gofmt_node.js"
+		},
+		"./bundler": {
+			"types": "./gofmt_entry.d.ts",
+			"default": "./gofmt_bundle.js"
+		},
+		"./web": {
+			"types": "./gofmt_web.d.ts",
 			"default": "./gofmt_web.js"
 		},
 		"./vite": {
-			"types": "./gofmt_entry.d.ts",
+			"types": "./gofmt_web.d.ts",
 			"default": "./gofmt_vite.js"
 		},
+		"./wasm": "./gofmt.wasm",
 		"./package.json": "./package.json",
 		"./*": "./*"
 	},
 	"scripts": {
 		"build": "./scripts/build.sh",
+		"fmt": "dprint fmt",
 		"test:go": "go test ./src -v",
 		"test:node": "node --test test_node/node.test.js",
 		"test:deno": "deno test test_deno --allow-read",