🐪

OCaml: OCaml用にVisual Studio Codeをセットアップする

2024/03/23に公開

はじめに

Visual Studio Code (以下、VS Code)は多言語をサポートする強力なエディタです。
OCaml用の拡張機能も提供されています。
この記事では、VS CodeでのOCaml開発環境の構築方法を紹介します。

1. OCamlパッケージのインストール

1.1 LSPサーバのインストール

VS CodeOCaml Platform拡張機能は、LSP (Language Server Protocol)を使用しています。
OCamlLSPサーバパッケージをインストールし、動作を確認します。

次のコマンドで、OCamlLSPをインストールします:

opam install --yes ocaml-lsp-server

注意:
関連パッケージを自動的にインストールするため、--yesオプションを追加しています。

LSPの動作確認は、ocamllspを実行してエラーメッセージが出力されることを確認します。
次の手順で、LSPを動作確認します:

  1. LSPサーバの起動:
    次のコマンドでLSPサーバを起動する

    ocamllsp
    
  2. エラーメッセージの確認:
    [Enter]キーを押して、LSPサーバからエラーメッセージを出力されるかを確認する
    注意:
    これは、LSPサーバが正常に動作していることを確認するため

      # [Enter]を押す
    
    /-----------------------------------------------------------------------
    | Internal error: Uncaught exception.
    | Error: content length absent
    

    上記のようなエラーメッセージが出力される

  3. LSPサーバの停止:
    [Ctrl+C]を入力し、LSPを中止する

    ^C  # [Ctrl+C]を押して、中止する
    
    >
    

上記のようにエラーメッセージが出力されれば、LSPは正常にインストールされています。

1.2 コード整形ツールのインストール

OCamlのコードを整形するツールocamlformatをインストールし、動作を確認します。
次のコマンドで、コード整形ツールをインストールします:

opam install --yes ocamlformat

次の手順で、コード整形ツールの動作を確認します:

  1. フォーマッタ用に.ocamlformatを作成する:

    touch .ocamlformat
    
  2. コード整形用にプログラムを作成する:

    hello.ml
     (* my first OCaml program *)
     print_endline "Hello, OCaml!!"
    
    
  3. 上記のOCamlプログラムをフォーマッタで整形する:

    ocamlformat hello.ml
    (* my first OCaml program *)
    print_endline "Hello, OCaml!!"
    
    

    注意:
    Warningエラーが出る場合は、--enable-outside-detected-projectを追加する

上記のように整形されたプログラムが出力されれば、フォーマッタの正常にインストールされています。

2. 拡張機能のインストール

2.1 OCaml Platformのインストール

OCaml PlatformLSPを利用して、コーディング時にタブ補完やエラーチェックを行います。
次の手順で、OCaml Platformをインストールします:

  1. VS Codeを起動する:

    code .
    
  2. [拡張機能ビュー]を表示する:
    [Ctrl+Shift+X]を入力し、[拡張機能ビュー]を表示する。

  3. [OCaml Platform]を検索する:
    上部の検索バーにocamlと入力し、[OCaml Platform]を検索する。

  4. [OCaml Platform]をインストールする:
    [インストール]をクリックし、[OCaml Platform]をインストールする。

2.2 Code Runnerのインストール

Code Runnerは、編集中のプログラムを簡単に実行できる拡張機能です。
編集するプログラミング言語にあわせて、適当なコマンドを実行します。

次の手順で、[Code Runner]をインストールします。

  1. VS Codeを起動する:

    code .
    
  2. [拡張機能ビュー]を表示する:
    [Ctrl+Shift+X]を入力し、[拡張機能ビュー]を表示する。

  3. [Code Runner]を検索する:
    上部の検索バーにcodeと入力し、[Code Runner]を検索する。

  4. [Code Runner]をインストールする:
    [インストール]をクリックし、[Code Runner]をインストールする。

2.3 Code Runnerの設定

[Code Runner]を使用するため、設定ファイルにOCaml用の設定を追加します。

次の手順で、OCaml用の設定を追加します。

  1. VS Codeを起動する:

    code .
    
  2. 設定ファイルを開く:
    [Ctrl+Shift+P]として、[Open User Settings (JSON)]を選び、設定ファイル(settings.json)を開く。

  3. OCaml設定を追加する:
    設定ファイル (settings.json)に次の行を追加する。
    これにより、OCamlでのプログラム実行時に適切なコマンドが使用される。

settings.json
code-runner.executorMap": {
  "ocaml": "cd $dir && ocaml $fileName"
}

注意:
OCaml以外の言語で環境構築する場合は、executorMapセクション内にほかの言語の設定を追加します。

以上で、Run Codeでプログラムが実行できます。

おわりに

この記事では、VS CodeOCamlの拡張機能を追加する方法を説明しました。
このように拡張機能を使用することで、OCamlによる関数型プログラミングの学習がより便利になりました。

今後はVS Codeを活用して、OCamlで関数型プログラミングを学習しましょう。
それによって、さらにスキルを向上させていきましょう。

それでは、Happy Hacking!

技術用語と注釈

この記事で使用される主な技術用語について解説します:

  • OCaml:
    強力な型システムを特徴とする関数型プログラミング言語

  • VS Code (Visual Studio Code):
    Microsoft によって開発された、軽量で強力な機能を持つコードエディタ

  • opam:
    OCaml用のライブラリやツールを提供するOCamlパッケージマネージャー

  • LSP (Language Server Protocol):
    エディタ、IDE用に統一された方法でプログラミング言語のサポートを提供するプロトコル

  • OCaml Platform:
    OCamlプログラミングのために、OCaml言語のサポートを強化するVS Code拡張機能

  • Code Runner:
    任意の言語のコードスニペットやファイルを簡単に実行できるVS Code拡張機能

参考資料

Webサイト

GitHubで編集を提案

Discussion