この記事では、サーバ側開発においてコード補完を使う方法を説明します。
前提
Diarkis のサーバ側開発を始めるにあたり、プロジェクトテンプレートからプロジェクトが展開されている状態から解説します。
プロジェクトテンプレートを用いたプロジェクト展開については「Diarkis Server Template の紹介」「Diarkis Server Template のディレクトリ」を参照してください。
コード補完のためのコードリファレンスを取得・展開する
下記URLから、利用したい Diarkis バージョンと同じ名前のアーカイブを取得してください。
https://docs.diarkis.io/sdk/server_coderef/current.tar.gz
過去のバージョンを利用する場合は、current.tar.gz を v0.2.24.tar.gz などバージョン名を指定してください。
取得後に任意の場所に展開してください。
プロジェクトからコードリファレンスを参照する
プロジェクトディレクトリに展開されている go.mod に以下の記述を追加することで、各エディタのコード補完機能からコードリファレンスを参照することができるようになります。
replace github.com/Diarkis/diarkis => /path/to/downloaed/coderef
参照先の Path はコードリファレンスの展開先を指定してください。
replace とは
import で指定されたモジュールの内容(参照先)を置き換えるディレクティブで、これを用いることで Diarkis のコードリファレンスを用いてコード補完機能を有効にすることができるようになります。
詳しくは以下のURLを参照してください。
https://go.dev/ref/mod#go-mod-file-replace
補足
go.mod に追加した replace の記述は、diarkis-cli によるビルド時には無視されるため、ビルドに先立って replace の記述を削除する必要はありません。