Skip to content

Commit cda528c

Browse files
committed
Improve VS Code Pages
1 parent a3f4d7d commit cda528c

File tree

6 files changed

+17
-23
lines changed

6 files changed

+17
-23
lines changed

pages/vscode-extension/commands.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,17 @@ permalink: /vscode-extension/commands/
77

88
# Commands
99

10-
The LiquidJava VS Code extension provides commands to control the extension lifecycle and trigger verification manually. These commands make it possible to recover from startup issues, stop background activity, or rerun verification on demand.
11-
12-
## Command Palette
13-
14-
The extension adds a command that opens a palette listing the available LiquidJava commands. This command is executed when the status bar indicator is clicked, giving users a quick way to access extension actions from a single place.
15-
16-
## Available Commands
17-
18-
The following commands available are:
10+
The extension provides commands to control the extension lifecycle, trigger verification manually, and open the webview and output channel:
1911

2012
| Command | Description |
2113
| --- | --- |
2214
| `Start` | Starts the LiquidJava language server and client |
2315
| `Stop` | Stops the LiquidJava language server and client |
2416
| `Restart` | Stops and then starts the LiquidJava extension |
25-
| `Verify` | Manually triggers verification |
17+
| `Verify` | Manually triggers the verification |
2618
| `Show Logs` | Opens the output channel with LiquidJava logs |
2719
| `Show View` | Opens the LiquidJava webview |
2820

29-
![Commands Demo]({{ 'assets/vscode-extension/commands.gif' | relative_url }})
21+
![Commands Demo]({{ 'assets/vscode-extension/commands.gif' | relative_url }})
22+
23+
The extension adds a command that opens a palette listing the available LiquidJava commands. This command is executed when the status bar indicator is clicked, giving users a quick way to access extension actions.

pages/vscode-extension/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ cards:
3333

3434
The LiquidJava VS Code extension integrates the verifier into the editor, with real-time diagnostic reporting, syntax highlighting and autocomplete for refinements, and more. It is built as a VS Code client and a language server that communicate through the Language Server Protocol (LSP).
3535

36-
> You start using the extension, you can follow the setup guide [here]({{ 'getting-started/setup/#vs-code-extension' | relative_url }}).
36+
> To start using the extension, you can follow the setup guide [here]({{ 'getting-started/setup/#vs-code-extension' | relative_url }}).
3737
3838
{% include card_grid.html cards=page.cards %}

pages/vscode-extension/output-channel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ permalink: /vscode-extension/output-channel/
77

88
# Output Channel
99

10-
The extension provides an output channel for LiquidJava logs to inspect the extension and language server activity easily when debugging issues or unexpected behavior.
10+
The extension provides an output channel for displaying LiquidJava logs from both the client and the language server.
1111

pages/vscode-extension/status-bar-indicator.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ permalink: /vscode-extension/status-bar-indicator/
99

1010
The extension displays an indicator in the status bar in the bottom-left of the editor that shows the current LiquidJava state inside VS Code, with four possible states:
1111

12-
- `loading`: The extension is starting up
13-
- `passed`: The verification succeeded
14-
- `failed`: The verification found one or more problems
15-
- `stopped`: The extension either was stopped, failed to connect, or lost connection with the language server.
12+
| Status | Description |
13+
| --- | --- |
14+
| `loading` | The extension is starting up |
15+
| `passed` | Verification succeeded |
16+
| `failed` | Verification reported one or more errors |
17+
| `stopped` | The extension was stopped, failed to connect, or lost connection with the language server |
1618

17-
Clicking on this indicator shows the available LiquidJava commands, which is covered in the next section.
19+
Clicking on this indicator shows the available LiquidJava commands, which is covered in the next section.

pages/vscode-extension/syntax-highlighting.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@ permalink: /vscode-extension/syntax-highlighting/
77

88
# Syntax Highlighting for Refinements
99

10-
LiquidJava refinements are written inside Java string literals, which makes them easy to confuse with ordinary strings if the editor treats them as plain text. Syntax highlighting helps developers read and write these embedded specifications more confidently.
10+
LiquidJava refinements are written inside Java string literals, which makes them easy to confuse with ordinary strings if the editor treats them as plain text.
1111

12-
The extension implements refinement highlighting with an injection grammar. This grammar tokenizes the refinement language inside LiquidJava annotations and lets VS Code color those tokens according to the active theme.
13-
14-
To make refinements visually distinct from regular Java code, the highlighted refinement text is also rendered in italic. This helps separate the specification language from the surrounding Java syntax and reduces the chance of mentally mixing program code with refinement code.
12+
The extension implements refinement syntax highlighting which tokenizes the refinement language inside LiquidJava annotations and allows VS Code color those tokens according to the active theme. To make refinements visually distinct from regular Java code, the highlighted refinement text is also rendered in italic.
1513

1614
![Syntax Highlighting Demo]({{ 'assets/vscode-extension/syntax-highlighting.gif' | relative_url }})

pages/vscode-extension/webview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The context debugger reacts to the current editor selection:
3737

3838
This makes it easier to inspect the relevant context for a particular code region.
3939

40-
### Editor Interaction
40+
### Variable Highlighting
4141

4242
Clicking a variable in the context debugger highlights that variable in the editor, which helps connect the displayed context with internal variables back to the ones in the source code.
4343

0 commit comments

Comments
 (0)