https://github.com/artilleryio/vscode-artillery

Visual Studio Code extension for Artillery.
https://github.com/artilleryio/vscode-artillery

Last synced: 4 months ago
JSON representation

Visual Studio Code extension for Artillery.

• Host: GitHub
• URL: https://github.com/artilleryio/vscode-artillery
• Owner: artilleryio
• License: mpl-2.0
• Created: 2023-07-31T10:06:38.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-31T21:31:54.000Z (about 1 year ago)
• Last Synced: 2024-08-01T01:19:40.219Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 537 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Artillery for VS Code

The [Artillery](https://www.artillery.io/) extension for VS Code adds IntelliSense with autocomplete and validation for Artillery test scripts, inline documentation, and the ability to run a load test directly from VS Code.

## Installation

Install the extension from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Artilleryio.vscode-artillery).

## Features

### Autocomplete

Write scripts faster and avoid mistakes with autocomplete for Artillery test scripts.

Press Control+Space to show all available autocomplete options.

![Test script IntelliSense](./assets/vscode-intellisense-suggestions.png)

### Inline documentation

Hover over configuration options in your script to get a short description and a link to extended documentation for it.

![Inline tooltips for existing properties](./assets/vscode-intellisense-tooltips.png)

### Run test from VS Code

Click **▶ Run locally** at the top of the file to run the test script. This opens a new terminal inside VS Code and executes `artillery run` on the current script.

You can also open the Command Palette with Control+Shift+P (or `Command+Shift+P` on MacOS) and choose **Run load test locally** command.

> [!NOTE]

> This command executes `artillery run` on the script with no other arguments. If you need to use additional command-line flags, you will need to run `artillery` directly from a terminal.

## Configuration

### `include: Array`

- Default: `[]`

A list of absolute file URIs or glob patterns to always treat as Artillery test scripts.

```json

{

  "artillery.include": ["file:///User/john/Projects/acme/load-tests/**/*.yml"]

}

```

### `exclude: Array`

- Default: `[]`

A list of absolute file URIs or glob patterns to ignore. The extension will not activate for the ignored files.

```json

{

  "artillery.exclude": ["**/*.conf.yml"]

}

```