feat: add excludeNames option

closes #206
closes #678

Author: KaelWD

README.md

@@ -358,7 +358,7 @@ Components({
   extensions: ['vue'],
 
   // Glob patterns to match file names to be detected as components.
-  // When specified, the `dirs` and `extensions` options will be ignored.
+  // When specified, the `dirs`, `extensions`, and `directoryAsNamespace` options will be ignored.
   // If you want to exclude components being registered, use negative globs with leading `!`.
   globs: ['src/components/*.{vue}'],
 
@@ -398,10 +398,14 @@ Components({
   allowOverrides: false,
 
   // Filters for transforming targets (components to insert the auto import)
-  // Note these are NOT about including/excluding components registered - use `globs` for that
+  // Note these are NOT about including/excluding components registered - use `globs` or `excludeNames` for that
   include: [/\.vue$/, /\.vue\?vue/],
   exclude: [/[\\/]node_modules[\\/]/, /[\\/]\.git[\\/]/, /[\\/]\.nuxt[\\/]/],
 
+  // Filters for component names that will not be imported
+  // Use for globally imported async components or other conflicts that the plugin cannot detect
+  excludeNames: [/^Async.+/],
+
   // Vue version of project. It will detect automatically if not specified.
   // Acceptable value: 2 | 2.7 | 3
   version: 2.7,

src/core/context.ts

@@ -203,6 +203,10 @@ export class Context {
       .from(this._componentPaths)
       .forEach((path) => {
         const name = pascalCase(getNameFromFilePath(path, this.options))
+        if (this.options.excludeNames(name)) {
+          debug.components('exclude', name)
+          return
+        }
         if (this._componentNameMap[name] && !this.options.allowOverrides) {
           console.warn(`[unplugin-vue-components] component "${name}"(${path}) has naming conflicts with other components, ignored.`)
           return

src/core/options.ts

@@ -4,7 +4,7 @@ import { getPackageInfoSync, isPackageExists } from 'local-pkg'
 import type { ComponentResolver, ComponentResolverObject, Options, ResolvedOptions } from '../types'
 import { detectTypeImports } from './type-imports/detect'
 
-export const defaultOptions: Omit<Required<Options>, 'include' | 'exclude' | 'transformer' | 'globs' | 'directives' | 'types' | 'version'> = {
+export const defaultOptions: Omit<Required<Options>, 'include' | 'exclude' | 'excludeNames' | 'transformer' | 'globs' | 'directives' | 'types' | 'version'> = {
   dirs: 'src/components',
   extensions: 'vue',
   deep: true,

src/types.ts

@@ -71,6 +71,11 @@ export interface Options {
    */
   exclude?: FilterPattern
 
+  /**
+   * RegExp or glob to match component names that will NOT be imported
+   */
+  excludeNames?: FilterPattern
+
   /**
    * Relative paths to the directory to search for components.
    * @default 'src/components'
@@ -86,7 +91,7 @@ export interface Options {
   /**
    * Glob patterns to match file names to be detected as components.
    *
-   * When specified, the `dirs` and `extensions` options will be ignored.
+   * When specified, the `dirs`, `extensions`, and `directoryAsNamespace` options will be ignored.
    */
   globs?: string | string[]
 
@@ -180,7 +185,7 @@ export interface Options {
 
 export type ResolvedOptions = Omit<
   Required<Options>,
-'resolvers' | 'extensions' | 'dirs' | 'globalComponentsDeclaration'
+'resolvers' | 'extensions' | 'dirs' | 'globalComponentsDeclaration' | 'excludeNames'
 > & {
   resolvers: ComponentResolverObject[]
   extensions: string[]
@@ -189,6 +194,7 @@ export type ResolvedOptions = Omit<
   globs: string[]
   dts: string | false
   root: string
+  excludeNames: (id: unknown) => boolean
 }
 
 export type ComponentsImportMap = Record<string, string[] | undefined>