OCaml: OCaml用にVisual Studio Codeをセットアップする
はじめに
Visual Studio Code
(以下、VS Code
)は多言語をサポートする強力なエディタです。
OCaml
用の拡張機能も提供されています。
この記事では、VS Code
でのOCaml
開発環境の構築方法を紹介します。
OCaml
パッケージのインストール
1.
LSP
サーバのインストール
1.1 VS Code
のOCaml Platform
拡張機能は、LSP
(Language Server Protocol
)を使用しています。
OCaml
のLSP
サーバパッケージをインストールし、動作を確認します。
次のコマンドで、OCaml
用LSP
をインストールします:
opam install --yes ocaml-lsp-server
注意:
関連パッケージを自動的にインストールするため、--yes
オプションを追加しています。
LSP
の動作確認は、ocamllsp
を実行してエラーメッセージが出力されることを確認します。
次の手順で、LSP
を動作確認します:
-
LSP
サーバの起動:
次のコマンドでLSP
サーバを起動するocamllsp
-
エラーメッセージの確認:
[Enter]キーを押して、LSP
サーバからエラーメッセージを出力されるかを確認する
注意:
これは、LSP
サーバが正常に動作していることを確認するため# [Enter]を押す /----------------------------------------------------------------------- | Internal error: Uncaught exception. | Error: content length absent
上記のようなエラーメッセージが出力される
-
LSP
サーバの停止:
[Ctrl+C
]を入力し、LSP
を中止する^C # [Ctrl+C]を押して、中止する >
上記のようにエラーメッセージが出力されれば、LSP
は正常にインストールされています。
1.2 コード整形ツールのインストール
OCaml
のコードを整形するツールocamlformat
をインストールし、動作を確認します。
次のコマンドで、コード整形ツールをインストールします:
opam install --yes ocamlformat
次の手順で、コード整形ツールの動作を確認します:
-
フォーマッタ用に
.ocamlformat
を作成する:touch .ocamlformat
-
コード整形用にプログラムを作成する:
hello.ml(* my first OCaml program *) print_endline "Hello, OCaml!!"
-
上記の
OCaml
プログラムをフォーマッタで整形する:ocamlformat hello.ml (* my first OCaml program *) print_endline "Hello, OCaml!!"
注意:
Warning
エラーが出る場合は、--enable-outside-detected-project
を追加する
上記のように整形されたプログラムが出力されれば、フォーマッタの正常にインストールされています。
2. 拡張機能のインストール
OCaml Platform
のインストール
2.1 OCaml Platform
はLSP
を利用して、コーディング時にタブ補完やエラーチェックを行います。
次の手順で、OCaml Platform
をインストールします:
-
VS Code
を起動する:code .
-
[拡張機能ビュー]を表示する:
[Ctrl+Shift+X
]を入力し、[拡張機能ビュー]を表示する。 -
[
OCaml Platform
]を検索する:
上部の検索バーにocaml
と入力し、[OCaml Platform
]を検索する。 -
[
OCaml Platform
]をインストールする:
[インストール]をクリックし、[OCaml Platform
]をインストールする。
Code Runner
のインストール
2.2 Code Runner
は、編集中のプログラムを簡単に実行できる拡張機能です。
編集するプログラミング言語にあわせて、適当なコマンドを実行します。
次の手順で、[Code Runner
]をインストールします。
-
VS Code
を起動する:code .
-
[拡張機能ビュー]を表示する:
[Ctrl+Shift+X
]を入力し、[拡張機能ビュー]を表示する。 -
[
Code Runner
]を検索する:
上部の検索バーにcode
と入力し、[Code Runner
]を検索する。 -
[
Code Runner
]をインストールする:
[インストール]をクリックし、[Code Runner
]をインストールする。
Code Runner
の設定
2.3 [Code Runner
]を使用するため、設定ファイルにOCaml
用の設定を追加します。
次の手順で、OCaml
用の設定を追加します。
-
VS Code
を起動する:code .
-
設定ファイルを開く:
[Ctrl+Shift+P
]として、[Open User Settings (JSON)
]を選び、設定ファイル(settings.json
)を開く。 -
OCaml
設定を追加する:
設定ファイル (settings.json
)に次の行を追加する。
これにより、OCaml
でのプログラム実行時に適切なコマンドが使用される。
code-runner.executorMap": {
"ocaml": "cd $dir && ocaml $fileName"
}
注意:
OCaml
以外の言語で環境構築する場合は、executorMap
セクション内にほかの言語の設定を追加します。
以上で、Run Code
でプログラムが実行できます。
おわりに
この記事では、VS Code
にOCaml
の拡張機能を追加する方法を説明しました。
このように拡張機能を使用することで、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サイト
-
opam
:
OCaml
用パッケージマネージャー -
ocaml-lsp
:
OCaml
用LSP
サーバ -
ocamlformat
:
OCaml
用コード整形ツール -
OCaml Platform
:
OCaml
用VS Code
拡張機能 -
Code Runner
コード実行VS Code
拡張機能
Discussion