An open API service indexing awesome lists of open source software.

https://github.com/avin/vscode-quick-jump-to-file

VS Code extension for quickly jumping to a file by its name in a string
https://github.com/avin/vscode-quick-jump-to-file

Last synced: 26 days ago
JSON representation

VS Code extension for quickly jumping to a file by its name in a string

Awesome Lists containing this project

README

          

# Quick Jump To File

VS Code extension that extends `Go to Definition` for string path references like `./foo/bar` or `/foo/bar`.

## How It Works

Place the cursor inside a string path and use the standard `Go to Definition` action:

- Relative links such as `./foo/bar` are resolved from the current file.
- Root-relative links such as `/foo/bar` are resolved from the workspace root or configured search paths.
- If the resolved target is a directory, the extension looks for configured index file names inside that directory.
- File matching is based on the filename part before the first dot.

Examples for `./foo/bar`:

- `bar` wins over `bar.ts` and `bar.component.ts`
- `bar.ts` wins over `bar.component.ts`
- `bar.ts` and `bar.js` are returned together so VS Code can show its standard choice UI
- If `bar` is a folder, files like `bar/index.ts` are resolved through the configured index names

## Settings

This extension contributes the following settings:

- `quickJumpToFile.searchPaths`: directories used for links that start with `/`. Default is `["/"]`, which means the workspace root.
- `quickJumpToFile.indexFileNames`: base names used when the target path is a directory. Default is `["index"]`.
- `quickJumpToFile.ignoredFilePatterns`: regex patterns applied only to the final filename. Matching files are excluded from results.

Example:

```json
{
"quickJumpToFile.searchPaths": ["src", "public"],
"quickJumpToFile.indexFileNames": ["index", "main"],
"quickJumpToFile.ignoredFilePatterns": ["\\.test\\..*$"]
}
```

## Notes

- Ignore patterns are checked only against the final file name, not parent directories.
- The extension works through the standard definition flow, so `Ctrl+Click`, `F12`, and related VS Code actions use the same resolver.