Skip to content

Commit f2a2c0e

Browse files
Add the 'Features' dashboard into VS Code UG
For eng/ide/ada_language_server#1705
1 parent 05d27e7 commit f2a2c0e

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

doc/vscode-ug.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,35 @@
11
# Ada & SPARK VS Code Extension User's Guide
22

3+
This extension provides support for the Ada and SPARK programming languages in VS Code via the [Ada Language Server](https://github.com/AdaCore/ada_language_server) based on the [Libadalang library](https://github.com/AdaCore/libadalang).
4+
5+
## Features
6+
7+
Ada and SPARK are compiled languages which means that a compiler (GNAT) is needed to translate the source code into a program that can be executed.
8+
Other tools are also needed to perform tasks such as testing, static analysis and formal proof of SPARK code.
9+
10+
This extension **does not include a compiler nor additional tools**. Nonetheless it offers a number of features out of the box and more capabilities can be accessed by installing additional tools.
11+
12+
<!-- markdownlint-disable MD033 -->
13+
| Tool | Feature | Support |
14+
|----------------------------------------------|---|:-:|
15+
| **Ada & SPARK Extension** | | |
16+
| | Syntax Highlighting ||
17+
| | Navigation<br>(except standard runtime) ||
18+
| | Auto-completion<br>(except standard runtime) ||
19+
| | Refactoring ||
20+
| **GNAT Compiler** | | |
21+
| | Full Navigation ||
22+
| | Full Auto-completion ||
23+
| | Build ||
24+
| | Debug ||
25+
| **GNAT DAS** | | |
26+
| | Test ||
27+
| | Code Coverage ||
28+
| **GNAT SAS** | | |
29+
| | Static Analysis ||
30+
| **SPARK** | | |
31+
| | Formal Proof ||
32+
333
## Getting Started
434

535
Here are some links that will help you get familiar with the VS Code extension for Ada & SPARK:
@@ -48,10 +78,6 @@ Alternatively, the ALS can be configured in the VS Code settings UI or in the JS
4878
}
4979
```
5080

51-
## Refactoring
52-
53-
See a [dedicated document](./refactoring_tools.md) with the list of available refactorings.
54-
5581
## VS Code Remote
5682

5783
The Ada extension can be used on a remote workspace over SSH thanks to the [Visual Studio Code Remote - SSH](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh) extension, however there are known pitfalls regarding the environment setup.

0 commit comments

Comments
 (0)