Mojo for Visual Studio Code

This VS Code extension from the Modular team adds support for the Mojo programming language.

Features

• Syntax highlighting for .mojo and .🔥 files
• Code completion
• Code diagnostics and quick fixes
• API docs on hover
• Code formatting
• Run Mojo File

Get started

1. Install the Mojo SDK.
2. Install the Mojo VS Code extension.
3. Open any .mojo or .🔥 file.

Configuration

The extension will attempt to find the path of the Mojo SDK installation using the MODULAR_HOME environment variable. If MODULAR_HOME is not set within the environment, the path can be explicitly set via the mojo.modularHomePath extension setting.

{
    "mojo.modularHomePath": "/absolute/path/to/.modular"
}

Code Completion

To trigger a completion press ctrl + space, pressing ctrl + space again will bring up doc hints:

Rebind the hotkey in Preferences: Open Keyboard Shortcuts > Trigger Suggest

Hover and Doc Hints

Hover over a symbol with your cursor for doc hints. The default hotkey to trigger it in macOS is ⌘ + k, ⌘ + i or ctrl + k, ctrl + i in Linux and Windows:

Rebind the hotkey in Preferences: Open Keyboard Shortcuts > Show or Focus Hover

Code Diagnostics

Code diagnostics are indicated with an underline on the code and details appear when you hover. You can also see them in the PROBLEMS tab and use Go to Next Problem in Files to quickly cycle through them:

Rebind related hotkeys in Preferences: Open Keyboard Shortcuts > Go to Next Problem...

Tip: Also try the Error Lens extension (not associated with Modular), which will display the first line of the diagnostic inline, making it easier to quickly fix problems.

Quick Fix

If there is an available quick fix with the code diagnostic, click the lightbulb icon or use the default hotkey ctrl + . for a list of options:

Rebind the hotkey in Preferences: Open Keyboard Shortcuts > Quick Fix...

Run Mojo File

There will be a small ▶️ button up the top right of a Mojo file to run the active file:

Bind a hotkey in Preferences: Open Keyboard Shortcuts > Mojo: Run Mojo File

Code Formatting

From the command palette run Format Document or tick the setting Format on Save:

Restarting Mojo Extension

The extension may crash and produce incorrect results periodically, to fix this from the command palette search for Mojo: Restart the extension

Bind a hotkey in Preferences: Open Keyboard Shortcuts > Mojo: Restart the extension