jump-source for VS Code
This extension adds multiple shortcuts for quickly jumping between source files and test files.
It enables you to:
- Quickly switch to the corresponding test file for a source file and vice versa.
- Go to the closest index source file.
- List all index files in the workspace.
- Create a test file for the current source file.
- Cycle through files in the same folder with the same filename.
Features
This extension assumes that tests have the same name as the source file but with a suffix. It also assumes that the test file is located in the same folder as the source file, or in a subfolder with a known name.
The source file can have any file extension as long as the test file has the same file extension.
Example:
someSourceFile.tsx
/tests/someSourceFile.test.tsx
Extension Settings
This extension contributes the following settings:
jumpSource.testFileSuffix: Suffix to append to source file name before the file extension (default: test).jumpSource.testSubFolder: Name of sub folder containing tests (default: tests).jumpSource.relativeRoots: Use when the tests are in a directory structure which mirrors the code directory structure.jumpSource.matchExtension: When set to true the extension of the source file and test file have to match. When set to false a context menu will be shown if necessary (default: true).jumpSource.filterCaseSensitive: Used when index files are listed. When set to true the filter will exclude results with the wrong case (default: true).jumpSource.excludePattern: Used when index files are listed. This glob pattern is ignored in the file search.
Set jumpSource.testSubFolder to empty string if your tests reside within the same folder as your source files.
Usage
Jumping between source file and test file
- Open a source file that has a corresponding test file, or a test file.
- Open the command palette with Ctrl + Shift + P and choose the Jump to/from test command. You may also use the keyboard shortcut Ctrl + O T.
If your tests are located in a separate directory tree that mirrors the code directories you need to use the setting jumpSource.relativeRoots.
Jumping to the closest index file
- Open a file inside a folder with an index file.
- Open the command palette with Ctrl + Shift + P and choose the Jump to index file command. You may also use the keyboard shortcut Ctrl + O I.
The extension will jump to the index file of the current folder. If the active file is in the test sub folder it will jump to the index file in the parent folder.
List all index files in the workspace
- Open the command palette with Ctrl + Shift + P and choose the List index files command. You may also use the keyboard shortcut Ctrl + O L.
- Pick a file or filter by entering a partial folder name.
When in case sensitive mode items with the wrong case will be removed from the suggestions. However since the VS Code API doesn't allow to fully control the filter the character highlighting might not highlight as expected.
Remember to review the exclude pattern setting to speed up the search for your particular project.
Create a test file
- Open a source file.
- Open the command palette with Ctrl + Shift + P and choose the Create a test for this command. You may also use the keyboard shortcut Ctrl + O C.
If you want the test file to have a different file extension you can change the jumpSource.testFileExtension setting.
Cycle through files with the same name
When you have multiple files in the same folder with the same filename but different file extensions, you can cycle through them by opening the command palette with Ctrl + Shift + P and choose the Cycle through files with the same name command. You can also use the keyboard shortcut Shift + Alt + -.
This command is always case insensitive.
