JSON Schema References

Navigate between local JSON Schema $ref values with hover previews and go-to-definition support.

Features

• Hover a $ref string in JSON or JSONC files to preview the referenced schema snippet.
• F12 / Cmd+Click on a $ref to jump to the referenced schema location, including nested JSON Pointer targets.
• Supports relative, absolute, and file:// paths that resolve to local schema files, including $defs and legacy definitions refs like ./product.json#money and ./product.json/$defs/money.

Getting Started

1. Install dependencies and compile the extension:

   npm install
   npm run compile
   

2. Press F5 in VS Code to launch a new Extension Development Host for testing.

Notes

• Only local file references are resolved. Remote URIs (e.g. http://) are ignored.
• Fragment shorthand without a slash resolves through $defs, then legacy definitions, e.g. "#money" and "./product.json#money" target "/$defs/money" or "/definitions/money" when no direct top-level match exists.
• Pointer resolution follows the JSON Pointer specification, including ~0/~1 escape handling.
• Hover previews truncate after a few hundred characters to keep tooltips compact.

Release Automation

• Pull request checks run tests and require package.json / package-lock.json to bump above origin/main.
• To block merges, require the Branch Checks / Test and validate version bump check in the repository branch protection or ruleset for main.
• Merges to main run tests and publish the extension through vsce.
• Publishing requires a repository secret named VSCE_PAT with access to the VS Code Marketplace publisher.