VS Code Extension

Real-time validation, auto-completion, and IntelliSense for Journium tracker files. Works with VS Code, Cursor, and compatible editors.

The Journium VS Code extension provides real-time validation, auto-completion, and tooling for insight tracker files. Works with VS Code and VS Code-compatible editors like Cursor.

Installation

Recommended: Install from Your IDE

The quickest way to install is directly from your editor's Extensions view:

Open your editor (VS Code, Cursor, or other compatible IDE)
Go to the Extensions view (Cmd+Shift+X / Ctrl+Shift+X)
Search for "Journium"
Click Install

Alternative: Direct Download

You can also install directly from these registries:

VS Code users: VS Code Marketplace
Cursor and other editors: Open VSX Registry

Many VS Code-compatible editors like Cursor use the Open VSX Registry as their extension source.

Features

Automatic Activation

The extension activates automatically when it detects tracker files in .journium/trackers/ within your workspace. No manual configuration required.

Real-time Schema Validation

Get instant feedback as you write tracker YAML files. The extension validates all files under .journium/trackers/ against the Journium insight tracker schema, catching errors before deployment.

IntelliSense Support

Benefit from auto-completion, hover documentation, and inline schema hints while editing tracker files. Write trackers faster with contextual suggestions.

Monorepo Ready

Works seamlessly with monorepos and nested folder structures. The extension detects tracker files at any depth within your workspace.

Getting Started

Once installed, the extension works automatically:

Create or open a workspace containing a .journium/trackers/ folder
Add YAML files to define your trackers
Start editing—validation and IntelliSense activate automatically

The extension activates when it detects files matching **/.journium/trackers/**/*.yml or **/.journium/trackers/**/*.yaml.

How It Works

The extension configures the Red Hat YAML extension to validate tracker files using the Journium schema. When activated, it adds this configuration to your workspace settings:

{
  "yaml.schemas": {
    "https://journium.app/schemas/journium-insight-tracker.schema.json": [
      "**/.journium/trackers/**/*.yml",
      "**/.journium/trackers/**/*.yaml"
    ]
  }
}

This configuration:

Only affects files under .journium/trackers/—other YAML files remain unchanged
Persists across sessions
Can be committed to version control to share with your team

Manual Configuration

If you need to manually trigger configuration, use the Command Palette:

Open Command Palette (Cmd+Shift+P / Ctrl+Shift+P)
Run: Journium: Enable schema validation for this workspace

This is useful for setting up validation before creating tracker files.

Requirements

VS Code 1.105.0 or higher (or compatible editor like Cursor)
Red Hat YAML extension (installed automatically as a dependency)

Verify your tracker files are under .journium/trackers/
Check that files have .yml or .yaml extensions
Run the manual configuration command from the Command Palette
Reload the window (Developer: Reload Window)

Removing Validation

To remove schema validation from your workspace:

Open .vscode/settings.json in your workspace
Remove the yaml.schemas entry for journium-insight-tracker.schema.json
Save the file