feat: add a components api to allow manual detection in frameworks (#329)

Co-authored-by: Anthony Fu <anthonyfu117@hotmail.com>

Author: ElMassimo

src/core/unplugin.ts

@@ -2,9 +2,9 @@ import { createUnplugin } from 'unplugin'
 import { createFilter } from '@rollup/pluginutils'
 import chokidar from 'chokidar'
 import type { ResolvedConfig, ViteDevServer } from 'vite'
-import type { Options } from '../types'
+import type { Options, PublicPluginAPI } from '../types'
 import { Context } from './context'
-import { shouldTransform } from './utils'
+import { shouldTransform, stringifyComponentImport } from './utils'
 
 export default createUnplugin<Options>((options = {}) => {
   const filter = createFilter(
@@ -13,10 +13,21 @@ export default createUnplugin<Options>((options = {}) => {
   )
   const ctx: Context = new Context(options)
 
+  const api: PublicPluginAPI = {
+    async findComponent(name, filename) {
+      return await ctx.findComponent(name, 'component', filename ? [filename] : [])
+    },
+    stringifyImport(info) {
+      return stringifyComponentImport(info, ctx)
+    },
+  }
+
   return {
     name: 'unplugin-vue-components',
     enforce: 'post',
 
+    api,
+
     transformInclude(id) {
       return filter(id)
     },

src/types.ts

@@ -34,6 +34,17 @@ export type Transformer = (code: string, id: string, path: string, query: Record
 
 export type SupportedTransformer = 'vue3' | 'vue2'
 
+export interface PublicPluginAPI {
+  /**
+   * Resolves a component using the configured resolvers.
+   */
+  findComponent: (name: string, filename?: string) => Promise<ComponentInfo | undefined>
+  /**
+   * Obtain an import statement for a resolved component.
+   */
+  stringifyImport: (info: ComponentInfo) => string
+}
+
 /**
  * Plugin options.
  */

src/vite.ts

@@ -1,3 +1,5 @@
+import type { Plugin } from 'vite'
+import type { Options, PublicPluginAPI } from './types'
 import unplugin from '.'
 
-export default unplugin.vite
+export default unplugin.vite as (options?: Options | undefined) => Plugin & { api: PublicPluginAPI }