63

Enabling VSCode's "Go to Definition" for JSX imports

 5 years ago
source link: https://www.tuicool.com/articles/hit/vQNzeiB
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.

I have recently been trialling using Microsoft’s VSCode editor as my primary code editor, and so far I’ve been very happy with it. One feature that I’ve particularly enjoyed is “Go to Definition”. This lets you hover over any variable/class/object/etc and be taken to the place where it is defined, even if it’s in another file.

This is particularly useful for me in JavaScript imports. If I have this line:

import Foo from './foo'

I can right click on Foo (or hit the shortcut, F12 by default), and click “Go to Definition”, and be taken to foo.js .

One problem I found though is that by default, if the file is foo.jsx , not foo.js (at work we put React components in .jsx to differentiate them easily from plain JS files), this won’t work. We have Webpack configured to look for both .js and .jsx files, but need to tell VSCode to do the same.

The solution here is to define a jsconfig.json , which is a file that you can define to configure how VSCode understands your projects. We can tell VSCode that we’re working with JSX by adding "jsx": "react" to our jsconfig.json :

{
  "compilerOptions": {
    "baseUrl": ".",
    "jsx": "react"
  },
  "exclude": ["node_modules", "build"]
}

Note that exclude is important: here I’ve defined node_modules and also build , which is the directory that Webpack builds to. I’m doing this to stop VSCode wasting time trying to parse files in these directories.

Once you’ve updated this, you’ll find that “Go to Definition” works just fine on imports from .jsx files, as well as .js files.

If you enjoyed this article please feel free to.

Don't miss my latest course on Testing React with Enyzme and Jest ! The first five videos are free and available to watch now. You'll learn how to write testable React code, test complex components and use Jest and Enzyme effectively to write clean, thorough tests.Get started now.


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK