@wasm-fmt/mago_fmt 0.3.1 → 0.4.0

package/README.md

@@ -16,10 +16,10 @@ npx jsr add @fmt/mago-fmt
 
 # Usage
 
-```javascript
-import init, { format } from "@wasm-fmt/mago_fmt";
+## Node.js / Deno / Bun / Bundler
 
-await init();
+```javascript
+import { format } from "@wasm-fmt/mago_fmt";
 
 const input = `<?php
 function hello( \$name ) {
@@ -27,16 +27,18 @@ function hello( \$name ) {
 }
 ?>`;
 
-const formatted = format(input);
+const formatted = format(input, "main.php", {
+	"use-tabs": false,
+	"tab-width": 4,
+	"print-width": 120,
+});
 console.log(formatted);
 ```
 
-with custom options:
+With specific PHP version:
 
 ```javascript
-import init, { format } from "@wasm-fmt/mago_fmt";
-
-await init();
+import { format_with_version } from "@wasm-fmt/mago_fmt";
 
 const input = `<?php
 function hello( \$name ) {
@@ -44,18 +46,20 @@ function hello( \$name ) {
 }
 ?>`;
 
-const formatted = format(input, "main.php", {
-  "use-tabs": false,
-  "tab-width": 4,
-  "print-width": 120,
+const formatted = format_with_version(input, "8.3", "main.php", {
+	"use-tabs": false,
+	"tab-width": 4,
+	"print-width": 120,
 });
 console.log(formatted);
 ```
 
-with specific PHP version:
+## Web
+
+For web environments, you need to initialize WASM module manually:
 
 ```javascript
-import init, { format_with_version } from "@wasm-fmt/mago_fmt";
+import init, { format } from "@wasm-fmt/mago_fmt/web";
 
 await init();
 
@@ -65,47 +69,31 @@ function hello( \$name ) {
 }
 ?>`;
 
-const formatted = format_with_version(input, "8.3", "main.php", {
-  "use-tabs": false,
-  "tab-width": 4,
-  "print-width": 120,
+const formatted = format(input, "main.php", {
+	"use-tabs": false,
+	"tab-width": 4,
+	"print-width": 120,
 });
 console.log(formatted);
 ```
 
-For Vite users:
-
-Add `"@wasm-fmt/mago_fmt"` to `optimizeDeps.exclude` in your vite config:
-
-```JSON
-{
-    "optimizeDeps": {
-        "exclude": ["@wasm-fmt/mago_fmt"]
-    }
-}
-```
-
-<details>
-<summary>
-If you cannot change the vite config, you can use another import entry
-
-</summary>
+### Vite
 
 ```JavaScript
 import init, { format } from "@wasm-fmt/mago_fmt/vite";
 
+await init();
 // ...
 ```
 
-</details>
-
-# How does it work?
-
-[Mago] is an extremely fast PHP linter, formatter, and static analyzer, written in Rust.
-
-This package is a WebAssembly build of the Mago formatter, with a JavaScript wrapper.
+## Entry Points
 
-[Mago]: https://github.com/carthage-software/mago
+- `.` - 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)
 
 # Credits
 

package/jsr.jsonc

@@ -1,33 +1,41 @@
 {
-    "name": "@fmt/mago-fmt",
-    "type": "module",
-    "collaborators": [
-        "magic-akari <akari.ccino@gmail.com>"
-    ],
-    "description": "A WASM based PHP Formatter",
-    "version": "0.3.1",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/wasm-fmt/mago_fmt"
-    },
-    "homepage": "https://github.com/wasm-fmt/mago_fmt",
-    "types": "mago_fmt.d.ts",
-    "sideEffects": [
-        "./snippets/*"
-    ],
-    "keywords": [
-        "wasm",
-        "mago",
-        "PHP",
-        "formatter"
-    ],
-    "publishConfig": {
-        "access": "public"
-    },
-    "exports": "./mago_fmt.js",
-    "exclude": [
-        "!**",
-        "*.tgz"
-    ]
+	"name": "@fmt/mago-fmt",
+	"type": "module",
+	"collaborators": [
+		"magic-akari <akari.ccino@gmail.com>"
+	],
+	"description": "A WASM based PHP Formatter",
+	"version": "0.4.0",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/wasm-fmt/mago_fmt"
+	},
+	"homepage": "https://github.com/wasm-fmt/mago_fmt",
+	"types": "mago_fmt.d.ts",
+	"sideEffects": [
+		"./mago_fmt.js",
+		"./snippets/*"
+	],
+	"keywords": [
+		"wasm",
+		"mago",
+		"PHP",
+		"formatter"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"exports": {
+		".": "./mago_fmt_esm.js",
+		"./esm": "./mago_fmt_esm.js",
+		"./node": "./mago_fmt_node.js",
+		"./bundler": "./mago_fmt.js",
+		"./web": "./mago_fmt_web.js",
+		"./wasm": "./mago_fmt_bg.wasm"
+	},
+	"exclude": [
+		"!**",
+		"*.tgz"
+	]
 }

package/mago_fmt.d.ts

@@ -1,40 +1,12 @@
 /* tslint:disable */
 /* eslint-disable */
 
-export function format(code: string, filename?: string | null, settings?: any | null): string;
-
-export function format_with_version(code: string, php_version: string, filename?: string | null, settings?: any | null): string;
-
-export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
-
-export interface InitOutput {
-  readonly memory: WebAssembly.Memory;
-  readonly format: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
-  readonly format_with_version: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => void;
-  readonly __wbindgen_export: (a: number, b: number) => number;
-  readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
-  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
-  readonly __wbindgen_export3: (a: number, b: number, c: number) => void;
-}
-
-export type SyncInitInput = BufferSource | WebAssembly.Module;
-
 /**
-* Instantiates the given `module`, which can either be bytes or
-* a precompiled `WebAssembly.Module`.
-*
-* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
-*
-* @returns {InitOutput}
-*/
-export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+ * Format PHP code with optional filename and settings.
+ */
+export function format(code: string, filename?: string | null, settings?: any | null): string;
 
 /**
-* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
-* for everything else, calls `WebAssembly.instantiate` directly.
-*
-* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
-*
-* @returns {Promise<InitOutput>}
-*/
-export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;
+ * Format PHP code with specified PHP version, optional filename and settings.
+ */
+export function format_with_version(code: string, php_version: string, filename?: string | null, settings?: any | null): string;