vue+eslint:由一个“Parsing error: The keyword 'interface' is reserved”引发的配置优化

项目eslint配置

说一下我这个练手项目的情况,这个项目是从一个最简单的vue3项目骨架搭起来的,配置了简单的eslint代码规范检查,期间想使用typescript语法来编写代码,跟着案例写的时候用到了interface,像下面的情况:

<script lang="ts">
export default{
    name: "DlHeader"
}
</script>

<script setup lang="ts">
import { withDefaults } from 'vue'

interface Props {
    height?: string
}

withDefaults(defineProps<Props>(), {
    height: "60px"
})
</script>

这里面用interface定义了一个我所认为的接口。然后在vue的函数中去使用它。代码跑起来没有问题,但是使用eslint执行检查的时候就报错了。

eslint --fix --ext .js,vue src/

报错内容如下:

Parsing error: The keyword 'interface' is reserved

Parsing error: The keyword 'interface' is reserved

这个错误提示意思是 interface 是Javascript为未来特性保留的关键字,我们不应该使用它。

在我对这个错误提示百度时,很不幸,国内的网站基本找不到相关问题的解释和解决方法,唯一可参考的是stackoverflow上的一个类似的问题,他的描述是这样的


Stack Overflow上的类似问题

下面的回答中有一个被标记为正确的解答:


解答

这里面提到的standard也是一个代码风格检查工具,官网是:https://standardjs.com 看它的内容描述,这是一个类似eslint的东西,似乎比eslint更加简单。如果用于ts的检查,可以使用ts-standard变体。
但是这个其实不是我要的东西,按照它这个方法配置在我的vue3项目中后,也一样解决不了我的问题。
于是我想起来把我这个练手的项目和vue3官方vite插件创建出来的ts项目对比了一下,主要是对比其中的.eslintrc.json文件,这下发现了问题,官方的项目模板里其实配置了vue+typescript项目需要的插件,就是下面这些:

eslint-plugin-vue, @typescript-eslint/parser, @typescript-eslint/eslint-plugin

下面是官方的项目模板中.eslintrc.json的内容:

{
    "env": {
        "browser": true,
        "es2021": true
    },
    "extends": [
        "eslint:recommended",
        "plugin:vue/essential",
        "plugin:@typescript-eslint/recommended"
    ],
    "parserOptions": {
        "ecmaVersion": "latest",
        "parser": "@typescript-eslint/parser",
        "sourceType": "module"
    },
    "plugins": [
        "vue",
        "@typescript-eslint"
    ],
    "rules": {
        "semi": ["warn", "never"]
    }
}

我想起来可以看一下项目中依赖的关系,于是:

npm list -depth 2

这个命令可以查看这些插件的依赖,我发现eslint-plugin-vue其实有依赖后面两个,而且这个插件查了一下是官方提供的,应该是最关键的一个切入口。

为了弄清这些插件的用途,我去npm网站上查了这些插件,总算搞明白了问题所在。

eslint-plugin-vue  //官方提供的,和eslint配合使用,用于检查.vue文件中的<template>和<script>部分是否符合代码规范。
@typescript-eslint/parser  //一个eslint的解析器,允许使用typescrpt ESTree来对ts代码进行规范约束。
@typescript-eslint/eslint-plugin  //一个为ts代码提供约束规则的插件,需要确保项目中已安装@typescript-eslint/parser。

根据这些插件的介绍,在.eslintrc.json中正确配置以后,应该可以解决我上面遇到的问题。
我们先看eslint-plugin-vue这个官方插件,其实介绍的已经比较清楚了;


eslint-plugin-vue的使用

这里提到的配置方法和vite项目模板里的还稍有不同,不过比较符合我的需求,我就是要自定义一个ts的parser,最后我的配置文件变成了这样:

{
    "env": {
        "browser": true,
        "es2021": true,
        "vue/setup-compiler-macros": true
    },
    "extends": [
        "eslint:recommended",
        "plugin:vue/essential",
        "plugin:@typescript-eslint/recommended"
    ],
    "parser": "vue-eslint-parser",
    "parserOptions": {
        "ecmaVersion": "latest",
        "sourceType": "module",
        "parser": "@typescript-eslint/parser"
    },
    "plugins": [
        "vue"
    ],
    "rules": {
        "semi": ["warn","never"]
    }
}

关键的内容就是其中的parserOptions.parser配置使用typescript语法插件的parser就可以正确识别项目中.vue文件的ts代码,根据eslint-plugin-vue官方的说明,我这里额外配置了一个vue-eslint-parser,因为如果没有这个的话,还会收到一堆新的错误提示:

Parsing error: '>' expected

但是vite项目模板里并没有配置这个,应该是其他的什么地方有些配置上的差异,等以后弄明白了再回来补充吧。

像我上面说的,如果大家使用vite创建一个vue3+ts+eslint的项目,其实不会遇到这样的问题,可能这也是网上类似这样的问题解释很少的原因吧。不过自己从头开始搞的这个项目也刚好让我可以多了解了一些eslint和vue整合的知识,也算不错。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,172评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,346评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,788评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,299评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,409评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,467评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,476评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,262评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,699评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,994评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,167评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,827评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,499评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,149评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,387评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,028评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,055评论 2 352

推荐阅读更多精彩内容