@ast-grep/napi 0.7.1 → 0.8.0

package/index.d.ts

@@ -19,19 +19,32 @@ export interface Pos {
   index: number
 }
 export interface Range {
+  /** starting position of the range */
   start: Pos
+  /** ending position of the range */
   end: Pos
 }
+/**
+ * Rule configuration similar to YAML
+ * See https://ast-grep.github.io/reference/yaml.html
+ */
 export interface NapiConfig {
+  /** The rule object, see https://ast-grep.github.io/reference/rule.html */
   rule: any
+  /** See https://ast-grep.github.io/guide/rule-config.html#constraints */
   constraints?: any
+  /** Available languages: html, css, js, jsx, ts, tsx */
   language?: FrontEndLanguage
+  /** https://ast-grep.github.io/reference/yaml.html#transform */
   transform?: any
+  /** https://ast-grep.github.io/guide/rule-config/utility-rule.html */
   utils?: any
 }
 export function parseFiles(paths: string[], callback: (err: null | Error, result: SgRoot) => void): Promise<number>
 export interface FindConfig {
+  /** specify the file paths to recursively find files */
   paths: Array<string>
+  /** a Rule object to find what nodes will match */
   matcher: NapiConfig
 }
 export class SgNode {
@@ -39,6 +52,7 @@ export class SgNode {
   isLeaf(): boolean
   isNamed(): boolean
   isNamedLeaf(): boolean
+  /** Returns the string name of the node kind */
   kind(): string
   text(): string
   matches(m: string): boolean
@@ -48,9 +62,12 @@ export class SgNode {
   follows(m: string): boolean
   getMatch(m: string): SgNode | null
   getMultipleMatches(m: string): Array<SgNode>
+  /** Returns the node's SgRoot */
+  getRoot(): SgRoot
   children(): Array<SgNode>
   find(matcher: string | number | NapiConfig): SgNode | null
   findAll(matcher: string | number | NapiConfig): Array<SgNode>
+  /** Finds the child node in the `field` */
   field(name: string): SgNode | null
   parent(): SgNode | null
   child(nth: number): SgNode | null
@@ -60,37 +77,97 @@ export class SgNode {
   prev(): SgNode | null
   prevAll(): Array<SgNode>
 }
+/** Represents the parsed tree of code. */
 export class SgRoot {
+  /** 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 `lang.parse(source)`.
+   */
   filename(): string
 }
 export namespace html {
+  /** Parse a string to an ast-grep instance */
   export function parse(src: string): SgRoot
+  /** Get the `kind` number from its string name. */
   export function kind(kindName: string): number
+  /** Compile a string to ast-grep Pattern. */
   export function pattern(pattern: string): NapiConfig
+  /**
+   * Discover and parse multiple files in Rust.
+   * `config` specifies the file path and matcher.
+   * `callback` will receive matching nodes found in a file.
+   */
   export function findInFiles(config: FindConfig, callback: (err: null | Error, result: SgNode[]) => void): Promise<number>
 }
 export namespace js {
+  /** Parse a string to an ast-grep instance */
   export function parse(src: string): SgRoot
+  /** Get the `kind` number from its string name. */
   export function kind(kindName: string): number
+  /** Compile a string to ast-grep Pattern. */
   export function pattern(pattern: string): NapiConfig
+  /**
+   * Discover and parse multiple files in Rust.
+   * `config` specifies the file path and matcher.
+   * `callback` will receive matching nodes found in a file.
+   */
   export function findInFiles(config: FindConfig, callback: (err: null | Error, result: SgNode[]) => void): Promise<number>
 }
 export namespace jsx {
+  /** Parse a string to an ast-grep instance */
   export function parse(src: string): SgRoot
+  /** Get the `kind` number from its string name. */
   export function kind(kindName: string): number
+  /** Compile a string to ast-grep Pattern. */
   export function pattern(pattern: string): NapiConfig
+  /**
+   * Discover and parse multiple files in Rust.
+   * `config` specifies the file path and matcher.
+   * `callback` will receive matching nodes found in a file.
+   */
   export function findInFiles(config: FindConfig, callback: (err: null | Error, result: SgNode[]) => void): Promise<number>
 }
 export namespace ts {
+  /** Parse a string to an ast-grep instance */
   export function parse(src: string): SgRoot
+  /** Get the `kind` number from its string name. */
   export function kind(kindName: string): number
+  /** Compile a string to ast-grep Pattern. */
   export function pattern(pattern: string): NapiConfig
+  /**
+   * Discover and parse multiple files in Rust.
+   * `config` specifies the file path and matcher.
+   * `callback` will receive matching nodes found in a file.
+   */
   export function findInFiles(config: FindConfig, callback: (err: null | Error, result: SgNode[]) => void): Promise<number>
 }
 export namespace tsx {
+  /** Parse a string to an ast-grep instance */
   export function parse(src: string): SgRoot
+  /** Get the `kind` number from its string name. */
   export function kind(kindName: string): number
+  /** Compile a string to ast-grep Pattern. */
   export function pattern(pattern: string): NapiConfig
+  /**
+   * Discover and parse multiple files in Rust.
+   * `config` specifies the file path and matcher.
+   * `callback` will receive matching nodes found in a file.
+   */
+  export function findInFiles(config: FindConfig, callback: (err: null | Error, result: SgNode[]) => void): Promise<number>
+}
+export namespace css {
+  /** Parse a string to an ast-grep instance */
+  export function parse(src: string): SgRoot
+  /** Get the `kind` number from its string name. */
+  export function kind(kindName: string): number
+  /** Compile a string to ast-grep Pattern. */
+  export function pattern(pattern: string): NapiConfig
+  /**
+   * Discover and parse multiple files in Rust.
+   * `config` specifies the file path and matcher.
+   * `callback` will receive matching nodes found in a file.
+   */
   export function findInFiles(config: FindConfig, callback: (err: null | Error, result: SgNode[]) => void): Promise<number>
 }

package/index.js

@@ -252,7 +252,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { FrontEndLanguage, SgNode, SgRoot, parseFiles, html, js, jsx, ts, tsx } = nativeBinding
+const { FrontEndLanguage, SgNode, SgRoot, parseFiles, html, js, jsx, ts, tsx, css } = nativeBinding
 
 module.exports.FrontEndLanguage = FrontEndLanguage
 module.exports.SgNode = SgNode
@@ -263,3 +263,4 @@ module.exports.js = js
 module.exports.jsx = jsx
 module.exports.ts = ts
 module.exports.tsx = tsx
+module.exports.css = css

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ast-grep/napi",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "Search and Rewrite code at large scale using precise AST pattern",
   "main": "index.js",
   "repository": "https://github.com/ast-grep/ast-grep",
@@ -45,9 +45,9 @@
   "devDependencies": {
     "@napi-rs/cli": "2.16.1",
     "ava": "5.3.1",
-    "chalk": "5.2.0",
+    "chalk": "5.3.0",
     "ts-node": "10.9.1",
-    "typescript": "5.1.3"
+    "typescript": "5.1.6"
   },
   "ava": {
     "require": [
@@ -64,11 +64,11 @@
   },
   "packageManager": "yarn@3.2.3",
   "optionalDependencies": {
-    "@ast-grep/napi-win32-x64-msvc": "0.7.1",
-    "@ast-grep/napi-darwin-x64": "0.7.1",
-    "@ast-grep/napi-linux-x64-gnu": "0.7.1",
-    "@ast-grep/napi-win32-ia32-msvc": "0.7.1",
-    "@ast-grep/napi-darwin-arm64": "0.7.1",
-    "@ast-grep/napi-win32-arm64-msvc": "0.7.1"
+    "@ast-grep/napi-win32-x64-msvc": "0.8.0",
+    "@ast-grep/napi-darwin-x64": "0.8.0",
+    "@ast-grep/napi-linux-x64-gnu": "0.8.0",
+    "@ast-grep/napi-win32-ia32-msvc": "0.8.0",
+    "@ast-grep/napi-darwin-arm64": "0.8.0",
+    "@ast-grep/napi-win32-arm64-msvc": "0.8.0"
   }
 }