vue项目优雅实现自动引入组件的方法详解

//直接npm i 梭哈
npm i unplugin-vue-components unplugin-auto-import vite-plugin-style-import unplugin-icons

//vite.confing.ts 
import Components from "unplugin-vue-components/vite";
//引入饿了么的组件，只要安装的ep,这里就会有提示的
import { ElementPlusResolver } from "unplugin-vue-components/resolvers";
export default defineConfig({
  plugins: [
  //...
    Components({
      dts: "./src/components.d.ts",//创建ts文件
      extensions:['vue'],//指定文件的后缀
      dirs: ["src/components/"],//指定路径，自动导入自定义组件
      resolvers: [ElementPlusResolver()],//指定自动引入的组件库，也就是从插件中导出的那个
    }),
   ],
});

<template>
  <div>
    <el-button @click="btn">点击</el-button>
    <!-- 在插件内，指定的路径下，也可以直接使用自定义组件 -->
    <HelloWorld/>
  </div>
</template>
<script setup lang="ts">
const btn = () => {
  ElMessage.error("iceCode");
};
</script>

import { createStyleImportPlugin, AndDesignVueResolve} from "vite-plugin-style-import";
//2.0之前
//import styleImport { AndDesignVueResolve} from "vite-plugin-style-import";
export default defineConfig({
  plugins: [
  //...
    createStyleImportPlugin({
      resolves: [AndDesignVueResolve()],//这里引入
    }),
     //下面这种写法使在这个插件2.0之前的写法
    // styleImport( {
    //   libs: [
    //     {
    //       libraryName: "ant-design-vue",
    //       esModule: true,
    //       resolveStyle: (name: string) => {
    //         return `ant-design-vue/dist/antd.css`;
    //       },
    //     },
    //   ],
    // })
   ],
});

<template>
  <div>
    <Button @click="btn">点击</Button>
  </div>
</template>
<script setup lang="ts">
import { Button, message } from "ant-design-vue";
const btn = () => {
  message.success("iceCode");
};
</script>

import AutoImport from "unplugin-auto-import/vite"; //引入组件
export default defineConfig({
  plugins: [
   ///...
   AutoImport({
      imports: ["vue", "vue-router", "pinia", "@vueuse/core"],//这里是自动引入api的项目
      dts: "./src/auto-imports.d.ts",//在这创建.d.ts文件
      resolvers: [ ElementPlusResolver()],//组件中的api也是可以自动引入的，比如message是需要单独引入的
    }),
   ],
});

<script setup lang="ts">
const num = ref<number>(0);
const newNum = computed<number>( () => num.value + 1 );
interface n{
  n:number
}
const numObj = reactive<n>({
  n: newNum.value,
});
console.log(toRaw(numObj));
</script>

//自动引入图标需要搭配自动引入组件的插件来用
import Components from "unplugin-vue-components/vite";
import Icons from "unplugin-icons/vite";
import IconsResolve from "unplugin-icons/resolver";
export default defineConfig({
  plugins: [
  //...
    Components({
      dts: "./src/components.d.ts",//创建ts文件
      extensions:['vue'],//指定文件的后缀
      dirs: ["src/components/"],//指定路径，自动导入自定义组件
      resolvers: [IconsResolve()],//图标组件
     // { enabledCollections: ['ep'], }，有的会在IconsResolve()中传入这个参数，但我测试不传也是可以的
    }),
      Icons({
      //使用哪种框架解析
      compiler: "vue3",
      //是否自动安装
      autoInstall: true,
    }),
   ],
});

<template>
  <div>
  <!-- 这是饿了么组件的icon使用，需要加上i-ep- 才能正常使用 -->
    <i-ep-user/>
  </div>
</template>

import { defineConfig } from "vite";
import vue from "@vitejs/plugin-vue";
import Components from "unplugin-vue-components/vite";
import AutoImport from "unplugin-auto-import/vite";
import Icons from "unplugin-icons/vite";
import IconsResolve from "unplugin-icons/resolver";
import { AntDesignVueResolver, ElementPlusResolver } from "unplugin-vue-components/resolvers";
import { createStyleImportPlugin, AndDesignVueResolve, ElementPlusResolve } from "vite-plugin-style-import";
// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    vue(),
    //自动引入api
    AutoImport({
      imports: ["vue", "vue-router", "pinia", "@vueuse/core"],
      dts: "./src/auto-imports.d.ts",
      resolvers: [AntDesignVueResolver(), ElementPlusResolver()],
    } ),
    //自动引入组件
    Components({
      dts: "./src/components.d.ts",
      extensions: ["vue"],
      dirs: ["src/components/"],
      resolvers: [
        AntDesignVueResolver({
          importStyle: false, // css in js
        }),
        ElementPlusResolver(),
        IconsResolve(),
      ],
    } ),
    // 自动引入样式
    createStyleImportPlugin({
      resolves: [AndDesignVueResolve(), ElementPlusResolve()],
    } ),
    //自动引入icon
    Icons({
      //使用哪种框架解析
      compiler: "vue3",
      //是否自动安装
      autoInstall: true,
    }),
  ],
});