/VSCodeAlloyExtension

An extension for VS Code supporting the Alloy modelling language

Primary LanguageTypeScript

This extension provides rich support for the Alloy specification language.

Note: This extension supports Alloy 6. If your specifications are not compatible with Alloy 6, use the Alloy5 extension instead.

Features

  • Running Alloy commands from VS Code (using mouse or key combo Ctrl+Shift+A E)
  • Viewing results (instances/counterexamples)
  • Editor integrated error reporting

executing alloy commands

  • Go to Definition
  • Support for Alloy Markdown files

go to definition and markdown support

  • Find References
  • Rename (works across files)

ref, rename

  • Document outline/symbol search
  • Folder symbol search

symbol

(Syntax highlighting provided by alloy-vscode)

This extension is bundled with a custom version of the Alloy analyzer JAR that implements the Language Server Protocol.

Tips

  • To change Alloy settings (SAT solver, allow warnings, etc.) open the command palette (Ctrl/Cmd+Shift+P), and find the command Open Alloy Editor. This will open the bundled Alloy analyzer.

  • To execute the Alloy command under cursor, use the command Execute Current Alloy Command (key combo Ctrl+Shift+A E).

  • To select an Alloy command from a drop down menu, use the command List Alloy Commands.

  • To execute all Alloy commands in an Alloy file, use the command Execute All Alloy Commands.

  • Code lens can be disabled by changing the preference alloy.commandHighlightMode to link (a good option if you don't like the code moving vertically while you type).

Requirements

Java (8 or higher) must be installed and included in PATH.