@astral-sh/ruff-wasm-web 0.5.3

package/README.md

@@ -0,0 +1,51 @@
+# Ruff WASM
+
+> **⚠️ WARNING: This API is experimental and may change at any time**
+
+[**Docs**](https://docs.astral.sh/ruff/) | [**Playground**](https://play.ruff.rs/)
+
+An extremely fast Python linter and code formatter, written in Rust.
+
+This is a WASM version of the Ruff API which can be used to lint/format Python in a browser environment.
+
+There are multiple versions for the different wasm-pack targets. See [here](https://rustwasm.github.io/docs/wasm-bindgen/reference/deployment.html) for more info on targets.
+
+- [Bundler](https://www.npmjs.com/package/@astral-sh/ruff-wasm-bundler)
+- [Web](https://www.npmjs.com/package/@astral-sh/ruff-wasm-web)
+- [Node.js](https://www.npmjs.com/package/@astral-sh/ruff-wasm-nodejs)
+
+## Usage
+
+This example uses the wasm-pack web target and is known to work with Vite.
+
+```ts
+import init, { Workspace, type Diagnostic } from '@astral-sh/ruff-api';
+
+const exampleDocument = `print('hello'); print("world")`
+
+await init(); // Initializes WASM module
+
+// These are default settings just to illustrate configuring Ruff
+// Settings info: https://docs.astral.sh/ruff/settings
+const workspace = new Workspace({
+  'line-length': 88,
+  'indent-width': 4,
+  format: {
+    'indent-style': 'space',
+    'quote-style': 'double',
+  },
+  lint: {
+    select: [
+      'E4',
+      'E7',
+      'E9',
+      'F'
+    ],
+  },
+});
+
+// Will contain 1 diagnostic code for E702: Multiple statements on one line
+const diagnostics: Diagnostic[] = workspace.check(exampleDocument);
+
+const formatted = workspace.format(exampleDocument);
+```

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@astral-sh/ruff-wasm-web",
+  "type": "module",
+  "collaborators": [
+    "Charlie Marsh <charlie.r.marsh@gmail.com>"
+  ],
+  "description": "WebAssembly bindings for Ruff",
+  "version": "0.5.3",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/astral-sh/ruff"
+  },
+  "files": [
+    "ruff_wasm_bg.wasm",
+    "ruff_wasm.js",
+    "ruff_wasm.d.ts"
+  ],
+  "main": "ruff_wasm.js",
+  "homepage": "https://docs.astral.sh/ruff",
+  "types": "ruff_wasm.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ]
+}

package/ruff_wasm.d.ts

@@ -0,0 +1,126 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+*/
+export function run(): void;
+
+export interface Diagnostic {
+    code: string | null;
+    message: string;
+    location: {
+        row: number;
+        column: number;
+    };
+    end_location: {
+        row: number;
+        column: number;
+    };
+    fix: {
+        message: string | null;
+        edits: {
+            content: string | null;
+            location: {
+                row: number;
+                column: number;
+            };
+            end_location: {
+                row: number;
+                column: number;
+            };
+        }[];
+    } | null;
+};
+
+
+/**
+*/
+export class Workspace {
+  free(): void;
+/**
+* @returns {string}
+*/
+  static version(): string;
+/**
+* @param {any} options
+*/
+  constructor(options: any);
+/**
+* @returns {any}
+*/
+  static defaultSettings(): any;
+/**
+* @param {string} contents
+* @returns {any}
+*/
+  check(contents: string): any;
+/**
+* @param {string} contents
+* @returns {string}
+*/
+  format(contents: string): string;
+/**
+* @param {string} contents
+* @returns {string}
+*/
+  format_ir(contents: string): string;
+/**
+* @param {string} contents
+* @returns {string}
+*/
+  comments(contents: string): string;
+/**
+* Parses the content and returns its AST
+* @param {string} contents
+* @returns {string}
+*/
+  parse(contents: string): string;
+/**
+* @param {string} contents
+* @returns {string}
+*/
+  tokens(contents: string): string;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly run: () => void;
+  readonly __wbg_workspace_free: (a: number) => void;
+  readonly workspace_version: (a: number) => void;
+  readonly workspace_new: (a: number, b: number) => void;
+  readonly workspace_defaultSettings: (a: number) => void;
+  readonly workspace_check: (a: number, b: number, c: number, d: number) => void;
+  readonly workspace_format: (a: number, b: number, c: number, d: number) => void;
+  readonly workspace_format_ir: (a: number, b: number, c: number, d: number) => void;
+  readonly workspace_comments: (a: number, b: number, c: number, d: number) => void;
+  readonly workspace_parse: (a: number, b: number, c: number, d: number) => void;
+  readonly workspace_tokens: (a: number, b: number, c: number, d: number) => void;
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly __wbindgen_start: () => void;
+}
+
+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;
+
+/**
+* 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 __wbg_init (module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>;