OCaml 开发工具配置

前一章,我们讲了简明安装教程,你应该会用brew 安装opam和dune。

那么现在教大家用vscode 来进行开发

ocaml实验室,提供了一个vscode 专用插件

https://github.com/ocamllabs/vscode-ocaml-platform

安装

下面我们首先安装扩展依赖项,然后安装扩展本身。您可以颠倒顺序;只是如果没有所有依赖项,扩展将无法充分发挥作用。

  1. 安装扩展依赖项

    此 VS Code 的大部分 OCaml 语言支持功能需要 OCaml 语言服务器(通常称为ocaml-lspor ocamllsp)。像往常一样使用您选择的包管理器安装 ocaml-lsp-server包: OPAM或 esy。包管理器的安装说明可 在此处获得。

    确保将包安装在 用于编译项目的沙箱(通常是 OPAM开关或 esy 沙箱)中。

    可选:

    • 如果您需要源文件格式支持,请安装 ocamlformat包。

      注意:格式化支持需要.ocamlformat在项目根目录中有文件。

    • 当您将光标悬停在 OCaml 代码上时,扩展程序会向您显示代码的类型。要获得格式良好的类型,请安装 ocamlformat-rpc 包。

  2. 从 VSCode Marketplace安装此扩展。VSCode 扩展安装说明可 在此处获得。

如果您使用的是 Mac 或 Linux,现在您应该已安装并准备好所有必要的东西。您可以跳过下面名为“Windows”的小节并继续“为您的项目设置扩展”。

在 Windows 上

安装OCaml for Windows并确保ocaml-env程序可在 PATH 上访问(ocaml-env位于usr/local/bin相对于安装目录的文件夹中)。

为您的项目设置扩展

  1. 打开您的 OCaml/ReasonML 项目 ( File > Add Folder to Workspace...)。

  2. 将扩展配置为使用所需的沙箱(通常是 OPAM 开关或 esy 沙箱)。你可以选择它

    • 调用 VSCode 命令“OCaml:为此工作区选择沙箱”(可以从 VSCode 命令面板 - Ctrl+P 或在 MacOS CmdShift+上执行此操作P

    • 或单击 VSCode 窗口底部的包图标并从菜单中选择您的沙箱

      选择沙盒

    什么是沙盒?简而言之,沙盒的主要目的是指定此扩展应如何调用其依赖项,例如 ocaml-lsp-serveror ocamlformat。有关什么是沙盒的更多信息,请参阅“沙盒”小节。

  3. 使用Dune构建您的项目以获得定义、自动完成等。

    重要提示:OCaml 语言服务器有关于您上次构建项目的文件的信息。

    警告 1:由于上述说明,在您的项目的积极开发期间,我们建议您使用 dune 在轮询模式下使用选项构建您的项目--watch。每当您的项目中的文件发生更改时,这都会重新构建您的项目。例如, dune build --watch --terminal-persistence=clear-on-rebuild在您的 VSCode 集成终端中运行。

    警告 2:保存当前打开的文件以获取最新的诊断信息(错误和警告波浪线下划线)。例如,如果您A在某个文件中创建了一个模块,但您仍然收到当前文件中“未绑定”(即未找到)的错误消息,请保存该文件以获取最新的诊断信息,假设您构建了您的添加后的项目A或正在以轮询模式运行构建,并确保该错误不是陈旧的错误。

至此,您应该准备好一个可以工作的 OCaml 开发编辑器。

分类: 默认 标签: 发布于: 2022-06-21 09:54:39, 更新于: 2022-06-21 12:26:03