KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #cli #ai #claude-code #codex #developer-tools #open-source #dsh-plugin #ai-agent #mcp #deepseek-harness

gauge-vscode

★ 52 Open GitHub ↗

A Visual Studio Code plug-in for Gauge

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Gauge extension for [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=getgauge.gauge)

# Install

```
$ code --install-extension getgauge.gauge
```
*Other Install [options](#install-from-source)*

# Features

* [Create New Project](#create-new-project)
* [Code Completion](#code-completion)
* [Goto Definition](#goto-definition)
* [Diagnostics](#diagnostics)
* [Format Specifications](#format-specifications)
* [References](#references)
* [Symbols](#symbols)
* [Run Specs/Scenarios](#run-specifications-and-scenarios)
* [Debug Specs/Scenarios](#debug-specifications-and-scenarios)
* [Reports](#reports)
* [Test Explorer](#test-explorer)
* [Code Snippets](#snippets-for-specification-scenarios-and-tables)

Gauge language plugins supported by the Gauge Visual Studio Code plugin are:
* [gauge-js](https://github.com/getgauge/gauge-js)
* [gauge-java](https://github.com/getgauge/gauge-java)
* [gauge-dotnet](https://github.com/getgauge/gauge-dotnet)
* [gauge-python](https://github.com/getgauge/gauge-python)
* [gauge-ruby](https://github.com/getgauge/gauge-ruby)

## Create new project

Execute the Command `Gauge: Create new Gauge Project` and select the appropriate template to create a new Gauge Project

## Code Completion
<img src="https://github.com/getgauge/gauge-vscode/raw/master/images/autocomplete.jpg" alt="Code Completion preview" style="width: 600px;"/>

## Goto Definition
<img src="https://github.com/getgauge/gauge-vscode/raw/master/images/gotoDefinition.jpg" alt="Goto Definition preview" style="width: 600px;"/>

## Diagnostics

## Format Specifications

## Symbols

## References

## Run specifications and scenarios

### Using Codelens

### Using command palette
[Launch the command palette](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line)

* Gauge: Create a new Gauge Project
	* Gauge: Create a new Specification
	* Gauge: Find Step References
	* Gauge: Optimize VS Code Configuration for Gauge
	* Gauge: Run All Specification
	* Gauge: Run Specification
	* Gauge: Run Scenarios
	* Gauge: Run Scenario At Cursor
	* Gauge: Repeat Last Run
	* Gauge: Re-Run Failed Scenario(s)
	* Gauge: Show Last Run Report
	* Gauge: Stop current gauge execution
	* Gauge: Report Issue
	* Test: Focus on Gauge Specs View

## Debug specifications and scenarios

Suport for Debugging of step implementations in JS, Python and Ruby

## Reports

View execution reports inside VS Code

## Test Explorer

## Snippets for specification, scenarios and tables

To invoke a snippet type any of the following snippet keywords and Ctrl+space

* `spec` - for specification
* `sce` - for scenario
* `table:1` - table with one column
* `table:2` - table with two columns
* `table:3` - table with three columns
* `table:4` - table with four columns
* `table:5` - table with five columns
* `table:6` - table with six columns

# Configuration

To override default configurations in [VSCode settings](https://code.visualstudio.com/docs/getstarted/settings)

* `gauge.launch.enableDebugLogs`:  Starts gauge lsp server with log-level `debug`, defaults to `false`
* `gauge.execution.debugPort`:  Debug port, defaults to `9229`
* `gauge.notification.suppressUpdateNotification`:  Stops notifications for gauge-vscode plugin auto-updates, defaults to `false`
* `gauge.create.specification.withHelp`: Create specification template with help comments, defaults to `true`

## Run and Debug configuration

To specify the execution options for the tests, add a `"type":"gauge"` entry with `"request":"test"` to `launch.json`.
The options of the [gage run command](https://manpage.gauge.org/gauge_run.html) are available as properties of the entry. For Maven and Gradle plugins, the corresponding arguments are supported.
If there are multiple `"request":"test"` entries in `launch.json`, the first definition will be used.

# Install from source

$ npm run build

This will create `gauge-<version>.vsix` file which can be installed via VScode's [Install from VSIX](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix).
> Note: Manually delete the Gauge extension folder from [VSCode extensions folder](https://vscode-docs.readthedocs.io/en/stable/extensions/install-extension/) for a successful uninstallation of VSCode extension

# Troubleshooting

If gauge features are not activated, check file associations for `.spec` and `.cpt` it maybe used by another plugin. To fix this, add this to [user settings](https://code.visualstudio.com/docs/getstarted/settings)

```
"files.associations": {
	"*.spec": "gauge",
	"*.cpt": "gauge"
}
```

## Facing other issues?

Refer our [Troubleshooting](https://docs.getgauge.io/troubleshooting.html) guide

# Talk to us

Please see below for the best place to ask a query:

- How do I? -- [Stack Overflow](https://stackoverflow.com/questions/ask?tags=getgauge)
- I got this error, why? -- [Stack Overflow](https://stackoverflow.com/questions/ask?tags=getgauge)
- I got this error and I'm sure it's a bug -- file an [issue](https://github.com/getgauge/gauge-vscode/issues)
- I have an idea/request -- file an [issue](https://github.com/getgauge/gauge-vscode/issues)
- Why do you? -- [Google Groups](https://groups.google.com/forum/#!forum/getgauge)
- When will you? -- [Google Groups](https://groups.google.com/forum/#!forum/getgauge)

gauge-vscode

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README