Help us learn about your current experience with the documentation. Take the survey.

VS Code 扩展中的自定义查询

GitLab Workflow 扩展为 VS Code 添加了一个侧边栏。 此侧边栏显示每个项目的默认搜索查询：

  • 分配给我的问题
  • 我创建的问题
  • 分配给我的合并请求
  • 我创建的合并请求
  • 我正在审查的合并请求

除了默认查询外，你还可以创建自定义查询。

在 VS Code 中查看搜索查询结果

前置条件：

  • 你是 GitLab 项目的成员。
  • 你已经安装了扩展。
  • 你已经按照设置中的描述登录到你的 GitLab 实例。

要查看项目的搜索结果：

  1. 在左侧垂直菜单栏中，选择 GitLab Workflow ( tanuki ) 以显示扩展侧边栏。
  2. 在侧边栏中，展开 问题和合并请求。
  3. 选择一个项目以查看其查询，然后选择你要运行的查询。
  4. 在查询标题下方，选择你想要查看的搜索结果。
  5. 如果你的搜索结果是合并请求，选择你在 VS Code 中想要查看的内容：
    • 概述：此合并请求的描述、状态和任何评论。
    • 此合并请求中所有已更改文件的文件名。选择一个文件以查看其更改的差异。
  6. 如果你的搜索结果是问题，选择它以在 VS Code 中查看其描述、历史和评论。

创建自定义查询

你定义的任何自定义查询都会覆盖 VS Code 侧边栏 中 显示的默认查询，在 问题和合并请求 下。

要覆盖扩展的默认查询并用你自己的查询替换它们：

  1. 在 VS Code 中，在顶部栏中，转到 代码 > 首选项 > 设置。

  2. 在右上角，选择 打开设置 (JSON) 以编辑你的 settings.json 文件。

  3. 在文件中，定义 gitlab.customQueries，如本例所示。每个查询都应该是 gitlab.customQueries JSON 数组中的一个条目：

    {
  "gitlab.customQueries": [
    {
      "name": "分配给我的问题",
      "type": "issues",
      "scope": "assigned_to_me",
      "noItemText": "没有分配给你的问题。",
      "state": "opened"
    }
  ]
}

  4. 可选。当你自定义 gitlab.customQueries 时，你的定义会覆盖所有默认查询。 要恢复任何默认查询，请从扩展的 desktop.package.json 文件 中的 default 数组复制它们。

  5. 保存你的更改。

所有查询支持的参数

并非所有项目类型都支持所有参数。这些参数适用于所有查询类型：

参数 必需 默认值 定义
name check-circle 是 不适用 在 GitLab 面板中显示的标签。
noItemText dotted-circle 否 未找到项目。 如果查询未返回任何项目时要显示的文本。
type dotted-circle 否 merge_requests 要返回的项目类型。可能的值：issues、merge_requests、epics、snippets、vulnerabilities。代码片段不支持任何其他过滤器。史诗仅在 GitLab Premium 和 Ultimate 上可用。

问题、史诗和合并请求查询支持的参数

参数 必需 默认值 定义
assignee dotted-circle 否 不适用 返回分配给给定用户名的项目。None 返回未分配的 GitLab 项目。Any 返回有分配者的 GitLab 项目。不适用于史诗和漏洞。
author dotted-circle 否 不适用 返回由给定用户名创建的项目。
confidential dotted-circle 否 不适用 过滤机密或公开的问题。仅适用于问题。
createdAfter dotted-circle 否 不适用 返回在给定日期之后创建的项目。
createdBefore dotted-circle 否 不适用 返回在给定日期之前创建的项目。
draft dotted-circle 否 no 根据草稿状态过滤合并请求：yes 仅返回处于草稿状态的合并请求，no 仅返回不处于草稿状态的合并请求。仅适用于合并请求。
excludeAssignee dotted-circle 否 不适用 返回未分配给给定用户名的项目。仅适用于问题。对于当前用户，设置为 <current_user>。
excludeAuthor dotted-circle 否 不适用 返回不由给定用户名创建的项目。仅适用于问题。对于当前用户，设置为 <current_user>。
excludeLabels dotted-circle 否 [] 标签名称数组。仅适用于问题。返回的项目不包含数组中的任何标签。预定义名称不区分大小写。
excludeMilestone dotted-circle 否 不适用 要排除的里程碑标题。仅适用于问题。
excludeSearch dotted-circle 否 不适用 搜索标题或描述中没有搜索键的 GitLab 项目。仅适用于问题。
labels dotted-circle 否 [] 标签名称数组。返回的项目包含数组中的所有标签。None 返回没有标签的项目。Any 返回至少有一个标签的项目。预定义名称不区分大小写。
maxResults dotted-circle 否 20 要显示的结果数量。
milestone dotted-circle 否 不适用 里程碑标题。None 列出没有里程碑的所有项目。Any 列出有分配里程碑的所有项目。不适用于史诗和漏洞。
orderBy dotted-circle 否 created_at 按选定值返回排序后的实体。可能的值：created_at、updated_at、priority、due_date、relative_position、label_priority、milestone_due、popularity、weight。某些值特定于问题，某些特定于合并请求。有关更多信息，请参阅列出合并请求。
reviewer dotted-circle 否 不适用 返回分配给此用户名进行审查的合并请求。对于当前用户，设置为 <current_user>。None 返回没有审查者的项目。Any 返回有审查者的项目。
scope dotted-circle 否 all 返回给定范围的 GitLab 项目。不适用于史诗。可能的值：assigned_to_me、created_by_me、all。
search dotted-circle 否 不适用 根据标题和描述搜索 GitLab 项目。
searchIn dotted-circle 否 all 更改 excludeSearch 搜索属性的范围。可能的值：all、title、description。仅适用于问题。
sort dotted-circle 否 desc 返回按升序或降序排序的问题。可能的值：asc、desc。
state dotted-circle 否 opened 返回所有问题，或仅返回匹配特定状态的问题。可能的值：all、opened、closed。
updatedAfter dotted-circle 否 不适用 返回在给定日期之后更新的项目。
updatedBefore dotted-circle 否 不适用 返回在给定日期之前更新的项目。

漏洞报告查询支持的参数

漏洞报告不与其他条目类型共享 任何通用查询参数。 此表中列出的每个参数仅适用于漏洞报告：

参数 必需 默认值 定义
confidenceLevels dotted-circle 否 all 返回属于指定置信级别的漏洞。可能的值：undefined、ignore、unknown、experimental、low、medium、high、confirmed。
reportTypes dotted-circle 否 不适用 返回属于指定报告类型的漏洞。可能的值：sast、dast、dependency_scanning、container_scanning。
scope dotted-circle 否 dismissed 返回给定范围的漏洞发现。可能的值：all、dismissed。有关更多信息，请参阅漏洞发现 API。
severityLevels dotted-circle 否 all 返回属于指定严重性级别的漏洞。可能的值：undefined、info、unknown、low、medium、high、critical。