LLM Notice: This documentation site supports content negotiation for AI agents. Request any page with Accept: text/markdown or Accept: text/plain header to receive Markdown instead of HTML. Alternatively, append ?format=md to any URL. All markdown files are available at /md/ prefix paths. For all content in one file, visit /llms-full.txt
Skip to main content

Cadence VS Code Extension

This extension integrates [Cadence], the resource-oriented smart contract programming language of Flow, into Visual Studio Code. It provides features like syntax highlighting, type checking, code completion, etc.

Note that most editing features (type checking, code completion, etc.) are implemented in the Cadence Language Server.

Features​

  • Syntax highlighting (including in Markdown code fences)
  • Run the emulator, submit transactions, scripts from the editor

Installation​

To install the extension, ensure you have the VS Code IDE installed.
Then, you can install the Cadence extension from the VS Code Marketplace.

Develop the extension​

Prerequisites​

  • Must have Typescript installed globally: npm i -g typescript

Get started​

  • Run the Typescript watcher: tsc -watch -p ./
  • Press F5 in VSCode to launch the extension.
  • Manually reload the extension host when you make changes to TypeScript code.

Configuration for extension host if missing (launch.json):​


_13
{
_13
"version": "0.2.0",
_13
"configurations": [
_13
{
_13
"type": "extensionHost",
_13
"request": "launch",
_13
"name": "Launch Extension",
_13
"runtimeExecutable": "${execPath}",
_13
"args": ["--extensionDevelopmentPath=${workspaceFolder}"],
_13
"outFiles": ["${workspaceFolder}/out/**/*.js"]
_13
}
_13
]
_13
}

Build​

If you build the extension from source, you need to build both the extension itself and the Flow CLI (if you don't already have a version installed). Unless you're developing the extension or need access to unreleased features, use the Flow CLI install option (above). It's much easier!

If you haven't already, install dependencies.

script

_10
npm install

Next, build and package the extension.

script

_10
npm run package

This will result in a .vsix file that contains the packaged extension.

Install the packaged extension.

script

_10
code --install-extension cadence-*.vsix

Restart VS Code and the extension is installed!

Rate this page