@ast-grep/wasm 0.0.1

package/README.md

@@ -0,0 +1,107 @@
+# @ast-grep/wasm
+
+WebAssembly build of [ast-grep](https://ast-grep.github.io/) for use in browsers and Node.js.
+
+This package provides the same API as [`@ast-grep/napi`](https://www.npmjs.com/package/@ast-grep/napi) but runs in any JavaScript environment that supports WebAssembly, including browsers, Deno, and edge runtimes.
+
+## Installation
+
+```bash
+yarn add @ast-grep/wasm web-tree-sitter
+```
+
+`web-tree-sitter` is a required peer dependency.
+
+## Usage
+
+```js
+import { initializeTreeSitter, setupParser, parse, kind } from '@ast-grep/wasm'
+
+// 1. Initialize the tree-sitter WASM runtime (once)
+await initializeTreeSitter()
+
+// 2. Load a language parser WASM binary
+await setupParser('javascript', '/path/to/tree-sitter-javascript.wasm')
+
+// 3. Parse and search code
+const sg = parse('javascript', 'console.log("hello world")')
+const node = sg.root().find('console.log($ARG)')
+console.log(node.getMatch('ARG').text()) // "hello world"
+```
+
+### Pattern Matching
+
+```js
+// By pattern string
+sg.root().find('console.log($$$ARGS)')
+
+// By kind number
+const k = kind('javascript', 'call_expression')
+sg.root().find(k)
+
+// By rule config (same as YAML rules)
+sg.root().find({
+  rule: { pattern: 'console.log($A)' },
+  constraints: { A: { kind: 'string' } },
+})
+```
+
+### Code Rewriting
+
+```js
+const match = sg.root().find('console.log($A)')
+const edit = match.replace('console.error($A)')
+const newCode = sg.root().commitEdits([edit])
+```
+
+## Supported Languages
+
+bash, c, cpp, csharp, css, elixir, go, haskell, html, java, javascript, json, kotlin, lua, nix, php, python, ruby, rust, scala, swift, tsx, typescript, yaml
+
+## API Reference
+
+See the full [ast-grep API documentation](https://ast-grep.github.io/reference/api.html).
+
+## Building from Source
+
+Requires [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/).
+
+```bash
+# For browser (ES module)
+yarn build
+
+# For Node.js (CommonJS)
+yarn build:nodejs
+
+# For bundlers
+yarn build:bundler
+```
+
+## Testing
+
+```bash
+yarn install
+```
+
+### Rust WASM tests
+
+```bash
+yarn test
+```
+
+> **Note:** `wasm-pack test --node` runs the test harness from a temporary directory.
+> The `test` script sets `NODE_PATH=$PWD/node_modules` so that `web-tree-sitter` and
+> parser WASM files can be resolved. If you run `wasm-pack test --node` directly,
+> set `NODE_PATH` yourself:
+>
+> ```bash
+> NODE_PATH=$PWD/node_modules wasm-pack test --node
+> ```
+
+### JavaScript tests
+
+```bash
+yarn test:js
+```
+
+This builds the WASM package for Node.js and runs AVA tests against it.

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@ast-grep/wasm",
+  "type": "module",
+  "collaborators": [
+    "Herrington Darkholme <2883231+HerringtonDarkholme@users.noreply.github.com>"
+  ],
+  "description": "Search and Rewrite code at large scale using precise AST pattern",
+  "version": "0.0.1",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ast-grep/ast-grep"
+  },
+  "files": [
+    "wasm_bg.wasm",
+    "wasm.js",
+    "wasm.d.ts"
+  ],
+  "main": "wasm.js",
+  "types": "wasm.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ],
+  "keywords": [
+    "ast",
+    "pattern",
+    "codemod",
+    "search",
+    "rewrite"
+  ]
+}

package/wasm.d.ts

@@ -0,0 +1,244 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export class Pos {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * line number starting from 0
+   */
+  line: number;
+  /**
+   * column number starting from 0
+   */
+  column: number;
+  /**
+   * character offset of the position
+   */
+  index: number;
+}
+
+export class Range {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * starting position of the range
+   */
+  start: Pos;
+  /**
+   * ending position of the range
+   */
+  end: Pos;
+}
+
+export class SgNode {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  range(): Range;
+  isLeaf(): boolean;
+  isNamed(): boolean;
+  isNamedLeaf(): boolean;
+  kind(): string;
+  is(kind: string): boolean;
+  text(): string;
+  id(): number;
+  matches(m: any): boolean;
+  inside(m: any): boolean;
+  has(m: any): boolean;
+  precedes(m: any): boolean;
+  follows(m: any): boolean;
+  getMatch(m: string): SgNode | undefined;
+  getMultipleMatches(m: string): SgNode[];
+  getTransformed(m: string): string | undefined;
+  children_nodes(): SgNode[];
+  parent_node(): SgNode | undefined;
+  child(nth: number): SgNode | undefined;
+  ancestors(): SgNode[];
+  next_node(): SgNode | undefined;
+  nextAll(): SgNode[];
+  prev(): SgNode | undefined;
+  prevAll(): SgNode[];
+  find(matcher: any): SgNode | undefined;
+  findAll(matcher: any): SgNode[];
+  field(name: string): SgNode | undefined;
+  fieldChildren(name: string): SgNode[];
+  replace(text: string): WasmEdit;
+  commitEdits(edits: any): string;
+}
+
+export class SgRoot {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * Returns the root SgNode of the ast-grep instance.
+   */
+  root(): SgNode;
+  /**
+   * Returns the path of the file if it is discovered by ast-grep's `findInFiles`.
+   * Returns `"anonymous"` if the instance is created by `parse`.
+   */
+  filename(): string;
+  /**
+   * This method is mainly for debugging tree parsing result.
+   */
+  getInnerTree(): any;
+}
+
+export class WasmEdit {
+  private constructor();
+  free(): void;
+  [Symbol.dispose](): void;
+  /**
+   * The start position of the edit (character offset)
+   */
+  start_pos: number;
+  /**
+   * The end position of the edit (character offset)
+   */
+  end_pos: number;
+  /**
+   * The text to be inserted
+   */
+  inserted_text: string;
+}
+
+/**
+ * Dump a pattern's internal structure for inspection.
+ * `selector` is an optional kind name for contextual patterns.
+ * `strictness` is one of: "cst", "smart", "ast", "relaxed", "signature", "template".
+ * Returns a tree structure showing how ast-grep parses the pattern, including source positions.
+ */
+export function dumpPattern(lang: string, pattern_str: string, selector?: string | null, strictness?: string | null): any;
+
+/**
+ * Initialize the tree-sitter WASM runtime.
+ * Must be called before any other function.
+ */
+export function initializeTreeSitter(): Promise<void>;
+
+/**
+ * Get the `kind` number from its string name.
+ */
+export function kind(lang: string, kind_name: string): number;
+
+/**
+ * Parse a string to an ast-grep instance.
+ */
+export function parse(lang: string, src: string): SgRoot;
+
+/**
+ * Compile a string to ast-grep Pattern config.
+ */
+export function pattern(lang: string, pattern_str: string): any;
+
+/**
+ * Register dynamic languages for parsing.
+ * `langs` is a Map of language name to its registration config
+ * (with `libraryPath` and optional `expandoChar`).
+ * Can be called multiple times; existing languages are updated.
+ */
+export function registerDynamicLanguage(langs: any): Promise<void>;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_wasmedit_free: (a: number, b: number) => void;
+  readonly __wbg_get_wasmedit_start_pos: (a: number) => number;
+  readonly __wbg_set_wasmedit_start_pos: (a: number, b: number) => void;
+  readonly __wbg_get_wasmedit_end_pos: (a: number) => number;
+  readonly __wbg_set_wasmedit_end_pos: (a: number, b: number) => void;
+  readonly __wbg_get_wasmedit_inserted_text: (a: number) => [number, number];
+  readonly __wbg_set_wasmedit_inserted_text: (a: number, b: number, c: number) => void;
+  readonly __wbg_pos_free: (a: number, b: number) => void;
+  readonly __wbg_get_pos_line: (a: number) => number;
+  readonly __wbg_set_pos_line: (a: number, b: number) => void;
+  readonly __wbg_get_pos_column: (a: number) => number;
+  readonly __wbg_set_pos_column: (a: number, b: number) => void;
+  readonly __wbg_get_pos_index: (a: number) => number;
+  readonly __wbg_set_pos_index: (a: number, b: number) => void;
+  readonly __wbg_range_free: (a: number, b: number) => void;
+  readonly __wbg_get_range_start: (a: number) => number;
+  readonly __wbg_set_range_start: (a: number, b: number) => void;
+  readonly __wbg_get_range_end: (a: number) => number;
+  readonly __wbg_set_range_end: (a: number, b: number) => void;
+  readonly __wbg_sgroot_free: (a: number, b: number) => void;
+  readonly sgroot_root: (a: number) => number;
+  readonly sgroot_filename: (a: number) => [number, number];
+  readonly sgroot_getInnerTree: (a: number) => any;
+  readonly __wbg_sgnode_free: (a: number, b: number) => void;
+  readonly sgnode_range: (a: number) => number;
+  readonly sgnode_isLeaf: (a: number) => number;
+  readonly sgnode_isNamed: (a: number) => number;
+  readonly sgnode_isNamedLeaf: (a: number) => number;
+  readonly sgnode_kind: (a: number) => [number, number];
+  readonly sgnode_is: (a: number, b: number, c: number) => number;
+  readonly sgnode_text: (a: number) => [number, number];
+  readonly sgnode_id: (a: number) => number;
+  readonly sgnode_matches: (a: number, b: any) => [number, number, number];
+  readonly sgnode_inside: (a: number, b: any) => [number, number, number];
+  readonly sgnode_has: (a: number, b: any) => [number, number, number];
+  readonly sgnode_precedes: (a: number, b: any) => [number, number, number];
+  readonly sgnode_follows: (a: number, b: any) => [number, number, number];
+  readonly sgnode_getMatch: (a: number, b: number, c: number) => number;
+  readonly sgnode_getMultipleMatches: (a: number, b: number, c: number) => [number, number];
+  readonly sgnode_getTransformed: (a: number, b: number, c: number) => [number, number];
+  readonly sgnode_children_nodes: (a: number) => [number, number];
+  readonly sgnode_parent_node: (a: number) => number;
+  readonly sgnode_child: (a: number, b: number) => number;
+  readonly sgnode_ancestors: (a: number) => [number, number];
+  readonly sgnode_next_node: (a: number) => number;
+  readonly sgnode_nextAll: (a: number) => [number, number];
+  readonly sgnode_prev: (a: number) => number;
+  readonly sgnode_prevAll: (a: number) => [number, number];
+  readonly sgnode_find: (a: number, b: any) => [number, number, number];
+  readonly sgnode_findAll: (a: number, b: any) => [number, number, number, number];
+  readonly sgnode_field: (a: number, b: number, c: number) => number;
+  readonly sgnode_fieldChildren: (a: number, b: number, c: number) => [number, number];
+  readonly sgnode_replace: (a: number, b: number, c: number) => number;
+  readonly sgnode_commitEdits: (a: number, b: any) => [number, number, number, number];
+  readonly initializeTreeSitter: () => any;
+  readonly registerDynamicLanguage: (a: any) => any;
+  readonly parse: (a: number, b: number, c: number, d: number) => [number, number, number];
+  readonly kind: (a: number, b: number, c: number, d: number) => [number, number, number];
+  readonly pattern: (a: number, b: number, c: number, d: number) => [number, number, number];
+  readonly dumpPattern: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number];
+  readonly wasm_bindgen__convert__closures_____invoke__hf6abb6e10d012239: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__closure__destroy__hfe03ac61b9e9de77: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__h626c386f4a0f1908: (a: number, b: number, c: any, d: any) => void;
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly __externref_table_alloc: () => number;
+  readonly __wbindgen_externrefs: WebAssembly.Table;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __externref_table_dealloc: (a: number) => void;
+  readonly __externref_drop_slice: (a: number, b: 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 {{ 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>;