vscode是如何找到xxx.jsx的:vscode点击无法跳转jsx定义

问题描述

在新接手的项目中,存在vscode点击无法跳转到对应文件的情况,具体如下:
相对路径引入的xxx.jsx文件无法自动跳转,但是.js文件可以

针对这个问题,做了一个非常简单的demo来进行演示和问题的复现:github

在该项目的入口文件src/test.js中就存在这样的问题

image.png

解决方案

经过对vscode源码debug,基本了解了大致流程。得到的正确解法如下:

解法1:

删除项目目录下的jsconfig.js,可以实现jsx,js文件的自动跳转

解法2:

jsconfig.json中配置如下:

{
    "compilerOptions": {
      "jsx": "preserve", // 共有三种枚举: react, react-native, preserve,实测均可
   },
    "exclude": ["node_modules"]
}

改进解法2:

一般来讲,jsconfig.json的存在都是配合webpack alias进行快速跳转,故可以参考如下配置:

{
    "compilerOptions": {
      "jsx": "react-native",
      "baseUrl": "./",
      "paths": {
        "@/*": ["src/*"]
      }
    },
    "exclude": ["node_modules"]
}

增加了baseUrl和paths,此时代码中可以进行如下引入:

image.png

原理探究

vscode源码本地启动

此部分可以参考vscode的contribute文档。文档写的比较详尽,此处补两个点:

  1. yarn配置淘宝源,等待时间会短很多
  2. 一部分资源需要从github拉取,一般公司的命令行都会配置成gitlab的名称,可以局部修改成github的姓名邮箱。不然有部分资源会403。

vscode相关代码定位

vscode源码主要分为两部分:src, extensions。由于本身对源码不熟悉,而且也只是为了定位问题,故没有仔细查看调用链路,最终得出以下结论:
寻找jsx文件是由内置扩展: typescript-language-features提供的,具体代码可以见definitions.ts。如果想编写支持其他文件的扩展,只需要注册registerDefinitionProvider这样的方法即可,可以参考jump-definition
此处再往下追的话,会是一份typescript经过打包后的代码,故没有深究。看到这里的时候,其实可以推测进入js文件之后,左下角会出现这一个状态:

image.png

等该内置扩展加载之后,才能使用点击跳转的功能。这里可以参考该扩展的package.json:

image.png

当检测到当前文件语言是js/jsx的时候,该扩展会被激活,从而出现左下角的加载状态。

小结

这个问题解决方案是非常简单的,不过之前在网上查了很久也没有得出结论(因为我的项目下有个jsconfig.json,即便什么配置都没有也还是找不到jsx文件),迫不得已去本地debug vscode的源代码。
不过还好,最终拿到了结果,顺利解决问题。希望能够让遇到类似问题的同学少走弯路。

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