feat: add processor option to specify program processor

fix #436

BREAKING CHANGE: The plugin will no longer heuristically
detect Vue dependencies to determine whether to use
@vue/language-core for creating the program. You now need
to explicitly specify the processor option to tell the
plugin which method to use for program creation.

Author: qmhc

README.md

@@ -245,12 +245,18 @@ If you start with official Vite template, you should specify the `tsconfigPath`:
 }
 ```
 
-One more, if you are using it in a **Vue project**, you need to install `@vue/language-core` as a peer dependency for the plugin:
+One more, if you are using it in a **Vue project**, you need to install `@vue/language-core` as a peer dependency, and specify `processor` to `'vue'` for the plugin:
 
 ```sh
 pnpm i -D @vue/language-core
 ```
 
+```ts
+{
+  plugins: [dts({ processor: 'vue' })]
+}
+```
+
 ## FAQ
 
 Here are some FAQ's and solutions.
@@ -341,10 +347,17 @@ export interface Resolver {
 }
 
 export interface PluginOptions {
+  /**
+   * Specify which (program) process you prefer.
+   *
+   * @default 'ts'
+   */
+  processor?: 'vue' | 'ts',
+
   /**
    * Specify root directory.
    *
-   * Defaults to the 'root' of the Vite config, or `process.cwd()` if using Rollup.
+   * The default is to use the root provided by the scaffold; if none is provided, it defaults to `process.cwd()`.
    */
   root?: string,
 

README.zh-CN.md

@@ -245,12 +245,18 @@ pnpm i -D @microsoft/api-extractor
 }
 ```
 
-还有一点，如果你正在一个 **Vue 项目** 中使用它，你需要安装 `@vue/language-core` 作为一个必要依赖：
+还有一点，如果你正在一个 **Vue 项目** 中使用它，你需要安装 `@vue/language-core` 作为一个必要依赖，并修改 `processor` 为 `'vue'`：
 
 ```sh
 pnpm i -D @vue/language-core
 ```
 
+```ts
+{
+  plugins: [dts({ processor: 'vue' })]
+}
+```
+
 ## 常见问题
 
 此处将收录一些常见的问题并提供一些解决方案。
@@ -358,10 +364,17 @@ export interface Resolver {
 }
 
 export interface PluginOptions {
+  /**
+   * 指定使用哪种处理程序
+   *
+   * @default 'ts'
+   */
+  processor?: 'vue' | 'ts',
+
   /**
    * 指定根目录
    *
-   * 默认为 Vite 配置的 'root'，使用 Rollup 为 `process.cwd()`
+   * 默认使用脚手架提供的根目录，如果没提供则为 `process.cwd()`
    */
   root?: string,
 

examples/vue-rolldown/rolldown.config.ts

@@ -26,6 +26,7 @@ export default defineConfig({
   ],
   plugins: [
     dts({
+      processor: 'vue',
       outDirs: ['dist', 'types'],
       // include: ['src/index.ts'],
       exclude: ['src/ignore'],

examples/vue-rspack/rspack.config.mjs

@@ -73,6 +73,7 @@ export default defineConfig({
   mode: 'production',
   plugins: [
     dts({
+      processor: 'vue',
       outDirs: ['dist', 'types'],
       // include: ['src/index.ts'],
       exclude: ['src/ignore'],

examples/vue-vite/vite.config.ts

@@ -34,6 +34,7 @@ export default defineConfig({
   plugins: [
     // @ts-ignore
     dts({
+      processor: 'vue',
       copyDtsFiles: true,
       outDirs: [
         'dist',

package.json

@@ -32,6 +32,7 @@
     "@commitlint/cli": "^19.8.0",
     "@commitlint/types": "^19.8.0",
     "@eslint/js": "^9.31.0",
+    "@microsoft/api-extractor": "^7.52.9",
     "@rspack/core": "^1.3.9",
     "@types/debug": "^4.1.12",
     "@types/minimist": "^1.2.5",
@@ -42,6 +43,7 @@
     "@vexip-ui/eslint-config": "^1.2.1",
     "@vexip-ui/prettier-config": "^1.0.0",
     "@vexip-ui/scripts": "^1.4.1",
+    "@vue/language-core": "^3.0.4",
     "conventional-changelog-cli": "^5.0.0",
     "eslint": "^9.31.0",
     "execa": "^9.5.2",

packages/unplugin-dts/package.json

@@ -128,10 +128,6 @@
     "magic-string": "^0.30.17",
     "unplugin": "^2.3.2"
   },
-  "devDependencies": {
-    "@microsoft/api-extractor": "^7.52.5",
-    "@vue/language-core": "~3.0.1"
-  },
   "peerDependencies": {
     "@microsoft/api-extractor": ">=7",
     "@rspack/core": "^1",

packages/unplugin-dts/src/core/processor/index.ts

@@ -0,0 +1,14 @@
+import type ts from 'typescript'
+
+export interface ProgramProcessor {
+  createParsedCommandLine: (_ts: typeof ts, host: ts.ParseConfigHost, configPath: string) => ts.ParsedCommandLine,
+  createProgram: typeof ts.createProgram
+}
+
+export async function loadProgramProcessor(type: 'vue' | 'ts' = 'ts'): Promise<ProgramProcessor> {
+  if (type === 'vue') {
+    return await import('./vue')
+  }
+
+  return await import('./ts')
+}