记一次在 VSCode 中解决「扩展 ESLint 无法格式化 *.ts」问题的过程

最近在带队写一个前端项目。为了统一项目组的规范,我用了 VSCode + ESLint 插件来自动格式化代码,但是,当我试图用 ESLint 来格式化 TypeScript 代码时,产生了十分诡异的错误:

错误截图

安装了中文语言包之后错误如下:

中文错误截图

VSCode 提示「扩展 ESLint 无法格式化 *.ts,而我所要格式化的仅仅就是一段 Hello World 代码而已,这让我一下子就踏上了折腾之旅。事实证明,世界上最可怕的事情不是 bug,而是出了 bug 却找不到日志。ESLint 输出的日志一片空白,仿佛完全没有任何错误发生一样:

ESLint 日志截图

当时我在网上搜索了很长时间,我点开了官方的 issue,把整个讨论串从头到尾看了一遍,发现尽管遇到这个错误的人十分多,但是作者根本无法复现,几乎每一个提出这个问题的 issue 都是被 bot 自动关闭的。

不过,issue 里的插件作者说的一段话倒是引起了我的注意:

@dbaeumer:请问你能把 tracing 打开吗?设置 "eslint.trace.server": "verbose" 就能打开 trace 了。

噢,原来是日志级别不够高啊。我打开了 trace 日志,果然发现了如下一段奇怪的内容:

[Info  - 下午10:17:00] ESLint library loaded from: D:\code\web\***\node_modules\eslint\lib\api.js
[Trace - 下午10:17:01] Received request 'eslint/probeFailed - (4)'.
Params: {
    "textDocument": {
        "uri": "file:///d%3A/code/web/***/src/backend/index.ts"
    }
}


[Trace - 下午10:17:01] Sending notification 'textDocument/didClose'.
Params: {
    "textDocument": {
        "uri": "file:///d%3A/code/web/***/src/backend/index.ts"
    }
}


[Trace - 下午10:17:01] Sending response 'eslint/probeFailed - (4)'. Processing request took 0ms
No result returned.

这下好办了,我们可以从 trace 日志中大概推断出,index.ts 格式化不成功的原因是因为“probe failed”。这个 probe 过程是怎么回事呢?在扩展的 README 上,我搜到了如下内容:

ESLint GitHub 仓库界面文档

虽然我们没有阅读源码,但是从这里已经可以大概推断出插件运行的流程:

  1. probing。当用户打开 JavaScript 等语言的代码时,ESLint 就要开始工作。但是,作者可能认为 VSCode 本身判断代码语言的能力不够精准,因此自己实现了一套探针逻辑,来判断代码是不是该语言的代码;
  2. validating。如果 probing 过程成功,那么就调用 eslint 库来对代码进行验证。

为了防止 probing 阶段出错,官方也提供了 eslint.validate 设置,用于强行绕过 probing 阶段,对指定的语言直接进行 validating 操作。于是,我们在 VSCode 中加入如下设置,强制要求插件跳过 TypeScript 的探针阶段:

"eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    "html",
    "vue",
    "markdown"
  ],

保存,再随便打开一个 .ts 文件,问题就解决了,比我想象的还要顺利。显然,探针失效的问题是一个 bug,这个问题我暂时没有时间研究,已经向作者提出了 issue:vscode-eslint/issues/1168,目前正在收集信息阶段,希望能尽快找出复现问题的方法。

从此,我们也能得到一些解决问题的经验:

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

推荐阅读更多精彩内容