unplugin-auto-import的配置和eslint报错解决
先上官网:
unplugin-auto-import 解决了-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'})
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
include
和import
官方文档已经说的很明白了,我就不在这里赘述了。
eslintrc
是用来解决eslint报错问题的配置项。当enabled
为true
时,会根据filepath
生成一个eslint
的配置文件。这个文件需要引入到eslint的配置文件中,例如:
// .eslintrc.jsmodule.exports = { extends: [ ... './.eslintrc-auto-import.json' ]}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
然后一定要记得重新启动项目,这样才会生成这个配置文件。配置完成后,eslint报错就会消失。
需要注意的是,一旦生成配置文件之后,最好把enable
关掉,即改成false
。否则这个文件每次会在重新加载的时候重新生成,这会导致eslint有时会找不到这个文件。当需要更新配置文件的时候,再重新打开吧。
resolvers
可以引入解析器来进行组件声明,但是就element-plus而言,单独使用unplugin-auto-import
是无法连同样式一起导入进来的。可以参考我之前的一篇文章,里面有比较详细的叙述。
Cannot find name ‘ref’.问题解决方法
我看到评论区有小伙伴在配置完成后会出现这个问题:
从报错代码来看,这是一个ts错误,而且是找不到名称。我们可以把问题初步定位到没有将*.d.ts
文件加入到tsconfig.json
配置文件中,所以还不认识它们。
现在我们来引入一下:
{ "include": [ "src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue", "./auto-imports.d.ts" // 引入到这里 ]}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
等一下,或者重启项目就会发现,这个问题已经解决了。