fix: relax parse lang to accept custom lang

HerringtonDarkholme · HerringtonDarkholme · commit a4f720d80fd8 · 2025-01-04T11:28:42.000-05:00
diff --git a/crates/napi/__test__/custom.spec.ts b/crates/napi/__test__/custom.spec.ts
@@ -23,7 +23,6 @@ test('test load custom lang', t => {
     t.pass('This test is not available on this platform')
     return
   }
-  // @ts-expect-error TODO: change type
   const sg = parse('myjson', '{"test": 123}')
   const root = sg.root()
   const node = root.find("123")!
diff --git a/crates/napi/index.d.ts b/crates/napi/index.d.ts
@@ -6,7 +6,6 @@ export type { DynamicLangRegistrations } from './types/registerDynamicLang'
 export type { Rule } from './types/rule'
 
 //-----Runtime Value Export!-----//
-export { registerDynamicLanguage } from './types/registerDynamicLang'
 export { SgRoot, SgNode } from './types/sgnode'
 export { Lang } from './types/lang'
 export {
@@ -17,5 +16,6 @@ export {
   pattern,
   findInFiles,
 } from './types/api'
+export { registerDynamicLanguage } from './types/registerDynamicLang'
 // deprecated
 export * from './types/deprecated'
diff --git a/crates/napi/types/api.d.ts b/crates/napi/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>
diff --git a/crates/napi/types/config.d.ts b/crates/napi/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>
-}
+}
diff --git a/crates/napi/types/lang.d.ts b/crates/napi/types/lang.d.ts
@@ -24,3 +24,7 @@ export enum Lang {
   Swift = 'Swift',
   Yaml = 'Yaml',
 }
+
+type CustomLang = string & {}
+
+export type NapiLang = Lang | CustomLang
diff --git a/crates/napi/types/staticTypes.d.ts b/crates/napi/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>
->
+>

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,6 @@ test('test load custom lang', t => {`
`23`	`23`	`t.pass('This test is not available on this platform')`
`24`	`24`	`return`
`25`	`25`	`}`
`26`		`- // @ts-expect-error TODO: change type`
`27`	`26`	`const sg = parse('myjson', '{"test": 123}')`
`28`	`27`	`const root = sg.root()`
`29`	`28`	`const node = root.find("123")!`
Original file line number	Diff line number	Diff line change
`@@ -24,3 +24,7 @@ export enum Lang {`
`24`	`24`	`Swift = 'Swift',`
`25`	`25`	`Yaml = 'Yaml',`
`26`	`26`	`}`
	`27`	`+`
	`28`	`+type CustomLang = string & {}`
	`29`	`+`
	`30`	`+export type NapiLang = Lang \| CustomLang`