@wasm-fmt/oxc_fmt 0.0.0 → 0.2.0

package/README.md

@@ -0,0 +1,71 @@
+[![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)
+
+# Install
+
+[![npm](https://img.shields.io/npm/v/@wasm-fmt/oxc_fmt)](https://www.npmjs.com/package/@wasm-fmt/oxc_fmt)
+
+```bash
+npm install @wasm-fmt/oxc_fmt
+```
+
+[![jsr.io](https://jsr.io/badges/@fmt/oxc-fmt)](https://jsr.io/@fmt/oxc-fmt)
+
+```bash
+npx jsr add @fmt/oxc-fmt
+```
+
+# Usage
+
+## Node.js / Deno / Bun / Bundler
+
+```javascript
+import { format } from "@wasm-fmt/oxc_fmt";
+
+const input = `const foo  =  "bar"`;
+
+const formatted = format(input, "index.js");
+console.log(formatted);
+```
+
+## Web
+
+For web environments, you need to initialize WASM module manually:
+
+```javascript
+import init, { format } from "@wasm-fmt/oxc_fmt/web";
+
+await init();
+
+const input = `const foo  =  "bar"`;
+
+const formatted = format(input, "index.js");
+console.log(formatted);
+```
+
+### Vite
+
+```JavaScript
+import init, { format } from "@wasm-fmt/oxc_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 [oxc formatter configuration docs](https://oxc.rs/docs/guide/usage/formatter/config.html) and [prettier options](https://prettier.io/docs/options) for all available options.
+
+# Credits
+
+Thanks to:
+
+- The [oxc](https://github.com/oxc-project/oxc) project

package/layout_config.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Layout configuration options shared across all formatters.
+ */
+export interface LayoutConfig {
+	/** Indentation style. Defaults to "space". */
+	indentStyle?: "tab" | "space";
+
+	/** Number of spaces per indentation level. Defaults to 2. */
+	indentWidth?: number;
+
+	/** Maximum line width before wrapping. Defaults to 80. */
+	lineWidth?: number;
+
+	/** Line ending style. Defaults to "lf". */
+	lineEnding?: "lf" | "crlf";
+}

package/options.d.ts

@@ -0,0 +1,114 @@
+import type { LayoutConfig } from "./layout_config.d.ts";
+
+/**
+ * Configuration options for OXC formatter.
+ *
+ * @see {@link https://oxc.rs/docs/guide/usage/formatter/config.html}
+ * @see {@link https://prettier.io/docs/options}
+ */
+export interface Config extends LayoutConfig {
+	/** The style for quotes. Defaults to "double". */
+	singleQuote?: boolean;
+
+	/** The style for JSX quotes. Defaults to "double". */
+	jsxSingleQuote?: boolean;
+
+	/** When properties in objects are quoted. Defaults to "as-needed". */
+	quoteProps?: "as-needed" | "consistent" | "preserve";
+
+	/** Print trailing commas wherever possible in multi-line comma-separated syntactic structures. Defaults to "all". */
+	trailingComma?: "all" | "es5" | "none";
+
+	/** Whether the formatter prints semicolons for all statements. Defaults to true. */
+	semi?: boolean;
+
+	/** Whether to add non-necessary parentheses to arrow functions. Defaults to "always". */
+	arrowParens?: "always" | "avoid";
+
+	/** Whether to insert spaces around brackets in object literals. Defaults to true. */
+	bracketSpacing?: boolean;
+
+	/** Whether to hug the closing bracket of multiline HTML/JSX tags to the end of the last line. Defaults to false. */
+	bracketSameLine?: boolean;
+
+	/** Attribute position style. Defaults to false. */
+	singleAttributePerLine?: boolean;
+
+	/** Whether to expand object and array literals to multiple lines. Defaults to "auto". */
+	objectWrap?: "preserve" | "collapse";
+
+	/** Controls the position of operators in binary expressions. Defaults to "end". */
+	experimentalOperatorPosition?: "start" | "end";
+
+	/** Try prettier's new ternary formatting before it becomes the default behavior. Defaults to false. */
+	experimentalTernaries?: boolean;
+
+	/** Enable formatting for embedded languages (e.g., CSS, SQL, GraphQL) within template literals. Defaults to "auto". */
+	embeddedLanguageFormatting?: "auto" | "off";
+
+	/** Sort import statements. By default disabled. */
+	experimentalSortImports?: SortImportsOptions;
+
+	/** Enable Tailwind CSS class sorting in JSX class/className attributes. Defaults to None (disabled). */
+	experimentalTailwindcss?: TailwindcssOptions;
+}
+
+/** Options for sorting import statements. */
+export interface SortImportsOptions {
+	/** Partition imports by newlines. Default is `false`. */
+	partitionByNewline?: boolean;
+
+	/** Partition imports by comments. Default is `false`. */
+	partitionByComment?: boolean;
+
+	/** Sort side effects imports. Default is `false`. */
+	sortSideEffects?: boolean;
+
+	/** Sort order (asc or desc). Default is ascending ("asc"). */
+	order?: "asc" | "desc";
+
+	/** Ignore case when sorting. Default is `true`. */
+	ignoreCase?: boolean;
+
+	/** Whether to insert blank lines between different import groups. Default is `true`. */
+	newlinesBetween?: boolean;
+
+	/** Prefixes for internal imports. Defaults to `["~/", "@/"]`. */
+	internalPattern?: string[];
+
+	/** Groups configuration for organizing imports. */
+	groups?: string[][];
+
+	/** Define your own groups for matching very specific imports. */
+	customGroups?: CustomGroupDefinition[];
+}
+
+/** Custom group definition for sort imports. */
+export interface CustomGroupDefinition {
+	/** The name of the custom group. */
+	groupName: string;
+
+	/** Patterns to match import source names against. */
+	elementNamePattern: string[];
+}
+
+/** Options for Tailwind CSS class sorting. */
+export interface TailwindcssOptions {
+	/** Path to your Tailwind CSS configuration file (v3). Default: `"./tailwind.config.js"` */
+	config?: string;
+
+	/** Path to your Tailwind CSS stylesheet (v4). Example: `"./src/app.css"` */
+	stylesheet?: string;
+
+	/** List of custom function names that contain Tailwind CSS classes. Example: `["clsx", "cn", "cva", "tw"]` */
+	functions?: string[];
+
+	/** List of additional attributes to sort (beyond `class` and `className`). Example: `["myClassProp", ":class"]` */
+	attributes?: string[];
+
+	/** Preserve whitespace around classes. Default: `false` */
+	preserveWhitespace?: boolean;
+
+	/** Preserve duplicate classes. Default: `false` */
+	preserveDuplicates?: boolean;
+}

package/oxc_fmt.d.ts

@@ -1,15 +1,22 @@
+/**
+ * WASM formatter for JavaScript/TypeScript using OXC (experimental).
+ *
+ * @example
+ * ```ts
+ * import { format } from "@wasm-fmt/oxc_fmt";
+ *
+ * const input = "const x=1";
+ * const output = format(input, "index.js");
+ * ```
+ *
+ * @module
+ */
+
+import type { Config } from "./options.d.ts";
+
 /* tslint:disable */
 /* eslint-disable */
 
-export interface Config extends LayoutConfig {
-	/**
-	 *  See {@link https://oxc.rs/docs/guide/usage/formatter/config.html}
-	 *  See {@link https://prettier.io/docs/options}
-	 */
-	[other: string]: any;
-}
-
-
 type Mod = "" | "m" | "c";
 type Lang = "j" | "t";
 type X = "" | "x";
@@ -17,47 +24,3 @@ type X = "" | "x";
 export type Filename = `index.${Mod}${Lang}s${X}` | `index.d.${Mod}ts${X}` | (string & {});
 
 export function format(code: string, filename: Filename, config?: Config): string;
-
-
-
-interface LayoutConfig {
-	indentStyle?: "tab" | "space";
-	indentWidth?: number;
-	lineWidth?: number;
-	lineEnding?: "lf" | "crlf";
-}
-
-
-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>;