feat: rename dumpUnimportComponents to dumpComponentsInfo

Author: ilyaliao

examples/vite-vue2/vite.config.ts

@@ -8,7 +8,7 @@ const config: UserConfig = {
     Components({
       transformer: 'vue2',
       dts: 'src/components.d.ts',
-      dumpUnimportComponents: true,
+      dumpComponentsInfo: true,
     }),
   ],
   build: {

examples/vite-vue3/vite.config.ts

@@ -37,7 +37,7 @@ const config: UserConfig = {
           componentPrefix: 'i',
         }),
       ],
-      dumpUnimportComponents: true,
+      dumpComponentsInfo: true,
     }),
   ],
   build: {

src/core/context.ts

@@ -34,7 +34,7 @@ export class Context {
   root = process.cwd()
   sourcemap: string | boolean = true
   alias: Record<string, string> = {}
-  dumpUnimportComponentsPath: string | undefined
+  dumpComponentsInfoPath: string | undefined
 
   constructor(
     private rawOptions: Options,
@@ -43,12 +43,12 @@ export class Context {
     this.sourcemap = rawOptions.sourcemap ?? true
     this.generateDeclaration = throttle(500, this._generateDeclaration.bind(this), { noLeading: false })
 
-    if (this.options.dumpUnimportComponents) {
-      const dumpUnimportComponents = this.options.dumpUnimportComponents === true
+    if (this.options.dumpComponentsInfo) {
+      const dumpComponentsInfo = this.options.dumpComponentsInfo === true
         ? './.unimport-components.json'
-        : this.options.dumpUnimportComponents ?? false
+        : this.options.dumpComponentsInfo ?? false
 
-      this.dumpUnimportComponentsPath = dumpUnimportComponents
+      this.dumpComponentsInfoPath = dumpComponentsInfo
       this.generateComponentsJson = throttle(500, this._generateComponentsJson.bind(this), { noLeading: false })
     }
 

src/core/declaration.ts

@@ -158,7 +158,7 @@ export async function writeDeclaration(ctx: Context, filepath: string, removeUnu
 }
 
 export async function writeComponentsJson(ctx: Context, _removeUnused = false) {
-  if (!ctx.dumpUnimportComponentsPath)
+  if (!ctx.dumpComponentsInfoPath)
     return
 
   const components = [
@@ -173,5 +173,5 @@ export async function writeComponentsJson(ctx: Context, _removeUnused = false) {
     ...resolveTypeImports(ctx.options.types),
   ]
 
-  await writeFile(ctx.dumpUnimportComponentsPath, JSON.stringify(components, null, 2))
+  await writeFile(ctx.dumpComponentsInfoPath, JSON.stringify(components, null, 2))
 }

src/core/unplugin.ts

@@ -70,8 +70,8 @@ export default createUnplugin<Options>((options = {}) => {
             ctx.generateDeclaration()
         }
 
-        if (ctx.options.dumpUnimportComponents && ctx.dumpUnimportComponentsPath) {
-          if (!existsSync(ctx.dumpUnimportComponentsPath))
+        if (ctx.options.dumpComponentsInfo && ctx.dumpComponentsInfoPath) {
+          if (!existsSync(ctx.dumpComponentsInfoPath))
             ctx.generateComponentsJson()
         }
 

src/types.ts

@@ -214,7 +214,7 @@ export interface Options {
    *
    * @default false
    */
-  dumpUnimportComponents?: boolean | string
+  dumpComponentsInfo?: boolean | string
 }
 
 export type ResolvedOptions = Omit<