unplugin-auto-import的配置以及eslint報錯解決詳解

Posted on by

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報錯內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：