Help › Guide
VS Code
Reqlyn 0.5.1 is not released yet. This help describes it ahead of release.
The Reqlyn extension for VS Code sends a folder workspace's requests, runs its operations and replays their regression cases without leaving the editor. It works through the reqlyn command line, so the same secrets, variables and credentials are used as on the desktop, and nothing secret passes through VS Code.
Installing
Install reqlyn.vsix with Extensions: Install from VSIX…, or code --install-extension reqlyn.vsix. It needs reqlyn on the PATH; set reqlyn.path in your user settings when it is elsewhere. That setting is this computer's only: a workspace's own settings cannot name the program, and the extension does not run in a folder VS Code has not been told to trust, since it would send that folder's requests. In Reqlyn's repository, apps/vscode builds it: npm ci, npx tsc -p ., npx vsce package --no-dependencies --allow-missing-repository.
Using it
Open a folder workspace (a folder of requests/ and operations/ files, as the desktop's "Open a folder as a workspace…" makes). The Explorer's Reqlyn view lists its requests and operations; the refresh button reads them again after a change.
- Send request (beside a request) sends it from this computer with the selected environment's variables and its credential, and opens the status, headers, time and body beside your files. A secret-named header's value is masked.
- Run operation asks for its input as JSON and opens what it gave.
- Run cases replays the operation's regression cases, sending nothing, writes each case and whether it holds to the Reqlyn output, and says how many hold.
The folder's index is kept where the desktop keeps a folder workspace's, so the desktop and VS Code on one folder share it. The Default environment's variables belong to this computer, not the folder: a variable a request needs is set on the desktop, or kept in an environment the folder holds (environments/<name>.yaml).
Help for Reqlyn 0.5.1. All help topics