feat: use oxc to generate dts

Author: chrisbbreuer

README.md

@@ -8,14 +8,13 @@
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
 <!-- [![Codecov][codecov-src]][codecov-href] -->
 
-This Bun plugin generates dts files for your TypeScript project.
+This Bun plugin generates dts files for your TypeScript projects.
 
 ## Features
 
-- Automatic dts generation based on your entrypoints
-- Honors & inherits your `tsconfig.json` settings
+- Automatic & fast dts generation
+- Powered by oxc-transform & isolatedDeclarations
 - Monorepo support
-- Dependency-free _(aside from TS & Bun)_
 
 ## Usage
 
@@ -39,19 +38,16 @@ await Bun.build({
 
   plugins: [
     dts({
-      cwd: import.meta.dir, // optional
-      rootDir: `${import.meta.dir}/src`, // optional
-      outdir: 'dist/types', // optional
+      cwd: process.cwd(), // optional
+      root: `./src`, // optional, default: './src'
+      outdir: './dist/types', // optional, default: './dist'
     }),
   ],
 })
 
 console.log('Build complete ✅')
 ```
 
-> [!NOTE]
-> Please note, this plugin honors your `tsconfig.json` `compilerOptions.outDir` setting. If you want to override this, you can do so by setting the `outdir`, `rootDir`, and `cwd` option in the build object.
-
 ## Testing
 
 ```bash
@@ -93,6 +89,7 @@ We would like to extend our thanks to the following sponsors for funding Stacks
 
 Many thanks to the following core technologies & people who have contributed to this package:
 
+- [Oxc](https://oxc.rs/)
 - [Chris Breuer](https://github.com/chrisbbreuer)
 - [All Contributors](../../contributors)
 

build.ts

@@ -7,7 +7,6 @@ const result = await Bun.build({
   entrypoints: ['src/index.ts'],
   outdir: 'dist',
   target: 'bun',
-
   plugins: [dts()],
 })
 

package.json

@@ -15,6 +15,7 @@
   },
   "keywords": [
     "dts",
+    "oxc",
     "generation",
     "typescript",
     "types",
@@ -57,6 +58,7 @@
     "changelogen": "^0.5.7",
     "commitizen": "^4.3.1",
     "cz-git": "^1.9.4",
+    "oxc-transform": "^0.30.5",
     "lint-staged": "^15.2.10",
     "simple-git-hooks": "^2.11.1",
     "typescript": "^5.6.2"

src/index.ts

@@ -1,158 +1,56 @@
 import fs from 'node:fs'
 import p from 'node:path'
-import process from 'node:process'
+import path from 'node:path'
 import type { BunPlugin } from 'bun'
-import ts from 'typescript'
-
-export interface TsOptions {
-  rootDir: string
-  base: string
-  declaration: boolean
-  emitDeclarationOnly: boolean
-  noEmit: boolean
-  declarationMap?: boolean
-  outDir?: ts.CompilerOptions['outDir']
-  [index: string]: any
-}
+import { isolatedDeclaration } from 'oxc-transform'
 
 export interface DtsOptions {
-  /**
-   * The base directory of the source files. If not provided, it
-   * will use the current working directory of the process.
-   * @default process.cwd()
-   */
-  base?: string
-
-  /**
-   * The TypeScript compiler options. If not provided, it will use
-   * the `tsconfig.json` file in the current working directory.
-   */
-  compiler?: ts.CompilerOptions
-
-  /**
-   * The path to the `tsconfig.json` file. If not provided, it will
-   * use the `tsconfig.json` file in the current working directory.
-   */
-  tsconfigPath?: string
-
-  /**
-   * The current working directory. If not provided, it will
-   * use the current working directory of the process.
-   */
   cwd?: string
-
-  /**
-   * The root directory of the source files. Please note,
-   * it is relative to the current working directory.
-   * @default 'src'
-   */
   root?: string
-
-  /**
-   * The output directory of the declaration files. Please note,
-   * it is relative to the current working directory.
-   * @default 'dist'
-   */
-  outdir?: ts.CompilerOptions['outDir'] // sadly, the bundler uses `outdir` instead of `outDir` and to avoid confusion, we'll use `outdir` here
-
-  /**
-   * The files to include. If not provided, it will include all files in the
-   * `tsconfig.json` file, or the Bun build entry points if provided.
-   */
-  include?: string[]
+  outdir?: string
+  // sourcemap?: boolean
 }
 
-/**
- * Generate declaration files for the TypeScript source files.
- * @param entryPoints The entry points of the TypeScript source files.
- * @param options The options for generating the declaration files.
- */
 export async function generate(entryPoints: string | string[], options?: DtsOptions): Promise<void> {
-  const cwd = options?.cwd ?? process.cwd()
-  const configPath = options?.tsconfigPath ? p.resolve(cwd, options.tsconfigPath) : p.resolve(cwd, 'tsconfig.json')
-  const root = p.resolve(cwd, (options?.root ?? 'src').replace(/^\.\//, ''))
-  const outDir = p.resolve(cwd, options?.outdir ?? './dist')
-
-  // console.log('TSConfig path:', configPath)
-  // console.log('Root directory:', root)
-  // console.log('Output directory:', outDir)
-  // console.log('Entry points:', entryPoints)
-
-  try {
-    const configFile = ts.readConfigFile(configPath, ts.sys.readFile)
-    if (configFile.error) {
-      throw new Error(`Failed to read tsconfig: ${configFile.error.messageText}`)
-    }
-
-    const parsedCommandLine = ts.parseJsonConfigFileContent(configFile.config, ts.sys, cwd)
-
-    if (parsedCommandLine.errors.length) {
-      throw new Error(`Failed to parse tsconfig: ${parsedCommandLine.errors.map((e) => e.messageText).join(', ')}`)
-    }
-
-    const compilerOptions: ts.CompilerOptions = {
-      ...parsedCommandLine.options,
-      ...options?.compiler,
-      rootDir: root,
-      outDir,
-      declaration: true,
-      emitDeclarationOnly: true,
-      noEmit: false,
-      skipLibCheck: true,
-      isolatedModules: true,
-    }
-
-    // console.log('Compiler Options:', JSON.stringify(compilerOptions, null, 2))
-
-    const host = ts.createCompilerHost(compilerOptions)
-
-    // Ensure entryPoints is an array and resolve to absolute paths
-    const entryPointsArray = (Array.isArray(entryPoints) ? entryPoints : [entryPoints]).map((entry) =>
-      p.resolve(cwd, entry),
-    )
-
-    // Use only the entry points that are within the root directory
-    const validEntryPoints = entryPointsArray.filter((entry) => entry.startsWith(root))
-
-    if (validEntryPoints.length === 0) {
-      throw new Error('No valid entry points found within the specified root directory')
-    }
+  // console.log('Generate function called with:')
+  // console.log('EntryPoints:', entryPoints)
+  // console.log('Options:', options)
 
-    const program = ts.createProgram(validEntryPoints, compilerOptions, host)
-
-    const emitResult = program.emit(undefined, (fileName, data) => {
-      if (fileName.endsWith('.d.ts') || fileName.endsWith('.d.ts.map')) {
-        const outputPath = p.join(outDir, p.relative(root, fileName))
-        const dir = p.dirname(outputPath)
-        if (!fs.existsSync(dir)) {
-          fs.mkdirSync(dir, { recursive: true })
-        }
-        fs.writeFileSync(outputPath, data)
-        // console.log('Emitted:', outputPath)
-      }
-    })
-
-    const allDiagnostics = ts.getPreEmitDiagnostics(program).concat(emitResult.diagnostics)
-
-    if (allDiagnostics.length) {
-      const formatHost: ts.FormatDiagnosticsHost = {
-        getCanonicalFileName: (path) => path,
-        getCurrentDirectory: ts.sys.getCurrentDirectory,
-        getNewLine: () => ts.sys.newLine,
-      }
-      const message = ts.formatDiagnosticsWithColorAndContext(allDiagnostics, formatHost)
-      console.error(message)
-    }
-
-    if (emitResult.emitSkipped) {
-      throw new Error('TypeScript compilation failed')
+  const files = Array.isArray(entryPoints) ? entryPoints : [entryPoints]
+  const cwd = options?.cwd ?? process.cwd()
+  const root = options?.root ?? 'src'
+  const outdir = options?.outdir ?? './dist/'
+
+  // console.log('Resolved options:')
+  // console.log('CWD:', cwd)
+  // console.log('Root:', root)
+  // console.log('Outdir:', outdir)
+
+  for (const file of files) {
+    const fullPath = path.join(cwd, file)
+    // console.log(`Processing file: ${fullPath}`)
+
+    if (fs.existsSync(fullPath)) {
+      const ts = fs.readFileSync(fullPath, 'utf-8')
+      const dts = isolatedDeclaration(fullPath, ts, { sourcemap: false })
+      const code = dts.code
+      const relativePath = path.relative(path.join(cwd, root), fullPath)
+      const outputPath = path.join(cwd, outdir, relativePath.replace(/\.ts$/, '.d.ts'))
+      // console.log(`Writing declaration file: ${outputPath}`)
+      write(outputPath, code)
+    } else {
+      console.warn(`File not found: ${fullPath}`)
     }
-  } catch (error) {
-    console.error('Error generating types:', error)
-    throw error
   }
 }
 
+function write(file: string, content: string) {
+  const dir = path.dirname(file)
+  fs.mkdirSync(dir, { recursive: true })
+  fs.writeFileSync(file, content)
+  // console.log(`File written: ${file}`)
+}
+
 /**
  * A Bun plugin to generate declaration files for the TypeScript source files.
  * @param options The options for generating the declaration files.
@@ -164,17 +62,14 @@ export function dts(options?: DtsOptions): BunPlugin {
     async setup(build) {
       const entrypoints = [...build.config.entrypoints].sort()
       const root = options?.root ?? build.config.root ?? 'src'
+      const outdir = options?.outdir ?? './dist/'
+      const cwd = options?.cwd ?? process.cwd()
 
       await generate(entrypoints, {
+        ...options,
         root,
-        include: entrypoints, // Use only the entrypoints from build.ts
-        cwd: options?.cwd || process.cwd(),
-        tsconfigPath: options?.tsconfigPath,
-        outdir: options?.outdir || build.config.outdir,
-        compiler: {
-          ...options?.compiler,
-          paths: undefined, // Remove the paths option to avoid generating extra dts files
-        },
+        outdir,
+        cwd,
       })
     },
   }