@wasm-fmt/dart_fmt 0.2.0 → 0.4.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
-## 0.0.0
+# 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.4.0]
+
+### Breaking
+
+- **Entry point change:** The default entry point has been restructured. If you are upgrading from a version below 0.4.0 and want the previous behavior, import from `@wasm-fmt/dart_fmt/web` instead of the default entry point.
+
+## [0.0.0]
 
 - Initial version.

package/README.md

@@ -16,39 +16,68 @@ npx jsr add @fmt/dart-fmt
 
 # Usage
 
-```javascript
-import init, { format } from "@wasm-fmt/dart_fmt";
+## Node.js / Deno / Bun
 
-await init();
+```javascript
+import { format } from "@wasm-fmt/dart_fmt";
 
-const input = `void main() { print('Hello, World!'); }`;
+const source = `void main() { print('Hello, World!'); }`;
 
-const formatted = format(input, "main.dart");
+const formatted = format(source);
 console.log(formatted);
 ```
 
-For Vite users:
+## Bundler
 
-Add `"@wasm-fmt/dart_fmt"` to `optimizeDeps.exclude` in your vite config:
+dart_fmt does not support ESM Integration entry yet.
+Try use other entry points like `./esm` or `./web` instead.
 
-```JSON
-{
-    "optimizeDeps": {
-        "exclude": ["@wasm-fmt/dart_fmt"]
-    }
-}
-```
+## Web
+
+For web environments, you need to initialize WASM module manually:
 
-<details>
-<summary>
-If you cannot change the vite config, you can use another import entry
+```javascript
+import init, { format } from "@wasm-fmt/dart_fmt/web";
+
+await init();
+
+const source = `void main() { print('Hello, World!'); }`;
+
+const formatted = format(source);
+console.log(formatted);
+```
 
-</summary>
+### Vite
 
 ```JavaScript
 import init, { format } from "@wasm-fmt/dart_fmt/vite";
 
+await init();
 // ...
 ```
 
-</details>
+## Entry Points
+
+- `.` - Auto-detects environment (Node.js uses node, default is ESM)
+- `./node` - Node.js `module-sync` compatible, include CommonJS (no init required)
+- `./esm` - ESM environments like modern Node.js/Deno (no init required)
+- `./web` - Web browsers (requires manual init)
+- `./vite` - Vite bundler (requires manual init)
+
+# Build from source
+
+```bash
+# 1. install Dart https://dart.dev/get-dart
+
+# 2. clone this repo
+git clone https://github.com/wasm-fmt/dart_fmt.git
+
+# 3. install dependencies
+dart pub get
+
+# 4. build
+npm run build
+
+# 5. test
+npm run test:node
+```

package/dart_fmt.d.ts

@@ -1,32 +1,31 @@
-export function format(input: string, filename: string, config?: LayoutConfig): string;
+/**
+ * WASM formatter for Dart.
+ *
+ * @example
+ * ```ts
+ * import { format } from "@wasm-fmt/dart_fmt";
+ *
+ * const input = "void main() { print('Hello, World!'); }";
+ * const output = format(input, "main.dart");
+ * ```
+ *
+ * @module
+ */
 
 interface LayoutConfig {
+	/** The preferred line width at which the formatter should wrap lines */
 	line_width?: number;
+	/** The type of line ending to apply to the printed input */
 	line_ending?: "lf" | "crlf";
-	language_version?: string;
 }
 
-export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
-
-export type InitOutput = unknown;
-
-// export type SyncInitInput = BufferSource | WebAssembly.Module;
-// /**
-// * Instantiates the given `module`, which can either be bytes or
-// * a precompiled `WebAssembly.Module`.
-// *
-// * @param {SyncInitInput} module
-// *
-// * @returns {InitOutput}
-// */
-// export function initSync(module: SyncInitInput): InitOutput;
+/** Configuration for the Dart formatter */
+export interface Config extends LayoutConfig {
+	/** The Dart language version to use for formatting */
+	language_version?: string;
+}
 
 /**
-* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
-* for everything else, calls `WebAssembly.instantiate` directly.
-*
-* @param {InitInput | Promise<InitInput>} module_or_path
-*
-* @returns {Promise<InitOutput>}
-*/
-export default function init(module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>;
+ * Format the entire Dart source code string.
+ */
+export function format(input: string, filename: string, config?: Config): string;