PlanQ for Visual Studio Code

PlanQ brings Plan as Code authoring to .plan files:

• TextMate syntax highlighting
• diagnostics, completion, hover, definitions, references, and rename
• deterministic document formatting
• a read-only Gantt preview beside the editor

PlanQ owns parsing, validation, reference resolution, and formatting. The extension starts the installed planq lsp process and does not reimplement those rules in TypeScript.

Install

Install PlanQ by publisher planq-cli from the Visual Studio Marketplace, or run:

code --install-extension planq-cli.planq

The extension requires VS Code 1.90.0 or later.

Install the PlanQ CLI

The extension does not download the PlanQ executable. Install the current stable CLI from the PlanQ installation guide, then verify it in the environment used to launch VS Code:

planq version

By default the extension starts planq lsp. If a GUI-launched VS Code cannot find the executable, set the machine-scoped Plan: Server Path setting to the executable's absolute path:

{
  "plan.server.path": "/absolute/path/to/planq"
}

The setting is intentionally machine-scoped. Do not commit a developer-specific path to workspace settings.

Edit and format

Open any .plan file to activate the extension. Format Document uses the same deterministic formatter as planq format.

To format on save, add:

{
  "[plan]": {
    "editor.formatOnSave": true
  }
}

Date completion appears after valid :start, :end, :date, and :deadline fields. Completion inserts absolute YYYY-MM-DD values. Language features and diagnostics come from planq lsp; syntax highlighting alone does not imply that a plan is semantically valid.

Open the Gantt preview

Run Plan: Open Preview to Side from a saved local .plan file. The extension starts:

planq dev <absolute-file> --no-open

and embeds the official PlanQ workbench. The preview reads the last saved version, reuses one panel per file, and refreshes after entry or include files are saved. Use Plan: Restart Preview to restart that file's local bridge.

The preview requires access to https://planq.dev. Setting PLAN_SITE=https://plan.tidean.com selects the supported China endpoint.

Desktop localhost preview is supported. Automatic port mapping for Remote SSH, Dev Containers, and Codespaces is not currently supported, and the extension rejects those preview sessions before starting a process. LSP editing features remain available when the configured planq executable is reachable.

Commands

• Plan: Restart Language Server
• Plan: Show Language Server Output
• Plan: Open Preview to Side
• Plan: Restart Preview

Offline VSIX installation

When Marketplace access is unavailable, obtain the official versioned VSIX through PlanQ support and install it without unpacking or modifying it:

code --install-extension planq-0.1.2.vsix
code --list-extensions --show-versions | grep '^planq-cli\.planq@'

Troubleshooting

• Run planq version in the VS Code launch environment.
• Set plan.server.path to an absolute executable path when PATH lookup fails.
• Open Plan: Show Language Server Output for startup, stderr, exit, and restart details.
• Open the Plan Preview output channel for bridge startup or URL errors.
• Restart the language server after upgrading the CLI.
• Confirm that the selected official workbench origin is reachable when the preview remains blank.
• See the PlanQ troubleshooting guide for installation and environment-specific checks.

License

This extension is source-available under the PolyForm Noncommercial License 1.0.0. It is not offered under an OSI-approved open-source license.