Help us learn about your current experience with the documentation.
Take the survey.
Custom queries in the VS Code extensionThe GitLab Workflow extension adds a sidebar to VS Code. This sidebar displays default search queries for each of your projects:
In addition to the default queries, you can create custom queries.
View search query results in VS CodePrerequisites:
To see search results from your project:
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:
In VS Code, on the top bar, go to Code > Preferences > Settings.
On the top right corner, select Open Settings (JSON) to edit your settings.json
file.
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"
}
]
}
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.
Save your changes.
Not all item types support all parameters. These parameters apply to all query types:
Parameter Required Default Definitionname
check-circle Yes not applicable The label to show in the GitLab panel. noItemText
dotted-circle No No items found.
The text to show if the query returns no items. type
dotted-circle No merge_requests
Which item types to return. Possible values: issues
, merge_requests
, epics
, snippets
, vulnerabilities
. Snippets don’t support any other filters. Epics are available only on GitLab Premium and Ultimate. Supported parameters for issue, epic, and merge request queries Parameter Required Default Definition assignee
dotted-circle No not applicable Return items assigned to the given username. None
returns unassigned GitLab items. Any
returns GitLab items with an assignee. Not available for epics and vulnerabilities. author
dotted-circle No not applicable Return items created by the given username. confidential
dotted-circle No not applicable Filter confidential or public issues. Available only for issues. createdAfter
dotted-circle No not applicable Return items created after the given date. createdBefore
dotted-circle No not applicable Return items created before the given date. draft
dotted-circle No no
Filter merge requests against their draft status: yes
returns only merge requests in draft status, no
returns only merge requests not in draft status. Available only for merge requests. excludeAssignee
dotted-circle No not applicable Return items not assigned to the given username. Available only for issues. For the current user, set to <current_user>
. excludeAuthor
dotted-circle No not applicable Return items not created by the given username. Available only for issues. For the current user, set to <current_user>
. excludeLabels
dotted-circle No []
Array of label names. Available only for issues. Items returned have none of the labels in the array. Predefined names are case-insensitive. excludeMilestone
dotted-circle No not applicable The milestone title to exclude. Available only for issues. excludeSearch
dotted-circle No not applicable Search GitLab items that doesn’t have the search key in their title or description. Works only with issues. labels
dotted-circle No []
Array of label names. Items returned have all labels in the array. None
returns items with no labels. Any
returns items with at least one label. Predefined names are case-insensitive. maxResults
dotted-circle No 20 The number of results to show. milestone
dotted-circle No not applicable The milestone title. None
lists all items with no milestone. Any
lists all items with an assigned milestone. Not available for epics and vulnerabilities. orderBy
dotted-circle No created_at
Return entities ordered by the selected value. Possible values: created_at
, updated_at
, priority
, due_date
, relative_position
, label_priority
, milestone_due
, popularity
, weight
. Some values are specific to issues, and some to merge requests. For more information, see List merge requests. reviewer
dotted-circle No not applicable Return merge requests assigned for review to this username. For the current user, set to <current_user>
. None
returns items without a reviewer. Any
returns items with a reviewer. scope
dotted-circle No all
Return GitLab items for the given scope. Not applicable for epics. Possible values: assigned_to_me
, created_by_me
, all
. search
dotted-circle No not applicable Search GitLab items against their title and description. searchIn
dotted-circle No all
Change the scope of the excludeSearch
search attribute. Possible values: all
, title
, description
. Works only with issues. sort
dotted-circle No desc
Return issues sorted in ascending or descending order. Possible values: asc
, desc
. state
dotted-circle No opened
Return all issues, or only those matching a particular state. Possible values: all
, opened
, closed
. updatedAfter
dotted-circle No not applicable Return items updated after the given date. updatedBefore
dotted-circle No not applicable Return items updated before the given date. 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:
Parameter Required Default DefinitionconfidenceLevels
dotted-circle No all
Returns vulnerabilities belonging to specified confidence levels. Possible values: undefined
, ignore
, unknown
, experimental
, low
, medium
, high
, confirmed
. reportTypes
dotted-circle No Not applicable Returns vulnerabilities belonging to specified report types. Possible values: sast
, dast
, dependency_scanning
, container_scanning
. scope
dotted-circle No dismissed
Returns vulnerability findings for the given scope. Possible values: all
, dismissed
. For more information, see the Vulnerability findings API. severityLevels
dotted-circle No all
Returns vulnerabilities belonging to specified severity levels. Possible values: undefined
, info
, unknown
, low
, medium
, high
, critical
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4