Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pester/vscode-adapter

Run PowerShell Pester Tests with Visual Studio Code
https://github.com/pester/vscode-adapter

hacktoberfest pester powershell scripts test testing visual-studio-code vscode vscode-extension

Last synced: about 1 month ago
JSON representation

Run PowerShell Pester Tests with Visual Studio Code

Host: GitHub
URL: https://github.com/pester/vscode-adapter
Owner: pester
License: mit
Created: 2021-06-20T08:18:05.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-11-25T18:28:54.000Z (about 2 months ago)
Last Synced: 2024-12-01T12:46:03.312Z (about 1 month ago)
Topics: hacktoberfest, pester, powershell, scripts, test, testing, visual-studio-code, vscode, vscode-extension
Language: TypeScript
Homepage:
Size: 1.11 MB
Stars: 58
Watchers: 4
Forks: 14
Open Issues: 23
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

jimsghstars - pester/vscode-adapter - Run PowerShell Pester Tests with Visual Studio Code (TypeScript)

README

        [![Pester Test Adapter for Visual Studio Code](images/social-preview.png)](https://marketplace.visualstudio.com/items?itemName=pspester.pester-test)

[![Latest](https://img.shields.io/visual-studio-marketplace/v/pspester.pester-test?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=pspester.pester-test)

[![Installs](https://img.shields.io/visual-studio-marketplace/i/pspester.pester-test?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=pspester.pester-test)

[![vsix](https://img.shields.io/github/v/release/pester/vscode-adapter?label=vsix&sort=semver&style=flat-square)](https://github.com/pester/vscode-adapter/releases)

[![Build](https://img.shields.io/github/workflow/status/pester/vscode-adapter/ci.yml?style=flat-square)](https://github.com/pester/vscode-adapter/actions/workflows/ci.yml)

[![Analysis](https://img.shields.io/github/workflow/status/pester/vscode-adapter/codeql-analysis.yml/main?label=codeQL&style=flat-square)](https://github.com/pester/vscode-adapter/actions/workflows/codeql-analysis.yml)

[![License: MIT](https://img.shields.io/npm/l/tslog?logo=tslog&style=flat-square)](https://tldrlegal.com/license/mit-license)

[![GitHub stars](https://img.shields.io/github/stars/pester/vscode-adapter?style=social)](https://github.com/pester/vscode-adapter)

🚧 THIS EXTENSION IS IN PREVIEW STATE, THERE ARE GOING TO BE BUGS 🚧

This extension provides the ability to run [Pester](https://pester.dev/) tests utilizing the native

[Testing functionality](https://code.visualstudio.com/updates/v1_59#_testing-apis) first introduced in Visual Studio Code 1.59

![Example](images/2021-08-07-08-06-26.png)

### Highlights

🔍 **Pester Test Browser**

🐞 **Debugging Support**

👩‍💻 **Native PowerShell Extension Integration**

👨‍👧‍👦 **Expands Test Cases**

### Extension Prerequisites

- Pester 5.2.0 or later (sorry, no Pester 4 support)

- PowerShell 7+ or Windows PowerShell 5.1

### Usage

The extension will automatically discover all `.Tests.ps1` Pester files in your workspace, you can then run tests either

from the Tests pane or from the green arrows that will appear adjacent to your tests.

### Installing the latest preview VSIX

Preview VSIX extension packages are generated upon every commit to main and every pull request update. To install a beta build:

1. Click the green checkmark next to the latest commit

1. Click `Details` next to the `👷‍♂️ Build Visual Studio Code Extension` task

1. Click `Artifacts` in the upper right of the window

1. Download the latest artifact zip and unzip it, it should be named `vsix-{version}`

1. Open the resulting folder in vscode, right click the `.vsix` file, and choose `Install Extension VSIX` near the bottom.

1. Alternatively in vscode you can hit F1 and choose `Extensions: Install from VSIX` and browse for the vsix file.

### Configuration

This extension will use the PowerShell Extension Pester verbosity settings for the output.

### Troubleshooting

The Pester `Output` pane maintains a log of the activities that occur with the Pester extension. You can use `Set Log Level` in the command palette to increase the log level to debug or trace to get more information about what is going on. Include this information when submitting an issue along with reproduction steps.

### Known Issues

- For test history purposes, a test is uniquely identified by its full path, e.g. Describe/Context/It. If you rename a test or move a test to another context/describe, it will be treated as a new test and test history will be reset

- If you do not have any .tests.ps1 files in your directory upon startup, you will currently need to reload vscode for the extension to activate after you create the .tests.ps1 file. [This is is a known issue that is being tracked](https://github.com/pester/vscode-adapter/issues/122)