Motoko - VS Code Extension
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.
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.
Below are the default key bindings for commonly used features supported in the extension:
- Code formatter (
F): format a Motoko file using prettier-plugin-motoko.
- Organize imports (
O): group and sort imports at the top of your Motoko file.
- Import code action (
. 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 (
Space): view all available autocompletions and code snippets.
- 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
- 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.
Motoko: Restart language server: Starts (or restarts) the language server
motoko.dfx: The location of the
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
If you want VS Code to automatically format Motoko files on save, consider adding the following to your
dfx >= 0.11.1 use a new, experimental language server.
To continue using the original language server, you can modify your
dfx.json file to use version
0.11.0 or earlier:
If you encounter any bugs, please open a GitHub issue with steps to reproduce so that we can fix the problem for everyone.
Set up your local development environment:
Ensure that Node.js >= 14.x and Cargo are installed on your system.
git clone https://github.com/dfinity/vscode-motoko
Run unit tests:
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.