Surge Language Support

Syntax highlighting and real-time diagnostics for Surge configurations, modules, and rule sets in Visual Studio Code.

Requires Surge Mac 6.10.0 or later and VS Code 1.85 or later on macOS.

Features

• Syntax highlighting for configurations, modules, and rule sets.
• Errors and warnings as you edit, including unknown keys in [General].
• Automatic file detection, including .sgconf, .dconf, and .sgmodule.
• Context-aware validation of detached configurations when their main profile is open.

Getting started

1. Install Surge Mac 6.10.0 or later in your Applications folder.
2. Install this extension and open a Surge file in a trusted VS Code window.
3. Errors and warnings appear in the editor and the Problems panel.

If a file is not detected automatically, select Surge Configuration, Surge Module, or Surge Rule Set from the language menu at the bottom right. Rule Set mode supports RULE-SET files, not plain domain lists (DOMAIN-SET).

Standalone .dconf files receive syntax checks. Open the main profile alongside its included files to check references to policies and scripts.

Settings and troubleshooting

The default CLI path is /Applications/Surge.app/Contents/Applications/surge-cli. If Surge is installed elsewhere, update surge.languageServer.path in Settings. Set surge.autoDetect to false to disable automatic file detection.

The extension checks CLI compatibility before starting diagnostics and prompts you to upgrade if the installed CLI is too old.

If diagnostics are unavailable, confirm your Surge version and CLI path, then run Surge: Restart Language Server. Details are available in Output → Surge Language Server.

Diagnostics run locally and do not apply changes to Surge. Remote workspaces and VS Code for the Web are not supported.

Learn more about Surge