Recommended Visual Studio Code extensions

VSCode is already without extensions very powerful and user friendly. One thing that can make the VSCode experience even better are the extensions. There is a list of extensions we recommend that will make your life contributing to the ASAM standards way easier.

Installing an extension is really easy, just enter the extension menu, search for the desired extension. Then, click on the Install button.

AsciiDoc

The AsciiDoc extension will add the syntax the AsciiDoc interpreter to VSCode so you can use the preview feature and have syntax highlighting.

asciidoc ext
Figure 1. AsciiDoc (id: asciidoctor.asciidoctor-vscode)

Comment anchors

The Comment Anchor extension provides you with the ability of adding highlighted keywords to the raw text.

comment anchor example
Figure 2. Comment Anchors examples

The extension also lets you search for all available anchors in the repository or current file and offers a jump-to option.

commentanchor ext
Figure 3. Comment Anchors (id: exodiusstudios.comment-anchors)

Draw.io

The Draw.io extension for Visual Studio Code allows for easy creation and assisted editing of drawio and other files supported by Draw.io within Visual Studio Code. For shortcuts and tips, see the documentation of the extension. You can access this documentation when you click on the extension in the marketplace.

Search and find the extension 'Draw.io Integration'
Figure 4. Draw.io Integration (id: hediet.vscode-drawio)
The Draw.io extension does not support remote custom libraries as of now. For this reason, it is recommended to create and make larger edits to drawio files through the web app.

Code Spell Checker

The Code Spell Checker extension provides you with the ability of spell checking in Visual Studio Code.

Example 1 for Code Spell Checker
Figure 5. Code Spell Checker example 1
Example 2 for Code Spell Checker
Figure 6. Code Spell Checker example 2
Example 3 for Code Spell Checker
Figure 7. Code Spell Checker example 3

The spell checker handles standard text as well as CamelCase.

code spell checker
Figure 8. Code Spell Checker (id: streetsidesoftware.code-spell-checker)

Git graph

The Git Graph extension is a great tool navigating the branches in the git repository and provides a great overview.

gitgraph ext
Figure 9. Git Graph (id: mhutchie.git-graph)

GitLens

The GitLens Extension is a great extension to follow up on all the changes made to the documents within the repository. Gitlens provides:

  • Repository Overview

  • File History

  • Line History

  • Commit Comparison

gitlens ext
Figure 10. GitLens — Git supercharged (id: eamodio.gitlens)

Docker

The Docker extension lets you directly interact with Docker through Visual Studio Code. You can run, for example, the docker-compose.yml directly without having to open a console or using Docker Desktop.

Search and find the extension 'Docker'
Figure 11. Docker (id: ms-azuretools.vscode-docker)