unplugin-auto-import的配置以及eslint报错解决详解

目录 unplugin-auto-import的配置和eslint报错解决 Cannot find name ‘ref’.问题解决方法 总结

unplugin-auto-import的配置和eslint报错解决

先上官网： unplugin-auto-import

unplugin-auto-import 解决了vue3-hook、vue-router、useVue等多个插件的自动导入，也支持自定义插件的自动导入，是一个功能强大的typescript支持工具。

unplugin-auto-import常用的配置如下：

AutoImport({
  // 目标文件
  include: [
    /\.[tj]sx?$/, // .ts, .tsx, .js, .jsx
    /\.vue$/, /\.vue\?vue/, // .vue
    /\.md$/, // .md
  ],

  // 全局引入插件
  imports: [
    // presets
    'vue',
    'vue-router',
    // custom
    {
      '@vueuse/core': [
        // named imports
        'useMouse', // import { useMouse } from '@vueuse/core',
        // alias
        ['useFetch', 'useMyFetch'], // import { useFetch as useMyFetch } from '@vueuse/core',
      ],
      'axios': [
        // default imports
        ['default', 'axios'], // import { default as axios } from 'axios',
      ],
      '[package-name]': [
        '[import-names]',
        // alias
        ['[from]', '[alias]'],
      ],
    },
  ],

  // eslint报错解决
  eslintrc: {
    enabled: false, // Default `false`
    filepath: './.eslintrc-auto-import.json', // Default `./.eslintrc-auto-import.json`
    globalsPropValue: true, // Default `true`, (true | false | 'readonly' | 'readable' | 'writable' | 'writeable')
  },

  // 解析器，例如element-plus的ElementPlusResolver
  // see https://github.com/antfu/unplugin-auto-import/pull/23/
  resolvers: [
    /* ... */
  ],
  // 声明文件生成位置和文件名称
  dts: './auto-import.d.ts'
})

include 和 import 官方文档已经说的很明白了，我就不在这里赘述了。

eslintrc 是用来解决eslint报错问题的配置项。当 enabled 为 true 时，会根据 filepath 生成一个 eslint 的配置文件。这个文件需要引入到eslint的配置文件中，例如：

// .eslintrc.js
module.exports = {
  extends: [
    ...
    './.eslintrc-auto-import.json'
  ]
}

然后一定要记得重新启动项目，这样才会生成这个配置文件。配置完成后，eslint报错就会消失。

需要注意的是，一旦生成配置文件之后，最好把 enable 关掉，即改成 false 。否则这个文件每次会在重新加载的时候重新生成，这会导致eslint有时会找不到这个文件。当需要更新配置文件的时候，再重新打开吧。

resolvers 可以引入解析器来进行组件声明，但是就element-plus而言，单独使用 unplugin-auto-import 是无法连同样式一起导入进来的。 element-plus的自动引入 可以参考我之前的一篇文章，里面有比较详细的叙述。

Cannot find name ‘ref’.问题解决方法

我看到评论区有小伙伴在配置完成后会出现这个问题：

从报错代码来看，这是一个ts错误，而且是找不到名称。我们可以把问题初步定位到没有将 *.d.ts 文件加入到 tsconfig.json 配置文件中，所以typescript还不认识它们。

现在我们来引入一下：

{
  "include": [
    "src/**/*.ts",
    "src/**/*.d.ts",
    "src/**/*.tsx",
    "src/**/*.vue",
    "./auto-imports.d.ts" // 引入到这里
  ]
}

等一下，或者重启项目就会发现，这个问题已经解决了。

总结

到此这篇关于unplugin-auto-import配置以及eslint报错解决的文章就介绍到这了,更多相关unplugin-auto-import配置及eslint报错内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

查看更多关于unplugin-auto-import的配置以及eslint报错解决详解的详细内容...