Awesome

Motoko · VS Code Extension

Motoko language support for Visual Studio Code.

Overview

Motoko is a high-level smart contract language for the Internet Computer.

This IDE extension provides type checking, formatting, snippets, and more for Motoko canister development.

Installation

Get this extension through the VS Marketplace, or alternatively the Extensions panel in your VS Code project.

VSCodium users can download the extension through Open VSX or the GitHub releases page.

Keyboard Shortcuts

Below are the default key bindings for commonly used features supported in the extension:

• Code formatter (Shift + Alt + F): format a Motoko file using prettier-plugin-motoko.
• Organize imports (Shift + Alt + O): group and sort imports at the top of your Motoko file.
• Import code action (Ctrl/Cmd + . while hovering over an unresolved variable): show quick-fix options.
• Go to definition (F12): jump to the definition of a local or imported identifier.
• IntelliSense (Ctrl + Space): view all available autocompletions and code snippets.

Other Features

• Deploy to the Internet Computer mainnet using a right-click context menu action.
• Vessel and MOPS (the two most popular Motoko package managers) are supported out-of-the-box in this extension.
• Quickly convert between Motoko types using code snippets such as array-2-buffer or principal-2-text.
• In case you're hoping to learn Motoko without installing dfx, the Motoko VS Code extension works standalone on all major operating systems (including Windows).
• This extension also provides schema validation and autocompletion for dfx.json config files.
• View type information and documentation by hovering over function names, imports, and other expressions.

Commands

• Motoko: Restart language server: Starts (or restarts) the language server
• Motoko: Deploy (20 minutes): Temporarily deploys the currently open file to the Internet Computer via Motoko Playground
• Motoko: Import Mops Package...: Search, install and import a package from Mops

Settings

• motoko.dfx: The location of the dfx binary
• motoko.canister: The default canister name to use in multi-canister projects
• motoko.formatter: The formatter used by the extension
• motoko.legacyDfxSupport: Uses legacy dfx-dependent features when a relevant dfx.json file is available

Advanced Configuration

If you want VS Code to automatically format Motoko files on save, consider adding the following to your settings.json configuration:

{
  "[motoko]": {
    "editor.defaultFormatter": "dfinity-foundation.vscode-motoko",
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
        "source.organizeImports": true
    }
  }
}

Contributing

Set up your local development environment:

Ensure that Node.js >= 16.x and Cargo are installed on your system.

git clone https://github.com/dfinity/vscode-motoko
cd vscode-motoko
npm install

Run unit tests:

npm test

Build the extension:

npm run package

This generates a file named vscode-motoko-*.*.*.vsix in the project root.

Install in VS Code:

code --install-extension vscode-motoko-*.*.*.vsix

Alternatively, right-click the .vsix file and then select the "Install Extension VSIX" option.

Community PRs are welcome! Be sure to check the list of open issues in case anything catches your eye.