TomlJump

Ctrl+click a path or key in a TOML file and jump straight to the file it names,
or to the code that reads it.
在 TOML 文件里 Ctrl+点击路径或 key，直接跳到它指向的文件，或跳到读取它的代码。

TomlJump makes TOML files navigable. Click schema = "./schemas/user.json" to open the file it names, or click [server] to land on the Go struct, Python class, or TypeScript interface that reads it, then click that declaration to come back. It uses the stable VS Code Extension API and packages as a standard VSIX for VS Code and compatible editors.

Features

• Jump from TOML string file paths to project files.
• Navigate both ways between TOML tables and keys and matching source declarations.
• Navigate pyproject.toml project scripts to Python modules and callables.
• Resolve conservative configuration declarations in Go, Python, Java, TypeScript, and JavaScript.
• Use the editor's native Go to Definition action and command/control click.
• Return multiple credible targets through the editor's native definition UI.

TomlJump intentionally does not replace TOML syntax highlighting, formatting, schema validation, diagnostics, completion, or rename support. It focuses on high-confidence navigation and stays quiet when a configuration relationship is not credible.

Compatibility

TomlJump requires VS Code Extension API 1.85 or later and uses no proposed or product-specific APIs. The standard VSIX is designed for editors that implement this API baseline.

Installation

Open the Extensions view with Ctrl/Cmd+Shift+X, search for TomlJump, and select Install.

To build and install a local VSIX from the repository instead:

cd plugins/vscode
npm ci
npm run package

Then install the tomljump-vscode-<version>.vsix produced under build/ through the Extensions view using Install from VSIX....

Usage

Use the editor's normal Go to Definition action or Ctrl/Cmd-click on supported TOML paths, table/key leaf segments, source configuration declarations, and Python entry-point segments. When multiple credible definitions exist, the editor presents its native target list.

Privacy

TomlJump does not collect telemetry and does not send project files or navigation data over the network. Workspace files are read locally only when resolving a definition request.

TomlJump 让 TOML 文件可以跳转。点击 schema = "./schemas/user.json" 打开它指向的文件，或点击 [server] 跳到读取它的 Go struct、Python class 或 TypeScript interface，再点击那个声明即可跳回来。扩展使用稳定版 VS Code Extension API，并以标准 VSIX 形式支持 VS Code 及兼容编辑器。

功能

• 从 TOML 字符串文件路径跳转到项目文件。
• 在 TOML table、key 与匹配的源码配置声明之间双向跳转。
• 从 pyproject.toml 的 project scripts 跳转到 Python 模块和 callable。
• 支持 Go、Python、Java、TypeScript、JavaScript 中的保守配置匹配。
• 使用编辑器原生 Go to Definition 和 command/control click。
• 存在多个可信目标时，使用编辑器原生定义列表展示。

TomlJump 不替代 TOML 语法高亮、格式化、schema 校验、诊断、补全或重命名。它只专注于高置信度导航；当配置关系不够可信时会静默跳过。

兼容性

TomlJump 需要编辑器实现 VS Code Extension API 1.85 或更高版本，不使用 proposed API 或产品专用 API。标准 VSIX 可安装到实现该 API 基线的编辑器。

安装

在编辑器中用 Ctrl/Cmd+Shift+X 打开 Extensions 视图，搜索 TomlJump，然后点击 Install。

也可以从仓库构建本地 VSIX 安装：

cd plugins/vscode
npm ci
npm run package

然后在 Extensions 视图中选择 Install from VSIX...，安装 build/ 下生成的 tomljump-vscode-<version>.vsix。

使用

在支持的 TOML 路径、table/key 叶子段、源码配置声明和 Python entry point 片段上，使用编辑器原生 Go to Definition 或 Ctrl/Cmd-click。存在多个可信定义时，编辑器会展示原生目标列表。

隐私

TomlJump 不收集遥测数据，也不会通过网络发送项目文件或导航数据。仅在解析定义请求时读取本地工作区文件。

License / 许可证

TomlJump is released under the MIT License. TomlJump 使用 MIT 许可证发布。