@wasm-fmt/graphql_fmt 0.0.0 → 0.2.0

package/README.md

@@ -1,65 +1,71 @@
-# graphql_fmt
+[![Test](https://github.com/wasm-fmt/web_fmt/actions/workflows/test.yml/badge.svg)](https://github.com/wasm-fmt/web_fmt/actions/workflows/test.yml)
 
-GraphQL formatter powered by WASM ported from [pretty_graphql](https://github.com/g-plane/pretty_graphql).
+# Install
 
-## Usage
+[![npm](https://img.shields.io/npm/v/@wasm-fmt/graphql_fmt)](https://www.npmjs.com/package/@wasm-fmt/graphql_fmt)
 
-### Node.js
-
-```js
-import init from "graphql_fmt";
+```bash
+npm install @wasm-fmt/graphql_fmt
+```
 
-const { format } = await init();
+[![jsr.io](https://jsr.io/badges/@fmt/graphql-fmt)](https://jsr.io/@fmt/graphql-fmt)
 
-const result = format(
-	"query { user { name } }",
-	"query.graphql",
-	{
-		indentStyle: "space",
-		indentWidth: 2,
-		lineWidth: 80,
-		lineEnding: "lf",
-	}
-);
+```bash
+npx jsr add @fmt/graphql-fmt
 ```
 
-### Vite
+# Usage
+
+## Node.js / Deno / Bun / Bundler
 
-Add `"@wasm-fmt/graphql-fmt"` to `optimizeDeps.exclude` in your vite config:
+```javascript
+import { format } from "@wasm-fmt/graphql_fmt";
 
-```JSON
-{
-    "optimizeDeps": {
-        "exclude": ["@wasm-fmt/graphql-fmt"]
-    }
-}
+const input = `query { user { name } }`;
+
+const formatted = format(input);
+console.log(formatted);
 ```
 
-<details>
-<summary>
-If you cannot change the vite config, you can use another import entry
+## Web
+
+For web environments, you need to initialize WASM module manually:
 
-</summary>
+```javascript
+import init, { format } from "@wasm-fmt/graphql_fmt/web";
 
-```js
-import init from "@wasm-fmt/graphql-fmt/vite";
+await init();
 
-const { format } = await init();
+const input = `query { user { name } }`;
 
-const result = format(
-	"query { user { name } }",
-	"query.graphql",
-	{
-		indentStyle: "space",
-		indentWidth: 2,
-		lineWidth: 80,
-		lineEnding: "lf",
-	}
-);
+const formatted = format(input);
+console.log(formatted);
 ```
 
-</details>
+### Vite
 
-## Configuration
+```JavaScript
+import init, { format } from "@wasm-fmt/graphql_fmt/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)
+
+# Configuration
 
 See [pretty_graphql configuration docs](https://pretty-graphql.netlify.app/) for all available options.
+
+# Credits
+
+Thanks to:
+
+- The [pretty_graphql](https://github.com/g-plane/pretty_graphql) project

package/graphql_fmt.d.ts

@@ -1,54 +1,25 @@
+/**
+ * WASM formatter for GraphQL using pretty_graphql.
+ *
+ * @example
+ * ```ts
+ * import { format } from "@wasm-fmt/graphql_fmt";
+ *
+ * const input = "{ hello }";
+ * const output = format(input);
+ * ```
+ *
+ * @module
+ */
+
+import type { Config } from "./options.d.ts";
+
 /* tslint:disable */
 /* eslint-disable */
 
-export interface Config extends LayoutConfig {
-	/**
-	 *  See {@link https://pretty-graphql.netlify.app/}
-	 */
-	[other: string]: any;
-}
-
-
-interface LayoutConfig {
-	indentStyle?: "tab" | "space";
-	indentWidth?: number;
-	lineWidth?: number;
-	lineEnding?: "lf" | "crlf";
-}
-
-
-export function format(src: string, filename: string, config?: Config | 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 __wbindgen_export: (a: number, b: number) => number;
-  readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
-  readonly __wbindgen_export3: (a: number) => void;
-  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
-  readonly __wbindgen_export4: (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;
-
 /**
-* 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>;
+ * Formats the given GraphQL code with the provided Configuration.
+ * @param src - The GraphQL code to format
+ * @param config - Optional formatter config
+ */
+export function format(src: string, config?: Config | null): string;