feat: add directives option

Author: sxzz

README.md

@@ -7,6 +7,7 @@ On-demand components auto importing for Vue.
 ###### Features
 
 - 💚 Supports both Vue 2 and Vue 3 out-of-the-box.
+- ✨ Supports both components and directives.
 - ⚡️ Supports Vite, Webpack, Vue CLI, Rollup and more, powered by <a href="https://github.com/unjs/unplugin">unplugin</a>.
 - 🏝 Tree-shakable, only registers the components you use.
 - 🪐 Folder names as namespaces.
@@ -284,6 +285,11 @@ Components({
   // works when `directoryAsNamespace: true`
   globalNamespaces: [],
 
+  // auto import for directives
+  // default: `true` for Vue 3, `false` for Vue 2
+  // For Vue 2, there may be performance losses during compilation and runtime.
+  directives: true,
+
   // filters for transforming targets
   include: [/\.vue$/, /\.vue\?vue/],
   exclude: [/[\\/]node_modules[\\/]/, /[\\/]\.git[\\/]/, /[\\/]\.nuxt[\\/]/],

src/core/options.ts

@@ -4,7 +4,7 @@ import { isPackageExists } from 'local-pkg'
 import { ResolvedOptions, Options } from '../types'
 import { LibraryResolver } from './helpers/libraryResolver'
 
-export const defaultOptions: Omit<Required<Options>, 'include' | 'exclude' | 'transformer' | 'globs'> = {
+export const defaultOptions: Omit<Required<Options>, 'include' | 'exclude' | 'transformer' | 'globs' |'directives'> = {
   dirs: 'src/components',
   extensions: 'vue',
   deep: true,
@@ -58,6 +58,9 @@ export function resolveOptions(options: Options, root: string): ResolvedOptions
     )
   resolved.root = root
   resolved.transformer = options.transformer || getVueVersion() || 'vue3'
+  resolved.directives = (typeof options.directives === 'boolean')
+    ? options.directives
+    : getVueVersion() === 'vue3'
 
   return resolved
 }

src/core/transformer.ts

@@ -25,7 +25,8 @@ export default (ctx: Context, version: VueVersion): Transformer => {
     const s = new MagicString(code)
 
     await transformComponent(code, version, s, ctx, sfcPath)
-    await transformDirectives(code, version, s, ctx, sfcPath)
+    if (ctx.options.directives)
+      await transformDirectives(code, version, s, ctx, sfcPath)
 
     s.prepend(DISABLE_COMMENT)
 

src/types.ts

@@ -123,6 +123,16 @@ export interface Options {
    * @default false
    */
   allowOverrides?: boolean
+
+  /**
+   * auto import for directives.
+   *
+   * default: `true` for Vue 3, `false` for Vue 2
+   *
+   * For Vue 2, there may be performance losses during compilation and runtime.
+   * @default undefined
+   */
+  directives?: boolean
 }
 
 export type ResolvedOptions = Omit<