使用vite脚手架创建vue3项目配置eslint

快速配置

  1. 使用vite的脚手架创建一个项目
    yarn create vite

  2. 安装Eslint包
    cd vite-project yarn add yarn add eslint -D

  3. 配置eslint
    npx eslint --init

    使用vite脚手架创建vue3项目配置eslint
    文章图片

  4. 安装依赖包
    如果上一步中 Would you like to install them now with npm? 选择的为yes 则可跳过当前步骤,否则,可以根据上一步骤的提示对需要的包进行安装
yarn add -D eslint-plugin-vue@latest @typescript-eslint/eslint-plugin@latest eslint-config-airbnb-base@latest eslint@^8.2.0 eslint-plugin-import@^2.25.2 @typescript-eslint/parser@latest

执行完以上的步骤基本的eslint配置就完成了,如果使用 vscode 的同学一定要注意要重启 vscode 才能生效
深度定制配置 问题解决
问题1:
当我打开App.vue文件的时候发现下面的错误,这个规则一看就是vue2 的规则阿
使用vite脚手架创建vue3项目配置eslint
文章图片

解决方法
vue是使用 eslint-plugin-vue 这个插件对vue的格式进行校验的我们打开它的文档看一下
使用vite脚手架创建vue3项目配置eslint
文章图片

可以看出来 vue3 推荐的是 plugin:vue/vue3-recommended 这个规则,而我们的 eslintrc.js 中使用的是 plugin:vue/essential 这个,我们修改代码如下,重新打开 App.vue 问题修复。
module.exports = { extends: [ -'plugin:vue/essential', +'plugin:vue/vue3-recommended', 'airbnb-base', ] }

问题2:
当我安装上 vue-router 在app上使用时,报文件无法解析
使用vite脚手架创建vue3项目配置eslint
文章图片

解决方法
我们看到第一个错是 import/no-unresolved查看文档 主要原因是因为我们的文件名没有文件后缀所以文件不能被 require.resolve 方法所解析,通过添加一下代码,扩展解析器的解析后缀
module.exports = { +settings: { +'import/resolver': { +node: { +extensions: [ +'.js', +'.jsx', +'.ts', +], +}, +}, +}, }

另一个错是报的是 import/extension 缺少文件后缀,通过查看文档我们添加如下代码解决
module.exports = { +'import/extensions': ['error', 'always', { +js: 'never', +mjs: 'never', +jsx: 'never', +ts: 'never', +tsx: 'never', +}], }

第一个参数为错误等级error表示异常,第二个参数 always 代表必须使用扩展,第三个参数对特定类型的文件进行设置
配置 Alias
Eslint alias需要借助 eslint-import-resolver-alias 这个插件才能实现
yarn add eslint-import-resolver-alias -D

修改.eslintrc.js代码
module.exports = { settings: { +'import/resolver': { +alias: { +map: [ +['@components', './src/components'], +], +extensions: ['.ts', '.js', '.jsx', '.json'], +}, +}, }, }

【使用vite脚手架创建vue3项目配置eslint】为了让 vite 在构建的时候能够识别Alias我们需要在vite.config.ts中添加如下配置
export default defineConfig({ +resolve: { +alias: { '@components': './src/components' }, +}, })

    推荐阅读