差分

このページの2つのバージョン間の差分を表示します。

この比較画面へのリンク

両方とも前のリビジョン前のリビジョン
次のリビジョン
前のリビジョン
odin:setup-vscode [2025/05/20 11:04] freemikanodin:setup-vscode [2025/06/13 10:01] (現在) – [VSCodeの設定] Correct link freemikan
行 1: 行 1:
 ====== VSCodeの設定 ====== ====== VSCodeの設定 ======
 +[[odin:|{{:odin:odin_logo.svg?200|Odin}}]]
  
 テキストエディタはVSCodeを使うのが一番簡単です。Odinのエクステンションをインストールするだけでシンタックスハイライトが有効になります。エクステンションにはいくつか候補があります。ここでは、エクステンションの一覧に[[https://marketplace.visualstudio.com/items?itemName=DanielGavin.ols|Odin Language]]という名前で提供されているものを使用することにします。 テキストエディタはVSCodeを使うのが一番簡単です。Odinのエクステンションをインストールするだけでシンタックスハイライトが有効になります。エクステンションにはいくつか候補があります。ここでは、エクステンションの一覧に[[https://marketplace.visualstudio.com/items?itemName=DanielGavin.ols|Odin Language]]という名前で提供されているものを使用することにします。
行 7: 行 8:
 {{:odin:vscode-odin-extension-install.png?600|VSCode Odin Language Extention}} {{:odin:vscode-odin-extension-install.png?600|VSCode Odin Language Extention}}
  
-インストールが完了したら、''Ctrl+Shift+P'' → ''Developer: Reaload Window''などでリロードしておきます。これで拡張子が''.odin''のファイルを開いたときにシンタックスハイライトが有効になります。+インストールが完了したら、''Ctrl+Shift+P'' → Developer: Reaload Windowなどでリロードしておきます。これで拡張子が.odinのファイルを開いたときにシンタックスハイライトが有効になります。
  
 ===== インデントの設定 ===== ===== インデントの設定 =====
行 13: 行 14:
 Odinはインデントにタブ文字を使用するのが好まれます。VSCodeのデフォルトはスペース文字を使用するようになっているので、Odinのソースファイルの編集でのみタブ文字を使うように変更しておきます。 Odinはインデントにタブ文字を使用するのが好まれます。VSCodeのデフォルトはスペース文字を使用するようになっているので、Odinのソースファイルの編集でのみタブ文字を使うように変更しておきます。
  
-VSCodeの設定ファイルである''settings.json''を開きます。''settings.json''を開くには、''Ctrl+,''//Settings//を表示して、右上にある//Open Settings (JSON)//のアイコンをクリックします。+VSCodeの設定ファイルであるsettings.jsonを開きます。 
 +settings.jsonを開くには、''Ctrl+,''でSettingsを表示して、右上にあるOpen Settings (JSON)のアイコンをクリックします。
  
 {{:odin:vscode-open-settings-json.png?400|VSCode Open Settings (JSON)}} {{:odin:vscode-open-settings-json.png?400|VSCode Open Settings (JSON)}}
  
-''settings.json''、次の''"[odin]"''の項目を追加します。+settings.jsonに''"[odin]"''の項目を追加します。
  
 <file json> <file json>
行 31: 行 33:
 </file> </file>
  
-JSONのルールとして、最後の項目であれば'',''をつけこと、中間の項目であれば'',''をつなければならないことに注意してください。変更ができたら''settings.json''を保存します+JSONのルールとして、最後の項目'',''をつけてはいけないことに注意してください。
  
-今度はプロジェクトのフォルダの中に、拡張子''.odin''のファイルを新規作成します。このファイルTABキーをタイプしとき、スペース文字ではなく、タブ文字が一つだけ挿入されるようになっていること確認します。+変更がでらsettings.json保存します。
  
-VSCodeの設定にもよりますが、既存の''.odin''ファイルを開いたとき、そのファイルがすでにスペース文字でインデントされている場合、それが尊重されてスペース文字でのインデントになることに注意してください。この場合、一度インデントをすべて削除してから、ファイルを開き直すなどしてからインデントし直す必要があります。+今度はプロジェクトのフォルダの中に、拡張子が「.odin」のファイルを新規作成します。 
 +このファイルでTABキーをタイプしたとき、スペース文字ではなく、タブ文字が一つだけ挿入されるようになっていることを確認します。 
 + 
 +VSCodeの設定にもよりますが、既存の.odinファイルを開いたとき、そのファイルがすでにスペース文字でインデントされている場合、それが尊重されてスペース文字でのインデントになることに注意してください。 
 +この場合、一度インデントをすべて削除してから、ファイルを開き直すなどしてからインデントし直す必要があります。
  
 ===== olsを使えるようにする ===== ===== olsを使えるようにする =====
行 49: 行 55:
 </cli> </cli>
  
-問題がなければ''ols''という実行ファイルが生成されているので、それを適当な場所にコピーしておきます。+問題がなければolsという実行可能ファイルが生成されているので、それを適当な場所にコピーしておきます。
  
 <cli> <cli>
行 55: 行 61:
 </cli> </cli>
  
-VSCodeの''settings.json''に、''ols.server.path''という名前の項目を追加します。値は''ols''のフルパスにします。+VSCodeのsettings.jsonに、''ols.server.path''という名前の項目を追加します。値はolsを配置した場所のフルパスにします。
  
 <file json> <file json>
行 65: 行 71:
 </file> </file>
  
-VSCodeを再起動して、Odinのソースコードを含むフォルダ開くと「olsの設定ファイルがないので作成しますか?」という旨のポップアップが表示されます。ここで「はい」を選択すると、プロジェクトのフォルダに''ols.json''というファイルが作成されます。このファイルがなければolsは動作しないので作成しておきます。+VSCodeを再起動して、Odinのソースコードを含むフォルダ開くと「olsの設定ファイルがないので作成しますか?」という旨のポップアップが表示されます。ここで「はい」を選択すると、プロジェクトのフォルダにols.jsonというファイルが作成されます。このファイルがなければolsは動作しないので作成しておきます。
  
 {{:odin:vscode-odin-ols-json.png?400|VSCode ols create ols.json}} {{:odin:vscode-odin-ols-json.png?400|VSCode ols create ols.json}}
  
-作成される''ols.json''の内容は次のようになっています。+作成されるols.jsonの内容は次のようになっています。
  
 <file json> <file json>
行 82: 行 88:
 手作業でこの内容のファイルを作成しても問題ありません。これらはolsの動作を調整するもので、他にもいくつかオプションがあります。必要であれば[[https://github.com/DanielGavin/ols?tab=readme-ov-file#Configuration|ドキュメント]]を参照してください。 手作業でこの内容のファイルを作成しても問題ありません。これらはolsの動作を調整するもので、他にもいくつかオプションがあります。必要であれば[[https://github.com/DanielGavin/ols?tab=readme-ov-file#Configuration|ドキュメント]]を参照してください。
  
-この状態で拡張子が''.odin''であるOdinのソースコードを開くと、コード補完、シンボルの定義位置へのジャンプ、ソースコードのフォーマット (Ctrl+Shift+I)などが使えるようになっています。+この状態で拡張子が.odinであるOdinのソースコードを開くと、コード補完、シンボルの定義位置へのジャンプ、ソースコードのフォーマット(''Ctrl+Shift+I'')などが使えるようになっています。
  
-もし環境変数''ODIN_ROOT''が設定されていないと、//core////vendor//といったOdinに付属するライブラリを認識しませんので、設定しておきます。Bashを使用しているのであれば、''.bashrc''などシェルの初期化ファイルに次の1行を追加します。+もし環境変数ODIN_ROOTが設定されていないと、coreやvendorといったOdinに付属するライブラリを認識しませんので、設定しておきます。Bashを使用しているのであれば、.bashrcなどシェルの初期化ファイルに次の1行を追加します。
  
 <file bash> <file bash>
文書の先頭へ