Custom queries in the VS Code extension

The GitLab Workflow extension adds a sidebar to VS Code. This sidebar displays default search queries for each of your projects:

• Issues assigned to me
• Issues created by me
• Merge requests assigned to me
• Merge requests created by me
• Merge requests I’m reviewing

In addition to the default queries, you can create custom queries.

View search query results in VS Code

Prerequisites:

• You’re a member of a GitLab project.
• You’ve installed the extension.
• You’ve signed in to your GitLab instance, as described in Setup.

To see search results from your project:

1. On the left vertical menu bar, select GitLab Workflow ( ) to display the extension sidebar.
2. On the sidebar, expand Issues and merge requests.
3. Select a project to view its queries, then select the query you want to run.
4. Below the query title, select the search result you want to see.
5. If your search result is a merge request, select what you want to view in VS Code:
   • Overview: the description, status, and any comments on this merge request.
   • The filenames of all files changed in this merge request. Select a file to view a diff of its changes.
6. If your search result is an issue, select it to view its description, history, and comments in VS Code.

Create a custom query

Any custom queries you define override the default queries shown in the VS Code sidebar, under Issues and Merge requests.

To override the extension’s default queries and replace them with your own:

1. In VS Code, on the top bar, go to Code > Preferences > Settings.

2. In the upper-right corner, select Open Settings (JSON) to edit your settings.json file.

3. In the file, define gitlab.customQueries, like in this example. Each query should be an entry in the gitlab.customQueries JSON array:

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

4. Optional. When you customize gitlab.customQueries, your definition overrides all default queries. To restore any of the default queries, copy them from the default array in the extension’s desktop.package.json file.

5. Save your changes.

Supported parameters for all queries

Not all item types support all parameters. These parameters apply to all query types:

Supported parameters for issue, epic, and merge request queries

All of these parameters are optional.

Supported parameters for vulnerability report queries

Vulnerability reports don’t share any common query parameters with other entry types. Each parameter listed in this table works with vulnerability reports only, and all parameters are optional: