Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dfinity/vscode-motoko
Motoko language support for VS Code.
https://github.com/dfinity/vscode-motoko
autocompletion blockchain canister dfx extension formatter go-to-definition ide-extension internet-computer language-client motoko-language smart-contracts syntax-highlighting visual-studio-code vscode vscode-extension
Last synced: about 1 month ago
JSON representation
Motoko language support for VS Code.
- Host: GitHub
- URL: https://github.com/dfinity/vscode-motoko
- Owner: dfinity
- License: apache-2.0
- Created: 2019-10-30T17:22:14.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-23T16:14:31.000Z (about 2 months ago)
- Last Synced: 2024-09-29T08:04:09.099Z (about 2 months ago)
- Topics: autocompletion, blockchain, canister, dfx, extension, formatter, go-to-definition, ide-extension, internet-computer, language-client, motoko-language, smart-contracts, syntax-highlighting, visual-studio-code, vscode, vscode-extension
- Language: JavaScript
- Homepage:
- Size: 8 MB
- Stars: 42
- Watchers: 21
- Forks: 16
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Motoko · VS Code Extension
> #### Motoko language support for [Visual Studio Code](https://code.visualstudio.com/).
[](https://marketplace.visualstudio.com/items?itemName=dfinity-foundation.vscode-motoko)
[](https://github.com/dfinity/prettier-plugin-motoko/issues)
## Overview
[Motoko](https://internetcomputer.org/docs/current/motoko/main/motoko) is a high-level smart contract language for the [Internet Computer](https://internetcomputer.org/).
This IDE extension provides type checking, formatting, snippets, and more for [Motoko canister development](https://internetcomputer.org/docs/current/developer-docs/build/cdks/motoko-dfinity/motoko/).
[](https://marketplace.visualstudio.com/items?itemName=dfinity-foundation.vscode-motoko)
## Installation
Get this extension through the [VS Marketplace](https://marketplace.visualstudio.com/items?itemName=dfinity-foundation.vscode-motoko), or alternatively the [Extensions panel](https://code.visualstudio.com/docs/editor/extension-marketplace) in your VS Code project.
VSCodium users can download the extension through [Open VSX](https://open-vsx.org/extension/dfinity-foundation/vscode-motoko) or the [GitHub releases](https://github.com/dfinity/vscode-motoko/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](https://github.com/dfinity/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.
[](https://marketplace.visualstudio.com/items?itemName=dfinity-foundation.vscode-motoko)
## Other Features
- Deploy to the Internet Computer mainnet using a right-click context menu action.
- [Vessel](https://github.com/dfinity/vessel) and [MOPS](https://mops.one/) (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.
[](https://marketplace.visualstudio.com/items?itemName=dfinity-foundation.vscode-motoko)
## 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](https://play.motoko.org/)
- `Motoko: Import Mops Package...`: Search, install and import a package from [Mops](https://mops.one)
[](https://marketplace.visualstudio.com/items?itemName=dfinity-foundation.vscode-motoko)
## 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:
```json
{
"[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](https://nodejs.org/en/) and [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) are installed on your system.
```bash
git clone https://github.com/dfinity/vscode-motoko
cd vscode-motoko
npm install
```
### Run unit tests:
```bash
npm test
```
### Build the extension:
```bash
npm run package
```
This generates a file named `vscode-motoko-*.*.*.vsix` in the project root.
### Install in VS Code:
```bash
code --install-extension vscode-motoko-*.*.*.vsix
```
Alternatively, right-click the `.vsix` file and then select the "Install Extension VSIX" option.
---
Community [PRs](https://github.com/dfinity/vscode-motoko/pulls) are welcome! Be sure to check the list of [open issues](https://github.com/dfinity/vscode-motoko/issues) in case anything catches your eye.