Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add de-highlighting to coverage readme #131

Merged
merged 3 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Check [user guide](docs/user-guide.md) for more detailed information.
- One-click button for verifying Kani harnesses.
- Generate counterexamples as Rust unit tests.
- Debug counterexamples using a standard debugger.
- View coverage information inline using VS Code source highlighting.

## Requirements

Expand All @@ -32,7 +33,7 @@ NOTE: The extension only works on Cargo packages. For standalone Rust files, Kan
| :-------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------- |
| `kani.enable-codelens` | Enable Codelens actions for `Run Test (Kani)` & `Debug Test (Kani)`. | `true` |
| `kani.show-output-window` | Toggle to show the output terminal window containing the full output from Kani. | `false` |

| `kani.highlight-coverage` | Toggle to enable the codelens button for `Generage Coverage` by default. | `false`

## Installation

Expand Down
7 changes: 7 additions & 0 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,10 @@ Coverage information (as described in the [RFC for line coverage](https://model-
- **Red:** Indicates `NONE` coverage.

**NOTE**: Line-based coverage information is an unstable feature.


#### De-highlight coverage information

To remove or de-highlight the coverage information presented on the UI, open the command palette with `Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows/Linux). Then, search for the command `De-highlight coverage`. This should revert the VS Code UI to it's normal state (pre-coverage).

![De-highlight command](../resources/screenshots/de-highlight.png)
Binary file added resources/screenshots/de-highlight.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading