BREAKING CHANGE: rework import info interface

`path` -> `from`
`name` -> `as`
`importName` -> `name`

Author: antfu

src/core/context.ts

@@ -4,7 +4,7 @@ import Debug from 'debug'
 import type { UpdatePayload, ViteDevServer } from 'vite'
 import { slash, throttle, toArray } from '@antfu/utils'
 import type { ComponentInfo, Options, ResolvedOptions, Transformer } from '../types'
-import { getNameFromFilePath, matchGlobs, parseId, pascalCase, resolveAlias } from './utils'
+import { getNameFromFilePath, matchGlobs, normalizeComponetInfo, parseId, pascalCase, resolveAlias } from './utils'
 import { resolveOptions } from './options'
 import { searchComponents } from './fs/glob'
 import { generateDeclaration } from './declaration'
@@ -116,8 +116,8 @@ export class Context {
   }
 
   addCustomComponents(info: ComponentInfo) {
-    if (info.name)
-      this._componentCustomMap[info.name] = info
+    if (info.as)
+      this._componentCustomMap[info.as] = info
   }
 
   removeComponents(paths: string | string[]) {
@@ -176,16 +176,16 @@ export class Context {
         }
 
         this._componentNameMap[name] = {
-          name,
-          path,
+          as: name,
+          from: path,
         }
       })
   }
 
   async findComponent(name: string, type: 'component' | 'directive', excludePaths: string[] = []): Promise<ComponentInfo | undefined> {
     // resolve from fs
     let info = this._componentNameMap[name]
-    if (info && !excludePaths.includes(info.path) && !excludePaths.includes(info.path.slice(1)))
+    if (info && !excludePaths.includes(info.from) && !excludePaths.includes(info.from.slice(1)))
       return info
 
     // custom resolvers
@@ -197,16 +197,16 @@ export class Context {
       if (result) {
         if (typeof result === 'string') {
           info = {
-            name,
-            path: result,
+            as: name,
+            from: result,
           }
           this.addCustomComponents(info)
           return info
         }
         else {
           info = {
-            name,
-            ...result,
+            as: name,
+            ...normalizeComponetInfo(result),
           }
           this.addCustomComponents(info)
           return info

src/core/declaration.ts

@@ -20,7 +20,7 @@ export async function generateDeclaration(ctx: Context, root: string, filepath:
       }),
       ...resolveTypeImports(ctx.options.types),
     ]
-      .map(({ path, name, importName }) => {
+      .map(({ from: path, as: name, name: importName }) => {
         if (!name)
           return undefined
         path = getTransformedPath(path, ctx)

src/core/resolvers/antdv.ts

@@ -262,8 +262,8 @@ export function AntDesignVueResolver(options: AntDesignVueResolverOptions = {
     resolve: (name: string) => {
       if (options.resolveIcons && name.match(/(Outlined|Filled|TwoTone)$/)) {
         return {
-          importName: name,
-          path: '@ant-design/icons-vue',
+          name,
+          from: '@ant-design/icons-vue',
         }
       }
 
@@ -272,8 +272,8 @@ export function AntDesignVueResolver(options: AntDesignVueResolverOptions = {
         const { cjs = false } = options
         const path = `ant-design-vue/${cjs ? 'lib' : 'es'}`
         return {
-          importName,
-          path,
+          name: importName,
+          from: path,
           sideEffects: getSideEffects(importName, options),
         }
       }

src/core/resolvers/arco.ts

@@ -1,4 +1,4 @@
-import type { ComponentResolver } from '../../types'
+import type { ComponentInfo, ComponentResolver } from '../../types'
 import { kebabCase } from '../utils'
 
 const matchComponents = [
@@ -175,21 +175,20 @@ export function ArcoResolver(
     resolve: (name: string) => {
       if (options.resolveIcons && name.match(/^Icon/)) {
         return {
-          importName: name,
-          path: '@arco-design/web-vue/es/icon',
+          name,
+          from: '@arco-design/web-vue/es/icon',
         }
       }
       if (name.match(/^A[A-Z]/)) {
         const importStyle = options.importStyle ?? 'css'
 
         const importName = name.slice(1)
-        const config = {
-          importName,
-          path: '@arco-design/web-vue',
+        const config: ComponentInfo = {
+          as: importName,
+          from: '@arco-design/web-vue',
         }
         if (options.sideEffect !== false)
-          (config as any).sideEffects = getComponentStyleDir(importName, importStyle)
-
+          config.sideEffects = getComponentStyleDir(importName, importStyle)
         return config
       }
     },

src/core/resolvers/devui.ts

@@ -1,5 +1,5 @@
 import { kebabCase } from '../utils'
-import type { ComponentResolver } from '../../types'
+import type { ComponentInfo, ComponentResolver, ImportInfo } from '../../types'
 
 export interface DevResolverOptions {
   /**
@@ -48,27 +48,27 @@ function getSideEffects(name: string): string | undefined {
   return (match && effectComponentMaps[match]) && findStyle(match)
 }
 
-function componentsResolver(name: string) {
+function componentsResolver(name: string): ComponentInfo | undefined {
   if (!name.match(/^D[A-Z]/))
     return
 
   // Alert => alert; DatePicker => date-picker
   const resolveId = kebabCase(name = name.slice(1))
 
   return {
-    path: LIB_NAME,
-    importName: name,
+    from: LIB_NAME,
+    as: name,
     sideEffects: getSideEffects(resolveId),
   }
 }
 
-function directivesResolver(name: string) {
+function directivesResolver(name: string): ComponentInfo | undefined {
   if (!(name in effectDirectiveMaps))
     return
 
   return {
-    path: LIB_NAME,
-    importName: `${name}Directive`,
+    from: LIB_NAME,
+    as: `${name}Directive`,
     sideEffects: findStyle(effectDirectiveMaps[name]),
   }
 }

src/core/resolvers/element-plus.ts

@@ -91,22 +91,22 @@ function resolveComponent(name: string, options: ElementPlusResolverOptionsResol
   // >=1.1.0-beta.1
   if (cv.compare(version, '1.1.0-beta.1', '>=')) {
     return {
-      importName: name,
-      path: `element-plus/${ssr ? 'lib' : 'es'}`,
+      name,
+      from: `element-plus/${ssr ? 'lib' : 'es'}`,
       sideEffects: getSideEffects(partialName, options),
     }
   }
   // >=1.0.2-beta.28
   else if (cv.compare(version, '1.0.2-beta.28', '>=')) {
     return {
-      path: `element-plus/es/el-${partialName}`,
+      from: `element-plus/es/el-${partialName}`,
       sideEffects: getSideEffectsLegacy(partialName, options),
     }
   }
   // for <=1.0.1
   else {
     return {
-      path: `element-plus/lib/el-${partialName}`,
+      from: `element-plus/lib/el-${partialName}`,
       sideEffects: getSideEffectsLegacy(partialName, options),
     }
   }
@@ -131,8 +131,8 @@ function resolveDirective(name: string, options: ElementPlusResolverOptionsResol
   // >=1.1.0-beta.1
   if (cv.compare(version, '1.1.0-beta.1', '>=')) {
     return {
-      importName: directive.importName,
-      path: `element-plus/${ssr ? 'lib' : 'es'}`,
+      name: directive.importName,
+      from: `element-plus/${ssr ? 'lib' : 'es'}`,
       sideEffects: getSideEffects(directive.styleName, options),
     }
   }

src/core/resolvers/element-ui.ts

@@ -51,11 +51,11 @@ export function ElementUiResolver(options: ElementUiResolverOptions = {}): Compo
         const partialName = kebabCase(compName)
         if (partialName === 'collapse-transition') {
           return {
-            path: `element-ui/lib/transitions/${partialName}`,
+            from: `element-ui/lib/transitions/${partialName}`,
           }
         }
         return {
-          path: `element-ui/lib/${partialName}`,
+          from: `element-ui/lib/${partialName}`,
           sideEffects: getSideEffects(partialName, options),
         }
       }

src/core/resolvers/headless-ui.ts

@@ -71,8 +71,8 @@ export function HeadlessUiResolver(options: HeadlessUiResolverOptions = {}): Com
         const componentName = name.substring(prefix.length)
         if (components.includes(componentName)) {
           return {
-            importName: componentName,
-            path: '@headlessui/vue',
+            name: componentName,
+            from: '@headlessui/vue',
           }
         }
       }

src/core/resolvers/idux.ts

@@ -56,7 +56,7 @@ export function IduxResolver(options: IduxResolverOptions = {}): ComponentResolv
       if (packageName !== 'cdk' && importStyle)
         sideEffects = `${path}/style/themes/${importStyle === 'css' ? 'default_css' : 'default'}`
 
-      return { importName: name, path, sideEffects }
+      return { name, from: path, sideEffects }
     },
   }
 }

src/core/resolvers/inkline.ts

@@ -12,8 +12,8 @@ export function InklineResolver(): ComponentResolver {
     resolve: (name: string) => {
       if (name.match(/^I[A-Z]/)) {
         return {
-          importName: name,
-          path: '@inkline/inkline',
+          name,
+          from: '@inkline/inkline',
         }
       }
     },