vite-plugin-dts 3.1.0 → 3.1.1

package/README.md

@@ -8,6 +8,9 @@
   <a href="https://www.npmjs.com/package/vite-plugin-dts">
     <img src="https://img.shields.io/npm/v/vite-plugin-dts?color=orange&label=" alt="version" />
   </a>
+  <a href="https://github.com/qmhc/vite-plugin-dts/blob/main/LICENSE">
+    <img src="https://img.shields.io/npm/l/vite-plugin-dts" alt="license" />
+  </a>
 </p>
 
 **English** | [中文](./README.zh-CN.md)
@@ -40,34 +43,7 @@ export default defineConfig({
 })
 ```
 
-In your component:
-
-```vue
-<template>
-  <div></div>
-</template>
-
-<script lang="ts">
-// using defineComponent for inferring types
-import { defineComponent } from 'vue'
-
-export default defineComponent({
-  name: 'Component'
-})
-</script>
-```
-
-```vue
-<script setup lang="ts">
-defineProps<{
-  color: 'blue' | 'red'
-}>()
-</script>
-
-<template>
-  <div>{{ color }}</div>
-</template>
-```
+Starting with `3.0.0`, you can use this plugin with Rollup.
 
 ## FAQ
 
@@ -75,19 +51,19 @@ Here are some FAQ's and solutions.
 
 ### Missing some declaration files after build (before `1.7.0`)
 
-By default, the `skipDiagnostics` option is set to `true` which means type diagnostic will be skipped during the build process (some projects may have diagnostic tools such as `vue-tsc`). If there are some files with type errors which interrupt the build process, these files will not be emitted (declaration files won't be generated).
+By default, the `skipDiagnostics` option is set to `true` which means type diagnostics will be skipped during the build process (some projects may have diagnostic tools such as `vue-tsc`). Files with type errors which interrupt the build process will not be emitted (declaration files won't be generated).
 
-If your project doesn't use type diagnostic tools, you can set `skipDiagnostics: false` and `logDiagnostics: true` to turn on diagnostic and logging features of this plugin. It will help you check the type errors during build and log error information to the terminal.
+If your project doesn't use type diagnostic tools, you can set `skipDiagnostics: false` and `logDiagnostics: true` to turn on diagnostic and logging features of this plugin. Type errors during build will be logged to the terminal.
 
 ### Type error when using both `script` and `setup-script` in Vue component (before `3.0.0`)
 
-This is usually caused by using the `defineComponent` function in both `script` and `setup-script`. When `vue/compiler-sfc` compiles these files, the default export result from `script` gets merged with the parameter object of `defineComponent` from `setup-script`. This is incompatible with parameters and types returned from `defineComponent`, which results in a type error.
+This is usually caused by using the `defineComponent` function in both `script` and `setup-script`. When `vue/compiler-sfc` compiles these files, the default export result from `script` gets merged with the parameter object of `defineComponent` from `setup-script`. This is incompatible with parameters and types returned from `defineComponent`. This results in a type error.
 
-Here is a simple [example](https://github.com/qmhc/vite-plugin-dts/blob/main/examples/vue/components/BothScripts.vue). You should remove the `defineComponent` which in `script` and export a native object directly.
+Here is a simple [example](https://github.com/qmhc/vite-plugin-dts/blob/main/examples/vue/components/BothScripts.vue). You should remove the `defineComponent` in `script` and export a native object directly.
 
 ### Type errors that are unable to infer types from packages in `node_modules`
 
-This is an existing issue when TypeScript infers types from packages located in `node_modules` through soft links (pnpm). Please refer to [this TypeScript issue](https://github.com/microsoft/TypeScript/issues/42873). The current workaround is to add `baseUrl` to your `tsconfig.json` and specify the `paths` for these packages:
+This is an existing [TypeScript issue](https://github.com/microsoft/TypeScript/issues/42873) where TypeScript infers types from packages located in `node_modules` through soft links (pnpm). A workaround is to add `baseUrl` to your `tsconfig.json` and specify the `paths` for these packages:
 
 ```json
 {
@@ -116,11 +92,11 @@ export interface Resolver {
    */
   name: string,
   /**
-   * Determine whether the resolve supports the file
+   * Determine whether the resolver supports the file
    */
   supports: (id: string) => void | boolean,
   /**
-   * Transform the source file to declaration files
+   * Transform source to declaration files
    */
   transform: (payload: {
     id: string,
@@ -136,39 +112,39 @@ export interface PluginOptions {
   /**
    * Specify root directory
    *
-   * By Default it base on 'root' of your Vite config, or `process.cwd()` if using Rollup
+   * Defaults to the 'root' of the Vite config, or `process.cwd()` if using Rollup
    */
   root?: string,
 
   /**
-   * Specify declaration files output directory
+   * Output directory for declaration files
    *
-   * Can be specified a array to output to multiple directories
+   * Can be an array to output to multiple directories
    *
-   * By Default it base on 'build.outDir' of your Vite config, or `outDir` of tsconfig.json if using Rollup
+   * Defaults to 'build.outDir' of the Vite config, or `outDir` of tsconfig.json if using Rollup
    */
   outDir?: string | string[],
 
   /**
-   * Manually set the root path of the entry files, useful in monorepo
+   * Override root path of entry files (useful in monorepos)
    *
-   * The output path of each file will be calculated base on it
+   * The output path of each file will be calculated based on the value provided
    *
-   * By Default it is the smallest public path for all files
+   * The default is the smallest public path for all source files
    */
   entryRoot?: string,
 
   /**
-   * Strictly restrict declaration files output inside `outDir`
+   * Restrict declaration files output to `outDir`
    *
-   * Because if `entryRoot` is specified, declaration files maybe outside `outDir`
+   * If true, generated declaration files outside `outDir` will be ignored
    *
    * @default true
    */
   strictOutput?: boolean,
 
   /**
-   * Specify a CompilerOptions to override
+   * Override compilerOptions
    *
    * @default null
    */
@@ -177,9 +153,9 @@ export interface PluginOptions {
   /**
    * Specify tsconfig.json path
    *
-   * Plugin also resolve include and exclude files from tsconfig.json
+   * Plugin resolves `include` and `exclude` globs from tsconfig.json
    *
-   * By default plugin will find config form root if not specify
+   * If not specified, plugin will find config file from root
    */
   tsconfigPath?: string,
 
@@ -191,68 +167,64 @@ export interface PluginOptions {
   resolvers?: Resolver[],
 
   /**
-   * Set which paths should exclude when transform aliases
-   *
-   * If it's regexp, it will test the original import path directly
+   * Set which paths should be excluded when transforming aliases
    *
    * @default []
    */
   aliasesExclude?: (string | RegExp)[],
 
   /**
-   * Whether transform file name '.vue.d.ts' to '.d.ts'
+   * Whether to transform file names ending in '.vue.d.ts' to '.d.ts'
    *
    * @default false
    */
   cleanVueFileName?: boolean,
 
   /**
-   * Whether transform dynamic import to static
-   *
-   * Force `true` when `rollupTypes` is effective
+   * Whether to transform dynamic imports to static (eg `import('vue').DefineComponent` to `import { DefineComponent } from 'vue'`)
    *
-   * eg. `import('vue').DefineComponent` to `import { DefineComponent } from 'vue'`
+   * Value is forced to `true` when `rollupTypes` is `true`
    *
    * @default false
    */
   staticImport?: boolean,
 
   /**
-   * Manual set include glob
+   * Override `include` glob
    *
-   * By Default it base on `include` option of the tsconfig.json
+   * Defaults to `include` property of tsconfig.json
    */
   include?: string | string[],
 
   /**
-   * Manual set exclude glob
+   * Override `exclude` glob
    *
-   * By Default it base on `exclude` option of the tsconfig.json, be `'node_module/**'` when empty
+   * Defaults to `exclude` property of tsconfig.json or `'node_module/**'` if not supplied.
    */
   exclude?: string | string[],
 
   /**
-   * Whether remove those `import 'xxx'`
+   * Whether to remove `import 'xxx'`
    *
    * @default true
    */
   clearPureImport?: boolean,
 
   /**
-   * Whether generate types entry file
+   * Whether to generate types entry file(s)
    *
-   * When `true` will from package.json types field if exists or `${outDir}/index.d.ts`
+   * When `true`, uses package.json `types` property if it exists or `${outDir}/index.d.ts`
    *
-   * Force `true` when `rollupTypes` is effective
+   * Value is forced to `true` when `rollupTypes` is `true`
    *
    * @default false
    */
   insertTypesEntry?: boolean,
 
   /**
-   * Set whether rollup declaration files after emit
+   * Rollup type declaration files after emitting them
    *
-   * Power by `@microsoft/api-extractor`, it will start a new program which takes some time
+   * Powered by `@microsoft/api-extractor` - time-intensive operation
    *
    * @default false
    */
@@ -267,35 +239,35 @@ export interface PluginOptions {
   bundledPackages?: string[],
 
   /**
-   * Whether copy .d.ts source files into `outDir`
+   * Whether to copy .d.ts source files to `outDir`
    *
    * @default false
-   * @remarks Before 2.0 it defaults to true
+   * @remarks Before 2.0, the default was `true`
    */
   copyDtsFiles?: boolean,
 
   /**
-   * Specify the log level of plugin
+   * Logging level for this plugin
    *
-   * By Default it base on 'logLevel' option of your Vite config
+   * Defaults to the 'logLevel' property of your Vite config
    */
   logLevel?: LogLevel,
 
   /**
-   * Hook after diagnostic emitted
+   * Hook called after diagnostic is emitted
    *
-   * According to the length to judge whether there is any type error
+   * According to the `diagnostics.length`, you can judge whether there is any type error
    *
    * @default () => {}
    */
   afterDiagnostic?: (diagnostics: readonly ts.Diagnostic[]) => MaybePromise<void>,
 
   /**
-   * Hook before each declaration file is written
+   * Hook called prior to writing each declaration file
    *
-   * You can transform declaration file's path and content through it
+   * This allows you to transform the path or content
    *
-   * The file will be skipped when return exact `false`
+   * The file will be skipped when the return value `false`
    *
    * @default () => {}
    */
@@ -311,9 +283,7 @@ export interface PluginOptions {
   },
 
   /**
-   * Hook after built
-   *
-   * It wil be called after all declaration files are written
+   * Hook called after all declaration files are written
    *
    * @default () => {}
    */

package/README.zh-CN.md

@@ -8,6 +8,9 @@
   <a href="https://www.npmjs.com/package/vite-plugin-dts">
     <img src="https://img.shields.io/npm/v/vite-plugin-dts?color=orange&label=" alt="version" />
   </a>
+  <a href="https://github.com/qmhc/vite-plugin-dts/blob/main/LICENSE">
+    <img src="https://img.shields.io/npm/l/vite-plugin-dts" alt="license" />
+  </a>
 </p>
 
 **中文** | [English](./README.md)
@@ -40,34 +43,7 @@ export default defineConfig({
 })
 ```
 
-在你的组件中:
-
-```vue
-<template>
-  <div></div>
-</template>
-
-<script lang="ts">
-// 使用 defineComponent 来进行类型推断
-import { defineComponent } from 'vue'
-
-export default defineComponent({
-  name: 'Component'
-})
-</script>
-```
-
-```vue
-<script setup lang="ts">
-defineProps<{
-  color: 'blue' | 'red'
-}>()
-</script>
-
-<template>
-  <div>{{ color }}</div>
-</template>
-```
+从 `3.0.0` 开始，你可以在 Rollup 中使用该插件。
 
 ## 常见问题
 
@@ -116,7 +92,7 @@ export interface Resolver {
    */
   name: string,
   /**
-   * 决定是否要解析文件
+   * 判断解析器是否支持该文件
    */
   supports: (id: string) => void | boolean,
   /**
@@ -136,7 +112,7 @@ export interface PluginOptions {
   /**
    * 指定根目录
    *
-   * 默认基于 Vite 配置的 'root'，使用 Rollup 时基于 `process.cwd()`
+   * 默认为 Vite 配置的 'root'，使用 Rollup 为 `process.cwd()`
    */
   root?: string,
 
@@ -145,30 +121,30 @@ export interface PluginOptions {
    *
    * 可以指定一个数组来输出到多个目录中
    *
-   * 默认基于 Vite 配置的 'build.outDir'，使用 Rollup 时基于 tsconfig.json 的 `outDir`
+   * 默认为 Vite 配置的 'build.outDir'，使用 Rollup 时为 tsconfig.json 的 `outDir`
    */
   outDir?: string | string[],
 
   /**
-   * 用于手动设置入口文件的根路径，通常用在 monorepo
+   * 用于手动设置入口文件的根路径（通常用在 monorepo）
    *
    * 在计算每个文件的输出路径时将基于该路径
    *
-   * 默认为所有文件的最小公共路径
+   * 默认为所有源文件的最小公共路径
    */
   entryRoot?: string,
 
   /**
-   * 严格限制类型文件生产在 `outDir` 内
+   * 限制类型文件生成在 `outDir` 内
    *
-   * 由于当指定了 `entryRoot` 时，类型文件有可能位于 `outDir` 之外
+   * 如果为 `true`，生成在 `outDir` 外的文件将被忽略
    *
    * @default true
    */
   strictOutput?: boolean,
 
   /**
-   * 指定一个用于覆写的 CompilerOptions
+   * 覆写 CompilerOptions
    *
    * @default null
    */
@@ -177,9 +153,9 @@ export interface PluginOptions {
   /**
    * 指定 tsconfig.json 的路径
    *
-   * 插件也会解析 tsconfig.json 的 include 和 exclude 选项
+   * 插件会解析 tsconfig.json 的 include 和 exclude 选项
    *
-   * 未指定时插件默认从根目录寻找配置
+   * 未指定时插件默认从根目录开始寻找配置文件
    */
   tsconfigPath?: string,
 
@@ -205,12 +181,10 @@ export interface PluginOptions {
   cleanVueFileName?: boolean,
 
   /**
-   * 是否将动态引入转换为静态
+   * 是否将动态引入转换为静态（例如：`import('vue').DefineComponent` 转换为 `import { DefineComponent } from 'vue'`）
    *
    * 开启 `rollupTypes` 时强制为 `true`
    *
-   * 例如将 `import('vue').DefineComponent` 转换为 `import { DefineComponent } from 'vue'`
-   *
    * @default false
    */
   staticImport?: boolean,
@@ -230,18 +204,18 @@ export interface PluginOptions {
   exclude?: string | string[],
 
   /**
-   * 是否移除那些 `import 'xxx'`
+   * 是否移除 `import 'xxx'`
    *
    * @default true
    */
   clearPureImport?: boolean,
 
   /**
-   * 是否生成类型声明入口
+   * 是否生成类型入口文件
    *
-   * 当为 `true` 时会基于 package.json 的 types 字段生成，或者 `${outDir}/index.d.ts`
+   * 当为 `true` 时会基于 package.json 的 `types` 字段生成，或者 `${outDir}/index.d.ts`
    *
-   * 当开启打包类型文件时强制为 `true`
+   * 当开启 `rollupTypes` 时强制为 `true`
    *
    * @default false
    */
@@ -250,7 +224,7 @@ export interface PluginOptions {
   /**
    * 设置是否在发出类型文件后将其打包
    *
-   * 基于 `@microsoft/api-extractor`，由于这开启了一个新的进程，将会消耗一些时间
+   * 基于 `@microsoft/api-extractor`，过程将会消耗一些时间
    *
    * @default false
    */
@@ -268,7 +242,7 @@ export interface PluginOptions {
    * 是否将源码里的 .d.ts 文件复制到 `outDir`
    *
    * @default false
-   * @remarks 在 2.0 之前它默认为 true
+   * @remarks 在 2.0 之前它默认为 `true`
    */
   copyDtsFiles?: boolean,
 
@@ -282,7 +256,7 @@ export interface PluginOptions {
   /**
    * 获取诊断信息后的钩子
    *
-   * 可以根据参数 length 来判断有误类型错误
+   * 可以根据 `diagnostics.length` 来判断有误类型错误
    *
    * @default () => {}
    */
@@ -309,9 +283,7 @@ export interface PluginOptions {
   },
 
   /**
-   * 构建后回调钩子
-   *
-   * 将会在所有类型文件被写入后调用
+   * 在所有类型文件被写入后调用的钩子
    *
    * @default () => {}
    */

package/dist/index.cjs

@@ -497,6 +497,7 @@ ${kolorist.cyan(
         entries = { ...input };
       }
       logger = logger || console;
+      aliases = aliases || [];
       libName = "_default";
       indexName = defaultIndex;
       bundleDebug("parse options");

package/dist/index.d.ts

@@ -11,11 +11,11 @@ interface Resolver {
      */
     name: string;
     /**
-     * Determine whether the resolve supports the file
+     * Determine whether the resolver supports the file
      */
     supports: (id: string) => void | boolean;
     /**
-     * Transform the source file to declaration files
+     * Transform source to declaration files
      */
     transform: (payload: {
         id: string;
@@ -33,35 +33,35 @@ interface PluginOptions {
     /**
      * Specify root directory
      *
-     * By Default it base on 'root' of your Vite config, or `process.cwd()` if using Rollup
+     * Defaults to the 'root' of the Vite config, or `process.cwd()` if using Rollup
      */
     root?: string;
     /**
-     * Specify declaration files output directory
+     * Output directory for declaration files
      *
-     * Can be specified a array to output to multiple directories
+     * Can be an array to output to multiple directories
      *
-     * By Default it base on 'build.outDir' of your Vite config, or `outDir` of tsconfig.json if using Rollup
+     * Defaults to 'build.outDir' of the Vite config, or `outDir` of tsconfig.json if using Rollup
      */
     outDir?: string | string[];
     /**
-     * Manually set the root path of the entry files, useful in monorepo
+     * Override root path of entry files (useful in monorepos)
      *
-     * The output path of each file will be calculated base on it
+     * The output path of each file will be calculated based on the value provided
      *
-     * By Default it is the smallest public path for all files
+     * The default is the smallest public path for all source files
      */
     entryRoot?: string;
     /**
-     * Strictly restrict declaration files output inside `outDir`
+     * Restrict declaration files output to `outDir`
      *
-     * Because if `entryRoot` is specified, declaration files maybe outside `outDir`
+     * If true, generated declaration files outside `outDir` will be ignored
      *
      * @default true
      */
     strictOutput?: boolean;
     /**
-     * Specify a CompilerOptions to override
+     * Override compilerOptions
      *
      * @default null
      */
@@ -69,9 +69,9 @@ interface PluginOptions {
     /**
      * Specify tsconfig.json path
      *
-     * Plugin also resolve include and exclude files from tsconfig.json
+     * Plugin resolves `include` and `exclude` globs from tsconfig.json
      *
-     * By default plugin will find config form root if not specify
+     * If not specified, plugin will find config file from root
      */
     tsconfigPath?: string;
     /**
@@ -81,61 +81,57 @@ interface PluginOptions {
      */
     resolvers?: Resolver[];
     /**
-     * Set which paths should exclude when transform aliases
-     *
-     * If it's regexp, it will test the original import path directly
+     * Set which paths should be excluded when transforming aliases
      *
      * @default []
      */
     aliasesExclude?: (string | RegExp)[];
     /**
-     * Whether transform file name '.vue.d.ts' to '.d.ts'
+     * Whether to transform file names ending in '.vue.d.ts' to '.d.ts'
      *
      * @default false
      */
     cleanVueFileName?: boolean;
     /**
-     * Whether transform dynamic import to static
-     *
-     * Force `true` when `rollupTypes` is effective
+     * Whether to transform dynamic imports to static (eg `import('vue').DefineComponent` to `import { DefineComponent } from 'vue'`)
      *
-     * eg. `import('vue').DefineComponent` to `import { DefineComponent } from 'vue'`
+     * Value is forced to `true` when `rollupTypes` is `true`
      *
      * @default false
      */
     staticImport?: boolean;
     /**
-     * Manual set include glob
+     * Override `include` glob
      *
-     * By Default it base on `include` option of the tsconfig.json
+     * Defaults to `include` property of tsconfig.json
      */
     include?: string | string[];
     /**
-     * Manual set exclude glob
+     * Override `exclude` glob
      *
-     * By Default it base on `exclude` option of the tsconfig.json, be `'node_module/**'` when empty
+     * Defaults to `exclude` property of tsconfig.json or `'node_module/**'` if not supplied.
      */
     exclude?: string | string[];
     /**
-     * Whether remove those `import 'xxx'`
+     * Whether to remove `import 'xxx'`
      *
      * @default true
      */
     clearPureImport?: boolean;
     /**
-     * Whether generate types entry file
+     * Whether to generate types entry file(s)
      *
-     * When `true` will from package.json types field if exists or `` `${outDir}/index.d.ts` ``
+     * When `true`, uses package.json `types` property if it exists or `${outDir}/index.d.ts`
      *
-     * Force `true` when `rollupTypes` is effective
+     * Value is forced to `true` when `rollupTypes` is `true`
      *
      * @default false
      */
     insertTypesEntry?: boolean;
     /**
-     * Set whether rollup declaration files after emit
+     * Rollup type declaration files after emitting them
      *
-     * Power by `@microsoft/api-extractor`, it will start a new program which takes some time
+     * Powered by `@microsoft/api-extractor` - time-intensive operation
      *
      * @default false
      */
@@ -148,32 +144,32 @@ interface PluginOptions {
      */
     bundledPackages?: string[];
     /**
-     * Whether copy .d.ts source files into `outDir`
+     * Whether to copy .d.ts source files to `outDir`
      *
      * @default false
-     * @remarks Before 2.0 it defaults to true
+     * @remarks Before 2.0, the default was `true`
      */
     copyDtsFiles?: boolean;
     /**
-     * Specify the log level of plugin
+     * Logging level for this plugin
      *
-     * By Default it base on 'logLevel' option of your Vite config
+     * Defaults to the 'logLevel' property of your Vite config
      */
     logLevel?: LogLevel;
     /**
-     * Hook after diagnostic emitted
+     * Hook called after diagnostic is emitted
      *
-     * According to the length to judge whether there is any type error
+     * According to the `diagnostics.length`, you can judge whether there is any type error
      *
      * @default () => {}
      */
     afterDiagnostic?: (diagnostics: readonly ts.Diagnostic[]) => MaybePromise<void>;
     /**
-     * Hook before each declaration file is written
+     * Hook called prior to writing each declaration file
      *
-     * You can transform declaration file's path and content through it
+     * This allows you to transform the path or content
      *
-     * The file will be skipped when return exact `false`
+     * The file will be skipped when the return value `false`
      *
      * @default () => {}
      */
@@ -182,9 +178,7 @@ interface PluginOptions {
         content?: string;
     };
     /**
-     * Hook after built
-     *
-     * It wil be called after all declaration files are written
+     * Hook called after all declaration files are written
      *
      * @default () => {}
      */

package/dist/index.mjs

@@ -497,6 +497,7 @@ ${cyan(
         entries = { ...input };
       }
       logger = logger || console;
+      aliases = aliases || [];
       libName = "_default";
       indexName = defaultIndex;
       bundleDebug("parse options");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-dts",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "type": "module",
   "license": "MIT",
   "author": "qmhc",
@@ -77,7 +77,6 @@
     "@vue/eslint-config-standard": "^8.0.1",
     "@vue/eslint-config-typescript": "^11.0.3",
     "conventional-changelog-cli": "^3.0.0",
-    "cross-env": "^7.0.3",
     "eslint": "^8.43.0",
     "execa": "^7.1.1",
     "husky": "^8.0.3",