https://github.com/ndom91/checkly-vscode

🦝 VS Code Checkly Extension
https://github.com/ndom91/checkly-vscode

checkly extension playwright vscode

Last synced: 2 months ago
JSON representation

🦝 VS Code Checkly Extension

• Host: GitHub
• URL: https://github.com/ndom91/checkly-vscode
• Owner: ndom91
• License: mit
• Created: 2022-08-17T13:29:19.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-05-09T14:35:26.000Z (over 1 year ago)
• Last Synced: 2024-10-04T20:31:14.625Z (3 months ago)
• Topics: checkly, extension, playwright, vscode
• Language: TypeScript
• Homepage:
• Size: 951 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🦝 Checkly VS Code Extension

Run your local Playwright/Puppeteer E2E tests through your Checkly Account directly from VS Code!

> Now using the new [`checkly`](https://github.com/checkly/checkly-cli) CLI package!

## 📱 Features

- Adds a `🦝 Run in Checkly` button and command palette option to VS Code

- Will report the adhoc test result directly in VS Code

## 📌 Installation

A. Search 'Checkly' on the VS Code Extension Sidebar

B. Or you can install it manually by downloading the `.vsix` file from the latest [Github Release](https://github.com/ndom91/checkly-vscode/releases) and choosing ["install from a vsix"](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix)

## 🏗️ Usage

1. When attempting to start an adhoc check run for the very first time, it will ask you for two config options:

   1. A Checkly Account ID (found in your Checkly "Settings" page)

   2. A Checkly API Key (Also found in "Settings" -> "User API Keys")

2. Then there are two ways to initiate a check run:

   1. You can use the `🦝 Run Current File` button in the bottom status bar in VS Code

   2. The command palette command `Checkly: Run Current File`

The check will be run with the [`checkly`](https://npm.im/checkly) CLI command `checkly test --record ${file}`

## 🏋️‍♀️ Contributing

We're open to most contributions, please stick to the [contributing guidelines]() and formatting settings!

## 📝 License

MIT