Skip to content

Commit

Permalink
Formatting changes for readability
Browse files Browse the repository at this point in the history
  • Loading branch information
zabil authored Dec 20, 2017
1 parent 79574bb commit 62b7fe0
Showing 1 changed file with 38 additions and 30 deletions.
68 changes: 38 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,60 +2,68 @@

[![Build Status](https://travis-ci.org/getgauge/gauge-vscode.svg?branch=master)](https://travis-ci.org/getgauge/gauge-vscode)

Gauge extension for VSCode.
Gauge extension for [Visual Studio Code](https://code.visualstudio.com/)

This extension adds language support for the Gauge projects, including:
* Code Completion for steps, parameters and tags
### Code Completion for steps, parameters and tags
![Code Completion preview](https://raw.githubusercontent.com/getgauge/gauge-vscode/master/images/autocomplete.gif)
* Goto definition for steps

### Goto definition for steps
![Goto Definition preview](https://raw.githubusercontent.com/getgauge/gauge-vscode/master/images/gotoDefinition.gif)
* Formating
![Formatting preview](https://raw.githubusercontent.com/getgauge/gauge-vscode/master/images/format.gif)
* Diagnostics

### Diagnostics
![Diagnostics preview](https://raw.githubusercontent.com/getgauge/gauge-vscode/master/images/diagnostics.gif)
* References codelens
Shows step usages for a step implemenation.

* Run specifications and scenarios using codeLens
### Run specifications and scenarios using codeLens
![Execution preview](https://raw.githubusercontent.com/getgauge/gauge-vscode/master/images/execute.gif)

* Run all specifications from command palette
### Formating
![Formatting preview](https://raw.githubusercontent.com/getgauge/gauge-vscode/master/images/format.gif)
### References

Execute command `Gauge: Run All Specification` to run all the specification in `specs` (default) directory. Use `gauge.execution.specDirs` configuration to add or remove spec directories.
Shows step usages for a step implementation.

### Run all specifications from command palette

* Run specification from command palette
Execute command `Gauge: Run All Specification` to run all the specification in `specs` (default) directory. Use `gauge.execution.specDirs` configuration to add or remove spec directories.

Execute command `Gauge: Run Specification` to run the current open specification.
### Run specification from command palette

* Run scenarios from command palette
Execute command `Gauge: Run Specification` to run the current open specification.

Execute command `Gauge: Run Scenarios` to choose a scenario form current specification and run.
* Run scenario at cursor from command palette
### Run scenarios from command palette

Execute command `Gauge: Run Scenario At Cursor` to the scenario at cursor. It will ask to choose a scenario If cursor is not in scenario context.
Execute command `Gauge: Run Scenarios` to choose a scenario form current specification and run.

### Run scenario at cursor from command palette

* Repeat last gauge execution from command palette
Execute command `Gauge: Run Scenario At Cursor` to the scenario at cursor. It will ask to choose a scenario If cursor is not in scenario context.

Execute command `Gauge: Repeat Last Run` to repeat last gauge execution.
* Re-run failed scenarios from previous run
### Repeat last gauge execution from command palette

Execute command `Gauge: Re-Run Failed Scenario(s)` to repeat only failed scenarios from last gauge execution.
Execute command `Gauge: Repeat Last Run` to repeat last gauge execution.

### Re-run failed scenarios from previous run

* Snippets for specification, scenarios and tables.
- `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
Execute command `Gauge: Re-Run Failed Scenario(s)` to repeat only failed scenarios from last gauge execution.

### Snippets for specification, scenarios and tables.
`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

These configurations can be configured 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.specDirs` : List of specification directories which can be run by executing `Gauge: Run All Specifications` from command palette.
* `gauge.notification.suppressUpdateNotification` : Stops showing notifications for gauge-vscode plugin auto-updates. Defaults to `false`.

## Install from source

```shell
Expand Down

0 comments on commit 62b7fe0

Please sign in to comment.