在Visual Studio Code中安装mojo扩展及基本使用

时间:2024-10-01 15:54:16

Modular 团队对 VS Code 扩展增加了对 Mojo 编程语言的支持。

主要的功能特点

  • .mojo和.????文件的语法突出显示
  • 代码补全
  • 代码诊断和快速修复
  • 文档字符串代码块的完整 LSP 体验
  • 转到符号
  • 悬停时显示 API 文档
  • 代码格式
  • 运行 Mojo 文件

开始使用

  • 安装 Mojo SDK
  • 安装 Mojo 在VS Code中的扩展
  • 打开任意的 .mojo or .???? file.

配置

扩展将尝试使用环境变量查找 Mojo SDK 安装的路径MODULAR_HOME。如果MODULAR_HOME环境中未设置,则可以通过 扩展设置明确设置路径,见下图。
在这里插入图片描述

Mojo SDK 解决方案

每当您想要对文件执行操作时,扩展程序都会寻找能够为其提供服务的合适 Mojo SDK。搜索将从 文件的工作区设置开始(如果可用)。否则,扩展程序将尝试使用相同的设置,但在用户级别。然后,它将尝试使用MODULAR_HOME环境变量。如果这些尝试均无效,扩展程序将回退到使用 当前窗口中任何打开的工作区的工作区级别定义的设置。如果用户打开不属于任何活动工作区的 Mojo 文件并希望获得一些扩展支持,这将特别有用。

调试器


Mojo 包含功能齐全的 LLDB 调试器。您可以按下▶️Mojo 文件右上角按钮旁边的向下箭头,然后选择 Debug Mojo File:

  • 默认快捷键为F5,您可以在偏好设置中重新绑定相关热键:打开键盘快捷键 >Debug: Start Debugging

代码完成


要触发完成按ctrl + space,ctrl + space再次按将显示文档提示:

  • 在“首选项”中重新绑定热键:打开键盘快捷键>Trigger Suggest

悬停和文档提示


将光标悬停在符号上以获取文档提示。在 macOS 中触发它的默认热键是⌘ + k, ⌘ + i
Linux和 Windows 中是 :ctrl + k, ctrl + i

  • 在“首选项”中重新绑定热键:打开键盘快捷键> Show or Focus Hover

签名帮助


⌘ + shift + spaceMojo 提供函数重载功能,因此您需要一种方法来滚动浏览可用的多个签名。您可以使用macOS 或ctrl + shift + spaceLinux 或 Windows 中的热键来调出此功能 。

  • 在“偏好设置”中重新绑定相关热键:打开键盘快捷键 > Trigger Parameter Hints

代码诊断


代码诊断在代码上用下划线表示,鼠标悬停时会显示详细信息。您还可以在PROBLEMS选项卡中查看它们,并使用 Go to Next Problem in Files它们快速循环浏览它们:

  • 在“偏好设置”中重新绑定相关热键:打开键盘快捷键 > Go to Next Problem…

提示:还可以尝试Error Lens扩展(与模块化不关联),它将显示诊断内联的第一行,从而更容易快速修复问题。

文档字符串代码块


Mojo 独有的功能是,您可以获得文档字符串内代码块的完整 LSP 体验,以及这里提到的所有功能,包括完成和诊断:

转到符号


在 macOS用⌘ + shift + o,Linux 和 Windows 中用ctrl + shift + o快速跳转到文件中的符号。
这也启用了资源管理器窗口中的大纲视图。

在“首选项”中重新绑定热键:打开键盘快捷键> Go to Symbol in Editor

快速解决问题


如果代码诊断有可用的快速修复,请单击灯泡图标或使用默认热键ctrl + .查看选项列表:

  • 在“首选项”中重新绑定热键:打开键盘快捷键> Quick Fix…

运行 Mojo 文件


该扩展在 Mojo 文件的右上角提供了一组操作来运行活动文件,默认情况下,这些操作位于▶️编辑器右上角的一个小按钮下:

Mojo 右键单击 Mojo 文件时,也可以在命令面板和文件资源管理器的子菜单中使用这些操作:

您可以将热键绑定到此处列出的任何操作。例如,要为“运行 Mojo 文件”操作绑定热键,请打开首选项,然后选择 Keyboard Shortcuts > Mojo: Run Mojo File。

代码格式


从命令面板运行Format Document或勾选设置 Format on Save:

重启 Mojo 扩展


偶尔扩展可能会定期崩溃并产生不正确的结果,要修复此问题,请从命令面板搜索Mojo: Restart the extension

  • 在“偏好设置”中绑定热键:打开键盘快捷键 > Mojo: Restart the extension