@ast-grep/napi 0.32.3 → 0.33.0

package/index.d.ts

@@ -1,6 +1,7 @@
 //-----Type Only Export!-----//
 export type { Pos, Edit, Range } from './types/sgnode'
 export type { NapiConfig, FindConfig, FileOption } from './types/config'
+export type { DynamicLangRegistrations } from './types/registerDynamicLang'
 // Only Rule here. User can use Rule['pattern'], e.g., to get the type of subfield.
 export type { Rule } from './types/rule'
 
@@ -15,5 +16,6 @@ export {
   pattern,
   findInFiles,
 } from './types/api'
+export { registerDynamicLanguage } from './types/registerDynamicLang'
 // deprecated
-export * from './types/deprecated'
+export * from './types/deprecated'

package/index.js

@@ -310,7 +310,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { parseFiles, Lang, SgNode, SgRoot, parse, parseAsync, kind, pattern, findInFiles, html, js, jsx, ts, tsx, css } = nativeBinding
+const { parseFiles, Lang, SgNode, SgRoot, parse, parseAsync, kind, pattern, findInFiles, registerDynamicLanguage, html, js, jsx, ts, tsx, css } = nativeBinding
 
 module.exports.parseFiles = parseFiles
 module.exports.Lang = Lang
@@ -321,6 +321,7 @@ module.exports.parseAsync = parseAsync
 module.exports.kind = kind
 module.exports.pattern = pattern
 module.exports.findInFiles = findInFiles
+module.exports.registerDynamicLanguage = registerDynamicLanguage
 module.exports.html = html
 module.exports.js = js
 module.exports.jsx = jsx

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ast-grep/napi",
-  "version": "0.32.3",
+  "version": "0.33.0",
   "description": "Search and Rewrite code at large scale using precise AST pattern",
   "homepage": "https://ast-grep.github.io",
   "main": "index.js",
@@ -52,7 +52,7 @@
     "typegen": "ts-node scripts/generateTypes.ts"
   },
   "devDependencies": {
-    "@ast-grep/napi": "0.31.1",
+    "@ast-grep/napi": "0.32.3",
     "@biomejs/biome": "1.9.4",
     "@napi-rs/cli": "2.18.4",
     "@types/node": "^22.10.2",
@@ -76,14 +76,14 @@
     }
   },
   "optionalDependencies": {
-    "@ast-grep/napi-win32-x64-msvc": "0.32.3",
-    "@ast-grep/napi-darwin-x64": "0.32.3",
-    "@ast-grep/napi-linux-x64-gnu": "0.32.3",
-    "@ast-grep/napi-win32-ia32-msvc": "0.32.3",
-    "@ast-grep/napi-darwin-arm64": "0.32.3",
-    "@ast-grep/napi-win32-arm64-msvc": "0.32.3",
-    "@ast-grep/napi-linux-arm64-gnu": "0.32.3",
-    "@ast-grep/napi-linux-arm64-musl": "0.32.3",
-    "@ast-grep/napi-linux-x64-musl": "0.32.3"
+    "@ast-grep/napi-win32-x64-msvc": "0.33.0",
+    "@ast-grep/napi-darwin-x64": "0.33.0",
+    "@ast-grep/napi-linux-x64-gnu": "0.33.0",
+    "@ast-grep/napi-win32-ia32-msvc": "0.33.0",
+    "@ast-grep/napi-darwin-arm64": "0.33.0",
+    "@ast-grep/napi-win32-arm64-msvc": "0.33.0",
+    "@ast-grep/napi-linux-arm64-gnu": "0.33.0",
+    "@ast-grep/napi-linux-arm64-musl": "0.33.0",
+    "@ast-grep/napi-linux-x64-musl": "0.33.0"
   }
 }

package/types/api.d.ts

@@ -1,6 +1,6 @@
 import type { SgNode, SgRoot } from './sgnode'
 import type { NapiConfig, FindConfig, FileOption } from './config'
-import type { Lang } from './lang'
+import type { NapiLang } from './lang'
 import type { NamedKinds, TypesMap } from './staticTypes'
 
 export declare function parseFiles<M extends TypesMap>(
@@ -9,7 +9,7 @@ export declare function parseFiles<M extends TypesMap>(
 ): Promise<number>
 /** Parse a string to an ast-grep instance */
 export declare function parse<M extends TypesMap>(
-  lang: Lang,
+  lang: NapiLang,
   src: string,
 ): SgRoot<M>
 /**
@@ -20,17 +20,17 @@ export declare function parse<M extends TypesMap>(
  * for its default behavior and performance tuning tricks.
  */
 export declare function parseAsync<M extends TypesMap>(
-  lang: Lang,
+  lang: NapiLang,
   src: string,
 ): Promise<SgRoot<M>>
 /** Get the `kind` number from its string name. */
 export declare function kind<M extends TypesMap>(
-  lang: Lang,
+  lang: NapiLang,
   kindName: NamedKinds<M>,
 ): number
 /** Compile a string to ast-grep Pattern. */
 export declare function pattern<M extends TypesMap>(
-  lang: Lang,
+  lang: NapiLang,
   pattern: string,
 ): NapiConfig<M>
 /**
@@ -40,7 +40,7 @@ export declare function pattern<M extends TypesMap>(
  * `callback` will receive matching nodes found in a file.
  */
 export declare function findInFiles<M extends TypesMap>(
-  lang: Lang,
+  lang: NapiLang,
   config: FindConfig<M>,
   callback: (err: null | Error, result: SgNode<M>[]) => void,
-): Promise<number>
+): Promise<number>

package/types/config.d.ts

@@ -1,5 +1,5 @@
 import type { Rule } from './rule'
-import type { Lang } from './lang'
+import type { NapiLang } from './lang'
 import type { TypesMap } from './staticTypes'
 
 /**
@@ -11,8 +11,8 @@ export interface NapiConfig<M extends TypesMap = TypesMap> {
   rule: Rule<M>
   /** See https://ast-grep.github.io/guide/rule-config.html#constraints */
   constraints?: Record<string, Rule<M>>
-  /** Available languages: html, css, js, jsx, ts, tsx */
-  language?: Lang
+  /** Builtin Language or custom language */
+  language?: NapiLang
   /**
    * 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
@@ -36,4 +36,4 @@ export interface FindConfig<M extends TypesMap = TypesMap> {
    * It is slightly different from https://ast-grep.github.io/reference/sgconfig.html#languageglobs
    */
   languageGlobs?: Array<string>
-}
+}

package/types/lang.d.ts

@@ -24,3 +24,7 @@ export enum Lang {
   Swift = 'Swift',
   Yaml = 'Yaml',
 }
+
+type CustomLang = string & {}
+
+export type NapiLang = Lang | CustomLang

package/types/registerDynamicLang.d.ts

@@ -0,0 +1,27 @@
+/** The JSON object to register dynamic languages */
+interface LangRegistration {
+  /** the path to the dynamic library */
+  libraryPath: string
+  /** the file extensions of the language. e.g. mojo */
+  extensions: string[]
+  /** the dylib symbol to load ts-language, default is `tree_sitter_{name}` */
+  languageSymbol?: string
+  /** the meta variable leading character, default is $ */
+  metaVarChar?: string
+  /**
+   * An optional char to replace $ in your pattern.
+   * See https://ast-grep.github.io/advanced/custom-language.html#register-language-in-sgconfig-yml
+   */
+  expandoChar?: string
+}
+
+/** A map of language names to their registration information */
+export interface DynamicLangRegistrations {
+  [langName: string]: LangRegistration
+}
+
+/**
+ * @experimental
+ * Register dynamic languages. This function should be called exactly once in the program.
+ */
+export declare function registerDynamicLanguage(langs: DynamicLangRegistrations): void

package/types/staticTypes.d.ts

@@ -103,4 +103,4 @@ export type Kinds<M extends TypesMap = TypesMap> =
 export type RootKind<M extends TypesMap> = NoNever<
   Extract<M[keyof M], { root: true }>['type'],
   Kinds<M>
->
+>