refactor!: customComponentResolvers renamed to resolvers

Author: antfu

README.md

@@ -106,7 +106,7 @@ export default {
   plugins: [
     /* ... */
     Components({
-      customComponentResolvers: [
+      resolvers: [
         ElementPlusResolver(),
       ]
     }),
@@ -173,7 +173,7 @@ import ViteComponents, {
 
 // your plugin installation
 Components({
-  customComponentResolvers: [
+  resolvers: [
     AntDesignVueResolver(),
     ElementPlusResolver(),
     VantResolver(),
@@ -185,7 +185,7 @@ You can also write your own resolver easily:
 
 ```ts
 Components({
-  customComponentResolvers: [
+  resolvers: [
     // example of importing Vant
     (name) => {
       // where `name` is always CapitalCase

examples/naive-ui/vite.config.ts

@@ -6,7 +6,7 @@ const config: UserConfig = {
   plugins: [
     Vue(),
     ViteComponents({
-      customComponentResolvers: [
+      resolvers: [
         NaiveUiResolver(),
       ],
       globalComponentsDeclaration: true,

examples/vite-vue3/vite.config.ts

@@ -31,7 +31,7 @@ const config: UserConfig = {
       globalNamespaces: ['global'],
       importPathTransform: path => path.endsWith('.svg') ? `${path}?component` : undefined,
       include: [/\.vue$/, /\.md$/],
-      customComponentResolvers: [
+      resolvers: [
         (name) => {
           if (name === 'MyCustom')
             return '/src/CustomResolved.vue'

src/core/context.ts

@@ -163,7 +163,7 @@ export class Context {
       return info
 
     // custom resolvers
-    for (const resolver of this.options.customComponentResolvers) {
+    for (const resolver of this.options.resolvers) {
       const result = resolver(name)
       if (result) {
         if (typeof result === 'string') {

src/core/fs/glob.ts

@@ -15,7 +15,7 @@ export function searchComponents(ctx: Context) {
     absolute: true,
   })
 
-  if (!files.length && !ctx.options.customComponentResolvers?.length)
+  if (!files.length && !ctx.options.resolvers?.length)
     // eslint-disable-next-line no-console
     console.warn('[unplugin-vue-components] no components found')
 

src/core/options.ts

@@ -15,7 +15,7 @@ export const defaultOptions: Omit<Required<Options>, 'include' | 'exclude'> = {
   globalNamespaces: [],
 
   libraries: [],
-  customComponentResolvers: [],
+  resolvers: [],
 
   importPathTransform: v => v,
 
@@ -25,8 +25,8 @@ export const defaultOptions: Omit<Required<Options>, 'include' | 'exclude'> = {
 export function resolveOptions(options: Options, root: string): ResolvedOptions {
   const resolved = Object.assign({}, defaultOptions, options) as ResolvedOptions
   resolved.libraries = toArray(resolved.libraries).map(i => typeof i === 'string' ? { name: i } : i)
-  resolved.customComponentResolvers = toArray(resolved.customComponentResolvers)
-  resolved.customComponentResolvers.push(...resolved.libraries.map(lib => LibraryResolver(lib)))
+  resolved.resolvers = toArray(resolved.resolvers)
+  resolved.resolvers.push(...resolved.libraries.map(lib => LibraryResolver(lib)))
   resolved.extensions = toArray(resolved.extensions)
 
   const extsGlob = resolved.extensions.length === 1

src/types.ts

@@ -82,7 +82,7 @@ export interface Options {
    *
    * The component names are always in PascalCase
    */
-  customComponentResolvers?: ComponentResolver | ComponentResolver[]
+  resolvers?: ComponentResolver | ComponentResolver[]
 
   /**
    * Apply custom transform over the path for importing
@@ -117,9 +117,9 @@ export interface Options {
 
 export type ResolvedOptions = Omit<
 Required<Options>,
-'customComponentResolvers'|'libraries'|'extensions'|'dirs'|'globalComponentsDeclaration'
+'resolvers'|'libraries'|'extensions'|'dirs'|'globalComponentsDeclaration'
 > & {
-  customComponentResolvers: ComponentResolver[]
+  resolvers: ComponentResolver[]
   libraries: UILibraryOptions[]
   extensions: string[]
   dirs: string[]