Skip to main content

VS Code Extension Overview

Installation​

More details on how to install Taqueria VS Code Extension can be found here

Overview​

The extension consists of the following sections in VS Code:

  1. System check to make sure your system has what it needs
  2. Taqueria projects that you have initialized
  3. Projects created from a Scaffold
VS Code extension intro
note

The Taqueria VS Code Extension provides direct access to Taqueria tasks. Under the hood, the VS Code Extension makes calls to the CLI, so you can be assured the behaviour of tasks will remain consistent regardless of whether they are executed from a terminal or the extension. The steps in this guide are for using the Taqueria CLI, but you can also run the commands from the Taqueria extension if you prefer

Starting a Taqueria Project​

After new project created or the extension is opened on existing taqueria project it will show up next sections:

VS Code extension project sections

Each section can be hidden and unhidden. More details can be found on the picture​

VS Code extension hide and un-hide

Plugins Section​

Plugins section allows to install and uninstall plugins to the project.

  1. Install/Uninstall icon allows to add/remove plugin to the project
  2. Indicator displays that plugin is not installed
  3. Indicator displays that plugins has been installed to the project
VS Code extension Plugins section

Contracts Section​

Contracts section allows users to see all contracts in Contracts folder. It also allows users compile contract if compile plugin installed. Each compiler has it is own icon e. g. Archetype, SmartPy, LIGO

  1. Compile contract to Michelson format
VS Code extension Contracts section

Artifacts Section​

Artifacts section allows to see compiled contracts and other files into Artifacts folder. It also allows to deploy a contract to an environment Additionally it allows to generate types for all contracts/storages located into the folder

  1. Generate types for all .tz files in the Artifacts folder
  2. Deploy a contract to an environment
VS Code extension Artifacts section

If there are multiple environments created into config.json Taqueria VS Code extention will pop-up dialog box to select an environment.

VS Code extension select environment

Sandboxes Section​

Sandboxes section allows to interact with sandbox and also provides details about contracts/accounts deployed to this sandbox (if it is running)

  1. Start sandbox (inactive if sandbox is running)
  2. Stop sandbox (inactive if sandbox is not running)
  3. Reload sandbox to reset it to default state
  4. List accounts deployed to the sandbox. The output will include only named accounts (Total number of accounts will be less than in the sandbox, because there are three service accounts).
  5. Arrow that can be expand to see each account details in the real-time
  6. Arrow that can be expand to see each deployed contract details in the real-time
VS Code extension Sandboxes section

Environments Section​

Environments section allows to see how many different environments this project has. It also allows to see if it is a sandbox environment only or it has some test network configuration.

  1. List of the environments
VS Code extension Environments section

Tests Section​

Tests section allows to create set of tests grouped by name and also run them

  1. Create set of tests
  2. Run set of tests
VS Code extension Tests section