@ast-grep/napi 0.27.3 → 0.28.0

package/index.d.ts

@@ -9,12 +9,15 @@
  */
 export interface NapiConfig {
   /** The rule object, see https://ast-grep.github.io/reference/rule.html */
-  rule: any
+  rule: import('./manual').Rule
   /** See https://ast-grep.github.io/guide/rule-config.html#constraints */
-  constraints?: any
+  constraints?: Record<string, import('./manual').Rule>
   /** Available languages: html, css, js, jsx, ts, tsx */
   language?: Lang
-  /** https://ast-grep.github.io/reference/yaml.html#transform */
+  /**
+   * transform is NOT useful in JavaScript. You can use JS code to directly transform the result.
+   * https://ast-grep.github.io/reference/yaml.html#transform
+   */
   transform?: any
   /** https://ast-grep.github.io/guide/rule-config/utility-rule.html */
   utils?: any
@@ -60,7 +63,8 @@ export const enum Lang {
   Rust = 'Rust',
   Scala = 'Scala',
   Sql = 'Sql',
-  Swift = 'Swift'
+  Swift = 'Swift',
+  Yaml = 'Yaml'
 }
 export interface Edit {
   /** The start position of the edit */

package/manual.d.ts

@@ -0,0 +1,78 @@
+export type Strictness =
+  | 'cst' | 'smart' | 'ast' | 'relaxed' | 'signature'
+
+export interface PatternObject {
+  context: string
+  selector?: string
+  strictness?: Strictness
+}
+
+export type PatternStyle = string | PatternObject
+
+export interface Relation extends Rule {
+  /**
+   * Specify how relational rule will stop relative to the target node.
+   */
+  stopBy?: 'neighbor' | 'end' | Rule
+  /** Specify the tree-sitter field in parent node. Only available in has/inside rule. */
+  field?: string
+}
+
+export interface NthChildObject {
+  /** The position in nodes' sibling list. It can be a number of An+B string */
+  position: string | number
+  ofRule?: Rule
+  reverse?: boolean
+}
+
+/**
+ * NthChild can have these types:
+ * * number: the position of the node in the sibling list.
+ * * string: An + B style string like CSS nth-child selector.
+ * * object: An object with `position` and `ofRule` fields.
+ */
+export type NthChild = number | string | NthChildObject
+
+export interface Rule {
+  /** A pattern string or a pattern object. */
+  pattern?: PatternStyle
+  /** The kind name of the node to match. You can look up code's kind names in playground. */
+  kind?: string
+  /** A Rust regular expression to match the node's text. https://docs.rs/regex/latest/regex/#syntax */
+  regex?: string
+  /**
+   * `nthChild` accepts number, string or object.
+   * It specifies the position in nodes' sibling list. */
+  nthChild?: NthChild
+
+  // relational
+  /**
+   * `inside` accepts a relational rule object.
+   * the target node must appear inside of another node matching the `inside` sub-rule. */
+  inside?: Relation
+  /**
+   * `has` accepts a relational rule object.
+   * the target node must has a descendant node matching the `has` sub-rule. */
+  has?: Relation
+  /**
+   * `precedes` accepts a relational rule object.
+   * the target node must appear before another node matching the `precedes` sub-rule. */
+  precedes?: Relation
+  /**
+   * `follows` accepts a relational rule object.
+   * the target node must appear after another node matching the `follows` sub-rule. */
+  follows?: Relation
+  // composite
+  /**
+   * A list of sub rules and matches a node if all of sub rules match.
+   * The meta variables of the matched node contain all variables from the sub-rules. */
+  all?: Array<Rule>
+  /**
+   * A list of sub rules and matches a node if any of sub rules match.
+   * The meta variables of the matched node only contain those of the matched sub-rule. */
+  any?: Array<Rule>
+  /** A single sub-rule and matches a node if the sub rule does not match. */
+  not?: Rule
+  /** A utility rule id and matches a node if the utility rule matches. */
+  matches?: string
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ast-grep/napi",
-  "version": "0.27.3",
+  "version": "0.28.0",
   "description": "Search and Rewrite code at large scale using precise AST pattern",
   "homepage": "https://ast-grep.github.io",
   "main": "index.js",
@@ -14,6 +14,7 @@
     "rewrite"
   ],
   "files": [
+    "manual.d.ts",
     "index.d.ts",
     "index.js"
   ],
@@ -67,14 +68,14 @@
     }
   },
   "optionalDependencies": {
-    "@ast-grep/napi-win32-x64-msvc": "0.27.3",
-    "@ast-grep/napi-darwin-x64": "0.27.3",
-    "@ast-grep/napi-linux-x64-gnu": "0.27.3",
-    "@ast-grep/napi-win32-ia32-msvc": "0.27.3",
-    "@ast-grep/napi-darwin-arm64": "0.27.3",
-    "@ast-grep/napi-win32-arm64-msvc": "0.27.3",
-    "@ast-grep/napi-linux-arm64-gnu": "0.27.3",
-    "@ast-grep/napi-linux-arm64-musl": "0.27.3",
-    "@ast-grep/napi-linux-x64-musl": "0.27.3"
+    "@ast-grep/napi-win32-x64-msvc": "0.28.0",
+    "@ast-grep/napi-darwin-x64": "0.28.0",
+    "@ast-grep/napi-linux-x64-gnu": "0.28.0",
+    "@ast-grep/napi-win32-ia32-msvc": "0.28.0",
+    "@ast-grep/napi-darwin-arm64": "0.28.0",
+    "@ast-grep/napi-win32-arm64-msvc": "0.28.0",
+    "@ast-grep/napi-linux-arm64-gnu": "0.28.0",
+    "@ast-grep/napi-linux-arm64-musl": "0.28.0",
+    "@ast-grep/napi-linux-x64-musl": "0.28.0"
   }
 }