コード提案をセットアップする
複数の異なるIDEでGitLab Duoコード提案を使用できます。
コード提案を設定するには、IDEの手順に従ってください。
前提条件
コード提案を使用するには、以下を行う必要があります:
- GitLab Duo Coreをお持ちの場合は、IDE機能をオンにする。
- コード提案が目的の言語をサポートしていることを確認する。IDEによってサポートされる言語が異なります。
エディタ拡張機能を設定する
コード提案はエディタ拡張機能の一部です。コード提案を使用するには、以下の手順に従います:
- IDEに拡張機能をインストールします。
- IDEからGitLabに対して認証します。OAuthまたはパーソナルアクセストークンを使用できます。
- 拡張機能を設定します。
お使いのIDEに合わせて次の手順を実行してください:
- Visual Studio Code
- Visual Studio
- JetBrains IDE用GitLab Duoプラグイン
gitlab.vimNeovim用プラグイン- GitLab for Eclipse
コード提案をオンにする
コード提案は、前提条件を満たしている場合にオンになります。IDEを開き、コード提案が機能するかどうかを確認してください。
VS Code
VS Codeでコード提案がオンになっていることを確認するには、次の手順に従います:
- VS Codeで、設定エディタを開きます:
- macOSでは、Command+,を押してください。
- WindowsまたはLinuxでは、Control+,を押してください。
- Extensions > GitLab > GitLab Duoを選択します。
- GitLab › GitLab Duoコード提案: の下のチェックボックスがオンになっていることを確認します: Enabledが選択されていることを確認します。
- オプション。GitLab › Duo Code Suggestions: Enabled Supported Languagesで、コードの提案または生成の対象とする言語を選択します。
- オプション。GitLab › Duo Code Suggestions: Additional Languagesで、使用するその他の言語を追加します。
Visual Studio
Visual Studioでコード提案がオンになっていることを確認するには、次の手順に従います:
- Visual Studioで、下部のステータスバーでGitLabアイコンをポイントします。
- アイコンのツールチップを確認し、機能が有効になっていることを確認します。
- コード提案が有効になっていない場合、トップバーでExtensions > GitLab > Toggle Code Suggestionsを選択して有効にします。
JetBrains IDE
JetBrains IDEでコード提案がオンになっていることを確認するには、次の手順に従います:
- お使いのIDEで、トップバーにあるIDEの名前を選択し、次に設定を選択します。
- 左サイドバーでツールを展開し、GitLab Duoを選択します。
- Featuresセクションで、Enable Code SuggestionsとEnable GitLab Duo Chatが選択されていることを確認します。
- OKまたはSaveを選択します。
コード提案のカスタム証明書を追加する
GitLab Duoは、ユーザーが設定しなくても信頼できるルート証明書を検出しようとします。必要に応じて、GitLabインスタンスに接続するときに、GitLab DuoプラグインがカスタムSSL証明書を使用できるように、JetBrains IDEを設定します。
カスタムSSL証明書をGitLab Duoで使用するには、次の手順に従います:
- お使いのIDEで、トップバーにあるIDEの名前を選択し、次に設定を選択します。
- 左サイドバーでツールを展開し、GitLab Duoを選択します。
- Connectionで、URL to GitLab instanceを入力します。
- 接続を検証するには、Verify setupを選択します。
- OKまたはSaveを選択します。
IDEが信頼されていないSSL証明書を検出した場合:
- GitLab Duoプラグインに確認ダイアログが表示されます。
- 表示されているSSL証明書の詳細を確認します。
- その証明書の詳細が、ブラウザでGitLabに接続するときに表示される証明書と一致することを確認します。
- 証明書が想定どおりの場合は、Acceptを選択します。
すでに承認した証明書を確認するには、次の手順に従います:
- お使いのIDEで、トップバーにあるIDEの名前を選択し、次に設定を選択します。
- 左サイドバーでツール > Server Certificatesを選択します。
- Server Certificatesを選択します。
- 証明書を選択して表示します。
Eclipse
GitLab Duoコード提案を有効にするには、Eclipseプロジェクトを開きます。単一のファイルを開くと、すべてのファイルタイプでコード提案が無効になります。
Eclipseでコード提案がオンになっていることを確認するには、次の手順に従います:
- Eclipseで、GitLabプロジェクトを開きます。
- Eclipseの下部ツールバーで、GitLabアイコンを選択します。
Code Suggestionsに「Enabled」と表示されます。
Neovim
コード提案は、組み込みのControl+x、Control+oによるオムニ補完キーマッピングをサポートするため、LSP(Language Server Protocol)サーバーを提供します:
| モード | キーマッピング | 種類 | 説明 |
|---|---|---|---|
INSERT | Control+x、Control+o | ビルトイン | 言語サーバーを介してGitLab Duoコード提案からの補完をリクエストします。 |
NORMAL | <Plug>(GitLabToggleCodeSuggestions) | <Plug> | 現在のバッファに対してコード提案のオン/オフを切り替えます。設定が必要です。 |
コード提案がオンになっていることを確認する
Neovimを除く、GitLabのすべてのエディタ拡張機能は、IDEのステータスバーにアイコンを追加します。たとえば、Visual Studioでは次のようになります:
| アイコン | ステータス | 意味 |
|---|---|---|
| Ready | GitLab Duoを設定して有効にしており、コード提案をサポートする言語を使用しています。 | |
| Not configured | パーソナルアクセストークンを入力していないか、コード提案がサポートしていない言語を使用しています。 | |
| Loading suggestion | GitLab Duoがコード提案をフェッチしています。 | |
| Error | GitLab Duoでエラーが発生しました。 |
コード提案をオフにする
コード提案をオフにするプロセスは、IDEごとに異なります。
コード生成とコード補完を個別にオフにすることはできません。
VS Code
VS Codeでコード提案をオフにするには、次の手順に従います:
- VS Codeで、設定エディタを開きます:
- macOSでは、Command+,を押してください。
- WindowsまたはLinuxでは、Control+,を押してください。
- Extensions > GitLab > GitLab Duoを選択します。
- GitLab › Duo Code Suggestions: Enabledのチェックボックスをオフにします。
代わりに、VS Codeのsettings.jsonファイルでgitlab.duoCodeSuggestions.enabledをfalseに設定することもできます。
Visual Studio
拡張機能をアンインストールせずにコード提案をオンまたはオフにするには、GitLab.ToggleCodeSuggestionsカスタムコマンドにキーボードショートカットを割り当てます。
拡張機能を無効にするかアンインストールするには、拡張機能のアンインストールまたは無効化に関するMicrosoft Visual Studioドキュメントを参照してください。
JetBrains IDE
コード提案を含むGitLab Duoを無効にするプロセスは、使用するJetBrains IDEに関係なく同じです。
- JetBrains IDEで、設定に移動し、プラグインメニューを選択します。
- インストールされているプラグインの中からGitLab Duoプラグインを見つけます。
- プラグインを無効にします。
詳細については、JetBrains製品ドキュメントを参照してください。
Eclipse
プロジェクトのEclipseコード提案を無効にするには、次の手順に従います:
- Eclipseの下部ツールバーで、GitLabアイコンを選択します。
- Disable Code Suggestionsを選択して、現在のプロジェクトのコード提案を無効にします。
特定の言語のEclipseコード提案を無効にするには、次の手順に従います:
- Eclipseの下部ツールバーで、GitLabアイコンを選択します。
- Show Settingsを選択します。
- Code Suggestions Enabled Languagesセクションまでスクロールし、無効にする言語のチェックボックスをオフにします。
Neovim
Neovim
defaults.lua設定ファイルに移動します。code_suggestionsで、enabled =フラグをfalseに変更します:code_suggestions = { ... enabled = false,
GitLab Duoをオフにする
または、グループ、プロジェクト、またはインスタンス単位でGitLab Duo(コード提案を含む)を完全に無効にすることもできます。