https://github.com/runtimeverification/ercx-vscode

VSCode support for ERCx
https://github.com/runtimeverification/ercx-vscode

Last synced: 3 months ago
JSON representation

VSCode support for ERCx

• Host: GitHub
• URL: https://github.com/runtimeverification/ercx-vscode
• Owner: runtimeverification
• License: bsd-3-clause
• Created: 2023-07-10T11:35:01.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-09T10:17:59.000Z (about 2 years ago)
• Last Synced: 2025-10-20T21:53:11.611Z (8 months ago)
• Language: TypeScript
• Size: 4.02 MB
• Stars: 1
• Watchers: 6
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# VSCode for ERCx

This extension provides a way to run the [ERCx](https://ercx.runtimeverification.com/) tests inside VSCode.

When you open a .sol file, click on the code lens above the contract name to generate

the tests, then click run on the testing view.

The Extension uses the [ERCx API](https://ercx.runtimeverification.com/open-api) and a full suite of tests.

It usually takes around 2 minutes depending on server load.

The Extension only supports a single self-contained Solidity file as input for now.

You need to install an extension for Solidity syntax highlighting for this extension to work

as it activates `onLanguage:solidity`.

![loop](https://raw.githubusercontent.com/runtimeverification/ercx-vscode/5ea45164451df9d0cb4505f7d9bc0540724a6572/media/ercx-loop.gif)

## Set up the API Key

To utilize this extension, you must first set up the API key. You can obtain one from the [ERCx Open API](https://ercx.runtimeverification.com/open-api) page.

After obtaining the key, proceed to set it within the VS Code settings:

```json

{

  ...

  "ercx.apiKey": "xxxx",

  ...

}

```