Norq for Visual Studio Code
Editor support and live preview for Norq notification templates.
Features
- Diagnostics — real-time errors and warnings as you type (missing variables, schema violations, null safety)
- Completions — autocomplete for variables, pipes, directives, partials, and config keys
- Hover — type info and documentation on hover for variables, pipes, and directives
- Null safety — warns when using optional fields without
:::if guard or | default pipe
- Code actions — quick fixes for common issues
- Live preview — render email, Slack, push, and other channel outputs in a side panel (
Cmd+K V / Ctrl+K V)
- Sample switching — toggle between data samples in the preview panel
- File icons — distinct icons for each channel file and config file
Supported Files
The extension activates in any workspace containing a norq.config.yaml and provides language support for:
| File |
Language ID |
email.md |
Norq Email |
sms.md |
Norq SMS |
slack.md |
Norq Slack |
push.md |
Norq Push |
whatsapp.md |
Norq WhatsApp |
msteams.md |
Norq MS Teams |
_shared/*.md |
Norq Partial |
norq.config.yaml |
Norq Config |
data.schema.yaml |
Norq Schema |
data.samples.yaml |
Norq Samples |
tests.yaml |
Norq Tests |
Requirements
The norq CLI binary must be installed and available on your PATH.
brew install suprsend/tap/norq # macOS / Linux
# or download from https://github.com/suprsend/norq/releases
Preview
Open any channel template and press Cmd+K V (macOS) or Ctrl+K V (Windows/Linux) to open the live preview panel. The preview updates as you edit.
Use the sample dropdown in the preview panel to switch between data samples defined in data.samples.yaml.
Commands
| Command |
Keybinding |
Description |
Norq: Open Preview |
Cmd+K V / Ctrl+K V |
Open the channel preview panel |
Settings
| Setting |
Description |
Default |
norq.binaryPath |
Explicit path to the norq binary |
Auto-detect |
Links
| |
