fe-core-cli/templates/fast-vue3-lib/example/plugins/autoImport.ts

All-in-one scaffolding, cli integrated with Vue3 ecological chain, cli of H5 page, mock template cli of Node

/**
 * @name  AutoRegistryComponents
 * @description 按需加载，自动引入组件
 * 1. antdVue组件库按需引入
 * 2. 自定义 src/components下的全部组件也自动引入
 *    - 在文件夹下的全部组件会被递归注册
 *    - 如果最下层的文件名为 index 则会获取上一层文件夹名称作为组件名
 */
import Components from 'unplugin-vue-components/vite'
import { AntDesignVueResolver } from 'unplugin-vue-components/resolvers'
// import { KsgUIResolver } from '@ksg/utils/lib/resolver'

export const AutoImport = () => {
  return Components({
    importPathTransform: (v) => v,
    allowOverrides: false,
    // relative paths to the directory to search for components.
    // // 要搜索组件的目录的相对路径
    // dirs: ['src/components'],

    // valid file extensions for components.
    // 组件的有效文件扩展名。
    // extensions: ['vue'],

    // search for subdirectories
    // 搜索子目录
    deep: true,

    // resolvers for custom components
    // 自定义组件的解析器
    resolvers: [
      // KsgUIResolver({
      //   importStyle: 'less'
      // }),
      AntDesignVueResolver({
        resolveIcons: true // 导入antd 内置的icon
      })
    ],

    // generate `components.d.ts` global declarations,
    // also accepts a path for custom filename
    // 生成 `components.d.ts` 全局声明，
    // 也接受自定义文件名的路径
    dts: 'types/components.d.ts',

    // Allow subdirectories as namespace prefix for components.
    // 允许子目录作为组件的命名空间前缀。
    directoryAsNamespace: false,

    // 忽略命名空间前缀的子目录路径
    // 当`directoryAsNamespace: true` 时有效
    // Subdirectory paths for ignoring namespace prefixes
    // works when `directoryAsNamespace: true`
    globalNamespaces: [],

    // auto import for directives
    // default: `true` for Vue 3, `false` for Vue 2
    // Babel is needed to do the transformation for Vue 2, it's disabled by default for performance concerns.
    // To install Babel, run: `npm install -D @babel/parser @babel/traverse`
    // 自动导入指令
    // 默认值：Vue 3 的`true`，Vue 2 的`false`
    // 需要 Babel 来为 Vue 2 进行转换，出于性能考虑，它默认处于禁用状态。
    directives: true
  })
}