feat(tsgo): support custom tsgo binary path (#164)

ryoppippi · sxzz · web-flow · commit 1394d24b5303 · 2026-01-18T16:08:13.000Z
Co-authored-by: Kevin Deng &lt;sxzz@sxzz.moe&gt;
diff --git a/src/generate.ts b/src/generate.ts
@@ -104,7 +104,7 @@ export function createGeneratePlugin({
 
     async buildStart(options) {
       if (tsgo) {
-        tsgoDist = await runTsgo(rootDir, tsconfig, sourcemap)
+        tsgoDist = await runTsgo(rootDir, tsconfig, sourcemap, tsgo.path)
       } else if (!oxc) {
         // tsc
         if (parallel) {
diff --git a/src/options.ts b/src/options.ts
@@ -192,21 +192,42 @@ export interface Options extends GeneralOptions, TscOptions {
   /**
    * **[Experimental]** Enables DTS generation using `tsgo`.
    *
-   * To use this option, make sure `@typescript/native-preview` is installed as a dependency.
+   * To use this option, make sure `@typescript/native-preview` is installed as a dependency,
+   * or provide a custom path to the `tsgo` binary using the `path` option.
    *
    * **Note:** This option is not yet recommended for production environments.
    * `tsconfigRaw` and `isolatedDeclarations` options will be ignored when this option is enabled.
+   *
+   *
+   * ```ts
+   * // Use tsgo from `@typescript/native-preview` dependency
+   * tsgo: true
+   *
+   * // Use custom tsgo path (e.g., managed by Nix)
+   * tsgo: { path: '/path/to/tsgo' }
+   * ```
    */
-  tsgo?: boolean
+  tsgo?: boolean | TsgoOptions
+}
+
+export interface TsgoOptions {
+  enabled?: boolean
+
+  /**
+   * Custom path to the `tsgo` binary.
+   */
+  path?: string
 }
 
 type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U
+
 export type OptionsResolved = Overwrite<
   Required<Omit<Options, 'compilerOptions'>>,
   {
     tsconfig?: string
     oxc: IsolatedDeclarationsOptions | false
     tsconfigRaw: TsConfigJson
+    tsgo: Omit<TsgoOptions, 'enabled'> | false
   }
 >
 
@@ -237,6 +258,13 @@ export function resolveOptions({
   oxc,
   tsgo = false,
 }: Options): OptionsResolved {
+  // Resolve tsgo option
+  if (tsgo === true) {
+    tsgo = {}
+  } else if (typeof tsgo === 'object' && tsgo.enabled === false) {
+    tsgo = false
+  }
+
   let resolvedTsconfig: TsConfigJsonResolved | undefined
   if (tsconfig === true || tsconfig == null) {
     const { config, path } = getTsconfig(cwd) || {}
diff --git a/src/tsgo.ts b/src/tsgo.ts
@@ -13,18 +13,31 @@ const spawnAsync = (...args: Parameters<typeof spawn>) =>
     child.on('error', (error) => reject(error))
   })
 
+export async function getTsgoPathFromNodeModules(): Promise<string> {
+  const tsgoPkg = import.meta.resolve('@typescript/native-preview/package.json')
+  const { default: getExePath } = await import(
+    new URL('lib/getExePath.js', tsgoPkg).href
+  )
+  return getExePath()
+}
+
 export async function runTsgo(
   rootDir: string,
   tsconfig?: string,
   sourcemap?: boolean,
-) {
+  tsgoPath?: string,
+): Promise<string> {
   debug('[tsgo] rootDir', rootDir)
 
-  const tsgoPkg = import.meta.resolve('@typescript/native-preview/package.json')
-  const { default: getExePath } = await import(
-    new URL('lib/getExePath.js', tsgoPkg).href
-  )
-  const tsgo = getExePath()
+  let tsgo: string
+  if (tsgoPath) {
+    tsgo = tsgoPath
+    debug('[tsgo] using custom path', tsgo)
+  } else {
+    tsgo = await getTsgoPathFromNodeModules()
+    debug('[tsgo] using tsgo from node_modules', tsgo)
+  }
+
   const tsgoDist = await mkdtemp(path.join(tmpdir(), 'rolldown-plugin-dts-'))
   debug('[tsgo] tsgoDist', tsgoDist)
 
diff --git a/tests/__snapshots__/index.test.ts.snap b/tests/__snapshots__/index.test.ts.snap
@@ -391,6 +391,44 @@ export { type A };
 "
 `;
 
+exports[`tsgo with custom path 1`] = `
+"// basic.d.ts
+//#region tests/fixtures/basic.d.ts
+declare const foo: number;
+type SomeType<T> = T;
+type FooType = string;
+interface Interface {}
+declare function fn(arg0: SomeType<FooType>, opt: Interface): void;
+declare enum Enum {
+  A = 0,
+  B = 1,
+  C = 2,
+}
+declare class Cls {
+  foo: string;
+  fn(e: Enum): void;
+}
+//#endregion
+export { Cls, Enum, fn, foo };
+// basic.js
+//#region tests/fixtures/basic.ts
+const foo = 42;
+function fn(arg0, opt) {}
+let Enum = /* @__PURE__ */ function(Enum) {
+	Enum[Enum["A"] = 0] = "A";
+	Enum[Enum["B"] = 1] = "B";
+	Enum[Enum["C"] = 2] = "C";
+	return Enum;
+}({});
+var Cls = class {
+	foo;
+	fn(e) {}
+};
+
+//#endregion
+export { Cls, Enum, fn, foo };"
+`;
+
 exports[`tsx 1`] = `
 "// tsx.d.ts
 import { JSX } from "solid-js";
diff --git a/tests/fixtures/basic.tsconfig.json b/tests/fixtures/basic.tsconfig.json
@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "declaration": true
+  },
+  "include": ["basic.ts"]
+}
diff --git a/tests/index.test.ts b/tests/index.test.ts
@@ -3,6 +3,7 @@ import { fileURLToPath } from 'node:url'
 import { rolldownBuild } from '@sxzz/test-utils'
 import { describe, expect, test } from 'vitest'
 import { dts } from '../src/index.ts'
+import { getTsgoPathFromNodeModules } from '../src/tsgo.ts'
 
 const dirname = path.dirname(fileURLToPath(import.meta.url))
 
@@ -513,3 +514,17 @@ test('infer false branch', async () => {
     'T extends Array<infer U> ? (T extends Array<infer U2> ? U2 : U) : ',
   )
 })
+
+test('tsgo with custom path', async () => {
+  const tsgoPath = await getTsgoPathFromNodeModules()
+  const { snapshot } = await rolldownBuild(
+    path.resolve(dirname, 'fixtures/basic.ts'),
+    [
+      dts({
+        tsgo: { path: tsgoPath },
+        tsconfig: path.resolve(dirname, 'fixtures/basic.tsconfig.json'),
+      }),
+    ],
+  )
+  expect(snapshot).toMatchSnapshot()
+})
