feat: experimental tsgo (#43)

sxzz · web-flow · commit 359c43e587eb · 2025-06-05T04:32:03.000+08:00
diff --git a/README.md b/README.md
@@ -76,7 +76,8 @@ Enabling this option can speed up builds by caching previous results, which is h
 
 **Default:** `true` if your `tsconfig` has [`incremental`](https://www.typescriptlang.org/tsconfig/#incremental) or [`tsBuildInfoFile`](https://www.typescriptlang.org/tsconfig/#tsBuildInfoFile) enabled.
 
-> **Note:** This option is only used when [`isolatedDeclarations`](#isolateddeclarations-boolean--omitisolateddeclarationsoptions-sourcemap) is `false`.
+> [!NOTE]
+> This option is only used when [`isolatedDeclarations`](#isolateddeclarations-boolean--omitisolateddeclarationsoptions-sourcemap) is `false`.
 
 ### `compilerOptions?: TsConfigJson.CompilerOptions`
 
@@ -115,6 +116,17 @@ If `true`, the plugin will prepare all files listed in `tsconfig.json` for `tsc`
 
 This is especially useful when you have a single `tsconfig.json` for multiple projects in a monorepo.
 
+### `tsgo?: boolean | string`
+
+**[Experimental]** Enables DTS generation using [`tsgo`](https://github.com/microsoft/typescript-go).
+
+- To use this option, ensure that `@typescript/native-preview` is installed as a dependency.
+- Set to `true` to enable `tsgo` for the current project.
+- If a string is provided, it should be the root path of your source files.
+
+> [!WARNING]
+> This option is experimental and not yet recommended for production environments.
+
 ## Differences from `rollup-plugin-dts`
 
 ### Isolated Declarations
diff --git a/package.json b/package.json
@@ -41,11 +41,15 @@
     "prepublishOnly": "pnpm run build"
   },
   "peerDependencies": {
+    "@typescript/native-preview": ">=7.0.0-dev.20250601.1",
     "rolldown": "^1.0.0-beta.9",
     "typescript": "^5.0.0",
     "vue-tsc": "~2.2.0"
   },
   "peerDependenciesMeta": {
+    "@typescript/native-preview": {
+      "optional": true
+    },
     "typescript": {
       "optional": true
     },
@@ -70,6 +74,7 @@
     "@types/babel__generator": "^7.27.0",
     "@types/debug": "^4.1.12",
     "@types/node": "^22.15.29",
+    "@typescript/native-preview": "7.0.0-dev.20250601.1",
     "@volar/typescript": "^2.4.14",
     "@vue/language-core": "^2.2.10",
     "bumpp": "^10.1.1",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/generate.ts b/src/generate.ts
@@ -1,4 +1,8 @@
-import { fork, type ChildProcess } from 'node:child_process'
+import { fork, spawn, type ChildProcess } from 'node:child_process'
+import { existsSync } from 'node:fs'
+import { mkdtemp, readFile, rm } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import path from 'node:path'
 import { createBirpc, type BirpcReturn } from 'birpc'
 import Debug from 'debug'
 import { isolatedDeclaration as oxcIsolatedDeclaration } from 'rolldown/experimental'
@@ -20,6 +24,13 @@ const debug = Debug('rolldown-plugin-dts:generate')
 
 const WORKER_URL = import.meta.WORKER_URL || './utils/tsc-worker.ts'
 
+const spawnAsync = (...args: Parameters<typeof spawn>) =>
+  new Promise<void>((resolve, reject) => {
+    const child = spawn(...args)
+    child.on('close', () => resolve())
+    child.on('error', (error) => reject(error))
+  })
+
 export interface TsModule {
   /** `.ts` source code */
   code: string
@@ -40,6 +51,7 @@ export function createGeneratePlugin({
   vue,
   parallel,
   eager,
+  tsgo,
 }: Pick<
   OptionsResolved,
   | 'cwd'
@@ -51,6 +63,7 @@ export function createGeneratePlugin({
   | 'vue'
   | 'parallel'
   | 'eager'
+  | 'tsgo'
 >): Plugin {
   const dtsMap: DtsMap = new Map<string, TsModule>()
 
@@ -68,8 +81,9 @@ export function createGeneratePlugin({
   let childProcess: ChildProcess | undefined
   let rpc: BirpcReturn<TscFunctions> | undefined
   let tscEmit: (options: TscOptions) => TscResult
+  let tsgoDist: string | undefined
 
-  if (parallel) {
+  if (!tsgo && parallel) {
     childProcess = fork(new URL(WORKER_URL, import.meta.url), {
       stdio: 'inherit',
     })
@@ -86,7 +100,29 @@ export function createGeneratePlugin({
     name: 'rolldown-plugin-dts:generate',
 
     async buildStart(options) {
-      if (!parallel && (!isolatedDeclarations || vue)) {
+      if (tsgo) {
+        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()
+        tsgoDist = await mkdtemp(path.join(tmpdir(), 'rolldown-plugin-dts-'))
+        await spawnAsync(
+          tsgo,
+          [
+            '--noEmit',
+            'false',
+            '--declaration',
+            '--emitDeclarationOnly',
+            ...(tsconfig ? ['-p', tsconfig] : []),
+            '--outDir',
+            tsgoDist,
+          ],
+          { stdio: 'inherit' },
+        )
+      } else if (!parallel && (!isolatedDeclarations || vue)) {
         ;({ tscEmit } = await import('./utils/tsc.ts'))
       }
 
@@ -176,7 +212,24 @@ export function createGeneratePlugin({
         let map: SourceMapInput | undefined
         debug('generate dts %s from %s', dtsId, id)
 
-        if (isolatedDeclarations && !RE_VUE.test(id)) {
+        if (tsgo) {
+          if (RE_VUE.test(id))
+            throw new Error('tsgo does not support Vue files.')
+          const dtsPath = path.resolve(
+            tsgoDist!,
+            path.relative(
+              path.resolve(typeof tsgo === 'string' ? tsgo : 'src'),
+              filename_ts_to_dts(id),
+            ),
+          )
+          if (existsSync(dtsPath)) {
+            dtsCode = await readFile(dtsPath, 'utf8')
+          } else {
+            throw new Error(
+              `tsgo did not generate dts file for ${id}, please check your tsconfig.`,
+            )
+          }
+        } else if (isolatedDeclarations && !RE_VUE.test(id)) {
           const result = oxcIsolatedDeclaration(id, code, isolatedDeclarations)
           if (result.errors.length) {
             const [error] = result.errors
@@ -240,8 +293,12 @@ export function createGeneratePlugin({
         }
       : undefined,
 
-    buildEnd() {
+    async buildEnd() {
       childProcess?.kill()
+      if (tsgoDist) {
+        await rm(tsgoDist, { recursive: true, force: true }).catch(() => {})
+        tsgoDist = undefined
+      }
     },
   }
 }
diff --git a/src/options.ts b/src/options.ts
@@ -120,6 +120,15 @@ export interface Options {
    * This is especially useful when you have a single `tsconfig.json` for multiple projects in a monorepo.
    */
   eager?: boolean
+
+  /**
+   * **[Experimental]** Enables DTS generation using `tsgo`.
+   *
+   * To use this option, make sure `@typescript/native-preview` is installed as a dependency.
+   *
+   * **Note:** This option is not yet recommended for production environments.
+   */
+  tsgo?: boolean | string
 }
 
 type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & U
@@ -133,6 +142,8 @@ export type OptionsResolved = Overwrite<
   }
 >
 
+let warnedTsgo = false
+
 export function resolveOptions({
   cwd = process.cwd(),
   tsconfig,
@@ -147,6 +158,7 @@ export function resolveOptions({
   vue = false,
   parallel = false,
   eager = false,
+  tsgo = false,
 }: Options): OptionsResolved {
   let resolvedTsconfig: TsConfigJsonResolved | undefined
   if (tsconfig === true || tsconfig == null) {
@@ -188,6 +200,13 @@ export function resolveOptions({
     isolatedDeclarations.sourcemap = !!compilerOptions.declarationMap
   }
 
+  if (tsgo && !warnedTsgo) {
+    console.warn(
+      'The `tsgo` option is experimental and may change in the future.',
+    )
+    warnedTsgo = true
+  }
+
   return {
     cwd,
     tsconfig,
@@ -201,5 +220,6 @@ export function resolveOptions({
     vue,
     parallel,
     eager,
+    tsgo,
   }
 }
