正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

VS Code拡張機能のカスタムクエリ

GitLabワークフロー拡張機能は、サイドバーをVS Codeに追加します。このサイドバーには、プロジェクトごとのデフォルトの検索クエリが表示されます:

  • Issues assigned to me（自分に割り当てられたイシュー）
  • Issues created by me（自分が作成したイシュー）
  • Merge requests assigned to me（自分に割り当てられたマージリクエスト）
  • Merge requests created by me（自分が作成したマージリクエスト）
  • Merge requests I’m reviewing（自分がレビュー中のマージリクエスト）

デフォルトのクエリに加えて、カスタムクエリを作成できます。

VS Codeで検索クエリの結果を表示する

前提要件:

プロジェクトの検索結果を表示するには:

  1. 左側の垂直メニューバーでGitLab Workflow（ tanuki ）を選択して、拡張機能サイドバーを表示します。
  2. サイドバーでイシューとマージリクエストを展開します。
  3. プロジェクトを選択してクエリを表示し、実行するクエリを選択します。
  4. クエリタイトルの下で、表示したい検索結果を選択します。
  5. 検索結果がマージリクエストの場合、VS Codeで表示するものを選択します:
    • 概要: マージリクエストの説明、ステータス、およびコメント。
    • このマージリクエストで変更されたすべてのファイル名。ファイルを選択して、変更の差分を表示します。
  6. 検索結果がイシューの場合、それを選択して、VS Codeでその説明、履歴、コメントを表示します。

カスタムクエリを作成

定義したカスタムクエリはすべて、VS CodeサイドバーのIssues and Merge requests（イシューとマージリクエスト）に表示されるデフォルトのクエリをオーバーライドします。

拡張機能のデフォルトのクエリをオーバーライドして独自のクエリに置き換えるには:

  1. VS Codeの上部バーで、コード > 設定 > 設定に移動します。

  2. 右上隅で、Open Settings (JSON)（設定を開く（JSON））を選択して、settings.jsonファイルを編集します。

  3. ファイル内で、この例のようにgitlab.customQueriesを定義します。各クエリは、gitlab.customQueries JSON配列内のエントリである必要があります:

    {
  "gitlab.customQueries": [
    {
      "name": "Issues assigned to me",
      "type": "issues",
      "scope": "assigned_to_me",
      "noItemText": "No issues assigned to you.",
      "state": "opened"
    }
  ]
}

  4. オプション。gitlab.customQueriesをカスタマイズすると、定義はすべてのデフォルトのクエリをオーバーライドします。デフォルトのクエリを復元するには、拡張機能のdefault配列からコピーしますdesktop.package.jsonファイル。

  5. 変更を保存します。

すべてのクエリでサポートされるパラメータ

すべてのアイテムタイプがすべてのパラメータをサポートしているわけではありません。これらのパラメータは、すべてのクエリタイプに適用されます:

パラメータ必須デフォルト定義
namecheck-circle 対応該当なしGitLabパネルに表示するラベル。
noItemTextdotted-circle 対象外No items found.クエリがアイテムを返さない場合に表示するテキスト。
typedotted-circle 対象外merge_requests返すアイテムタイプ。使用可能な値: issues、merge_requests、epics、snippets、vulnerabilities。スニペットは、他のフィルターをサポートしていません。エピックは、GitLabプレミアムおよびUltimateプランでのみ使用できます。

イシュー、エピック、マージリクエストのクエリでサポートされるパラメータ

パラメータ必須デフォルト定義
assigneedotted-circle 対象外該当なし指定されたユーザー名に割り当てられたアイテムを返します。Noneは、割り当てられていないGitLabアイテムを返します。Anyは、アサイン先を持つGitLabアイテムを返します。エピックおよび脆弱性では使用できません。
authordotted-circle 対象外該当なし指定されたユーザー名で作成されたアイテムを返します。
confidentialdotted-circle 対象外該当なし非公開イシューまたは公開イシューをフィルタリングします。イシューでのみ利用可能です。
createdAfterdotted-circle 対象外該当なし指定された日付より後に作成されたアイテムを返します。
createdBeforedotted-circle 対象外該当なし指定された日付より前に作成されたアイテムを返します。
draftdotted-circle 対象外noyesはドラフト状態のマージリクエストのみを返し、noはドラフト状態ではないマージリクエストのみを返します。マージリクエストでのみ使用できます。
excludeAssigneedotted-circle 対象外該当なし指定されたユーザー名に割り当てられていないアイテムを返します。イシューでのみ利用可能です。現在のユーザーの場合は、<current_user>に設定します。
excludeAuthordotted-circle 対象外該当なし指定されたユーザー名で作成されなかったアイテムを返します。イシューでのみ利用可能です。現在のユーザーの場合は、<current_user>に設定します。
excludeLabelsdotted-circle 対象外[]ラベル名の配列。イシューでのみ利用可能です。返されたアイテムには、配列内のラベルがありません。定義済みの名前では大文字と小文字が区別されません。
excludeMilestonedotted-circle 対象外該当なし除外するマイルストーンのタイトル。イシューでのみ利用可能です。
excludeSearchdotted-circle 対象外該当なしタイトルまたは説明に検索キーがないGitLabアイテムを検索します。イシューでのみ動作します。
labelsdotted-circle 対象外[]ラベル名の配列。返されたアイテムには、配列内のすべてのラベルがあります。Noneはラベルのないアイテムを返し、Anyは少なくとも1つのラベルを持つアイテムを返します。定義済みの名前では大文字と小文字が区別されません。
maxResultsdotted-circle 対象外20表示する結果の数。
milestonedotted-circle 対象外該当なしマイルストーンのタイトル。Noneはマイルストーンのないすべてのアイテムをリストし、Anyは割り当てられたマイルストーンを持つすべてのアイテムをリストします。エピックおよび脆弱性では使用できません。
orderBydotted-circle 対象外created_at選択した値で順序付けられたエンティティを返します。使用可能な値: created_at、updated_at、priority、due_date、relative_position、label_priority、milestone_due、popularity、weight。一部の値はイシューに固有で、一部の値はマージリクエストに固有です。詳細については、マージリクエストを参照してください。
reviewerdotted-circle 対象外該当なしこのユーザー名にレビューを割り当てられたマージリクエストを返します。現在のユーザーの場合は、<current_user>に設定します。Noneは、レビュアーのいないアイテムを返し、Anyはレビュアーのいるアイテムを返します。
scopedotted-circle 対象外all指定されたスコープのGitLabアイテムを返します。エピックには適用されません。使用可能な値: assigned_to_me、created_by_me、all。
searchdotted-circle 対象外該当なしタイトルと説明に対してGitLabアイテムを検索します。
searchIndotted-circle 対象外allexcludeSearch検索属性のスコープを変更します。使用可能な値: all、title、description。イシューでのみ動作します。
sortdotted-circle 対象外desc昇順または降順でソートされたイシューを返します。使用可能な値: asc、desc。
statedotted-circle 対象外openedすべてのイシュー、または特定の状態に一致するイシューのみを返します。使用可能な値: all、opened、closed。
updatedAfterdotted-circle 対象外該当なし指定された日付より後に更新されたアイテムを返します。
updatedBeforedotted-circle 対象外該当なし指定された日付より前に更新されたアイテムを返します。

脆弱性レポートのクエリでサポートされるパラメータ

脆弱性レポートは、他のエントリタイプと共通のクエリパラメータを共有していません。この表にリストされている各パラメータは、脆弱性レポートでのみ動作します:

パラメータ必須デフォルト定義
confidenceLevelsdotted-circle 対象外all指定された信頼水準に属する脆弱性を返します。使用できる値は、undefined、ignore、unknown、experimental、low、medium、high、confirmedです。
reportTypesdotted-circle 対象外該当なし指定されたレポートタイプに属する脆弱性を返します。使用可能な値: sast、dast、dependency_scanning、container_scanning。
scopedotted-circle 対象外dismissed指定されたスコープの脆弱性の検出結果を返します。使用可能な値: all、dismissed。詳細については、脆弱性の検出結果APIを参照してください。
severityLevelsdotted-circle 対象外all指定された重大度レベルに属する脆弱性を返します。使用可能な値: undefined、info、unknown、low、medium、high、critical。