ChordSketch for VS Code

ChordPro language support for Visual Studio Code: syntax highlighting, diagnostics, completions, a live HTML/text preview panel, and one-keystroke transpose/export commands. The ChordPro format is a plain-text notation that interleaves chords with lyrics; this extension makes editing and previewing .cho / .chordpro / .chopro files pleasant inside VS Code.

The extension also recognises .irealb / .irealbook (iReal Pro) files as their own irealb language id so the ChordPro grammar does not misapply to a percent-encoded irealb:// URL line. Syntax highlighting and a dedicated grammar for iReal Pro files are tracked under #2357.

The extension is built on the ChordSketch toolchain — a Rust reimplementation of the ChordPro reference implementation — and bundles a prebuilt Language Server (chordsketch-lsp) binary on every supported platform. No Rust toolchain, Node.js runtime, or extra install step is required on those platforms.

Installation

Install from the VS Code Marketplace or Open VSX Registry:

code --install-extension koedame.chordsketch

Or from the Extensions sidebar: search for ChordSketch and click Install.

Platform support (prebuilt LSP bundled)

The Marketplace and Open VSX serve one universal VSIX plus seven platform-specific VSIXes so the LSP binary matches your machine automatically.

Platform	Architecture	Bundled LSP
Linux (glibc)	x86_64	✅
Linux (glibc)	arm64	✅
macOS	x86_64 (Intel)	✅
macOS	arm64 (Apple Silicon)	✅
Windows	x86_64	✅
Linux (musl / Alpine)	x86_64	✅
Linux (musl / Alpine)	arm64	✅

On any platform not in the table, VS Code installs the universal VSIX and the LSP resolver falls back to (in order) the path set by the chordsketch.lsp.path setting, then chordsketch-lsp on PATH. In that case install the CLI separately:

cargo install chordsketch-lsp

Quick start

Install the extension (above).

Open or create a file with a ChordPro extension (.cho, .chordpro, or .chopro). A minimal example:

{title: Amazing Grace}
{subtitle: Traditional}

[G]Amazing [G7]grace, how [C]sweet the [G]sound
That saved a [G]wretch like [D]me

Click the preview icon in the editor title bar (or run ChordSketch: Open Preview to the Side from the Command Palette with Ctrl+Shift+P / Cmd+Shift+P) to see the rendered song next to the source.
Run ChordSketch: Transpose Up / Down to shift every chord by one semitone.

Commands

Commands are available in the Command Palette when the active editor has language chordpro.

Command	Title	Notes
`chordsketch.openPreview`	ChordSketch: Open Preview
`chordsketch.openPreviewToSide`	ChordSketch: Open Preview to the Side
`chordsketch.transposeUp`	ChordSketch: Transpose Up	Shifts every chord by +1 semitone
`chordsketch.transposeDown`	ChordSketch: Transpose Down	Shifts every chord by −1 semitone
`chordsketch.convertTo`	ChordSketch: Export As…	Exports the current song to HTML, text, or PDF

Configuration

Settings live under ChordSketch in Settings UI (or edit settings.json directly).

Setting	Type	Default	Purpose
`chordsketch.lsp.enabled`	`boolean`	`true`	Enable the Language Server (diagnostics, completions, hover, formatting).
`chordsketch.lsp.path`	`string`	`""`	Absolute path to a `chordsketch-lsp` binary. Empty uses (1) the binary on `PATH` if present, then (2) the bundled binary for your platform.
`chordsketch.preview.defaultMode`	`"html"` \| `"text"`	`"html"`	Default rendering mode when a new preview panel opens. Changing this affects the next preview only; existing panels keep their persisted mode.

Features

Syntax highlighting for ChordPro directives, chord symbols, comments, and tab/ABC blocks via a TextMate grammar.
Live preview that re-renders on each edit, with HTML and plain text modes (see chordsketch.preview.defaultMode).
Transpose commands that shift every chord by ±1 semitone.
Export the current song as HTML, plain text, or PDF via chordsketch.convertTo.
LSP-backed diagnostics, completions, hover, and formatting when chordsketch.lsp.enabled is on (default).

License

MIT. See LICENSE.

ChordSketch

koedame