Vue3+Vite项目自动导入配置 // import {ref, reactive, ......} from “vue“ 遇到的问题

一、配置 unplugin-auto-import 插件，实现 // import {ref, reactive, …} from “vue” 自动引入

1.安装 unplugin-auto-import 插件

npm i unplugin-auto-import -D

2.在 vite.config.js 中配置

import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import AutoImport from 'unplugin-auto-import/vite';

export default defineConfig({
  plugins: [
    vue(),
    AutoImport({
      // 自动导入 Vue 相关函数，如：ref, reactive, toRef 等
      imports: ['vue', 'vue-router'],
    }),
  ],
});

配置完成，这样在每个 vue 页面都不需要手动配置 import {ref, reactive, …} from “vue” 了。但是还会遇到 ts, eslint 不识别而导入报错的问题。

3. typescript 报错：‘reactive’ is not defined.

原因：TS 未识别到 vue api,没有相应的模块声明文件
处理：在 vite 中配置并生成 auto-imports.d.ts ，并在 tsconfig.json 中引入

vite.config.js

// vite.config.js
export default defineConfig({
  plugins: [
    vue(),
    AutoImport({
      // 自动导入 Vue 相关函数，如：ref, reactive, toRef 等
      imports: ['vue'],
      // 生成自动导入的TS声明文件
       dts: "/auto-import.d.ts", 
    }),
  ],
});

tsconfig.json

// tsconfig.json
{
     "include": [
        "src/**/*.d.ts",
        "./*.d.ts",
        "./auto-imports.d.ts" // 导入上一步生成的配置文件
      ],
}

4. eslint 无法识别报错 error ‘reactive’ is not defined no-undef

原因：未配置自动导入相应的 eslint 规则
处理：通过 autoimport 中的配置生成对应 .eslintrc-auto-import.json 配置文件，并在 .eslintrc 中引入

// vite.config.js  
{
    // ......
     AutoImport({
      imports: ["vue"],
      dts: "/auto-import.d.ts",
      eslintrc: {
        enabled: true,  // 1、改为true用于生成eslint配置。2、生成后改回false，避免重复生成消耗
      },
    }),
}

.eslintrc.js

// .eslintrc.js
extends: [
   "./.eslintrc-auto-import.json",
 ],

完成

这篇好文章是转载于：学新通技术网