ArchLens For VSCode

A Visual Studio Code extension that allows you to use ArchLens directly in your editor.

Installing the extension

VS Code's official marketplace

The extension can be downloaded from Visual Studio Codes official markeplace.

Using the extension file

Download the .zip file from GitHub. Unzip it, and install the extension by running the command:

code --install-extension archlens-for-vscode-<version>.vsix

Setting up the extension

The extension requires you have the official Python extension installed for it to work.

After installing the extension, you can go through a guided setup by opening VS Code's command palette using control + shift + p, and use the command:

ArchLens: Setup ArchLens

The extension

Developing the extension

navigate to the archlens-in-vscode directory and use the command

npm install

to set up the node dependencies.

Running the extension in development mode

To run the extension make sure to extension first using

npm run compile

Note: running the extension with npm run watch will work, but the graph.js will NOT hot reload.

When the project is compiled you can run the extension by pressing f5 in vscode. This will open a new instance of vscode where the extension is running.

Publishing extension

Install the VSCode extension bundler

To be able to package the extension, you need to have NPM installed, and install the VSCode extension bundler with the command:

npm install -g @vscode/vsce

Package the extension

Then, you can bundle the extension into a .vsix file using:

vsce package