You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Kani Visual Studio Code Extension
2
2
3
-
A [Visual Studio Code](https://code.visualstudio.com/) extension that allows users to run and debug their [Kani Rust Verifier](https://github.com/model-checking/kani) harnesses in vscode.
3
+
A [Visual Studio Code](https://code.visualstudio.com/) extension that allows users to run and debug their [Kani Rust Verifier](https://github.com/model-checking/kani) harnesses in VS Code.
4
4
5
5
## Usage
6
6
@@ -22,7 +22,7 @@ Check [user guide](docs/user-guide.md) for more detailed information.
22
22
## Requirements
23
23
24
24
-[Visual Studio Code](https://code.visualstudio.com/) 1.50 or newer
25
-
-[Kani](https://github.com/model-checking/kani) 0.29 or newer
25
+
-[Kani](https://github.com/model-checking/kani) 0.34 or newer
26
26
27
27
NOTE: The extension only works on Cargo packages. For standalone Rust files, Kani is only available on the command line.
For every test run, you can view the full output from Kani logged into the output channel as a text file. To view the log, open the output channel, and click on the channel drop down list to view a channel called `Output (Kani): ...`
To enable the coverage feature in the extension, toggle on the `Codelens-kani: Highlight Coverage` setting in `Settings > Extensions > Kani`.
104
+
105
+
#### View coverage information
106
+
107
+
Once the coverage feature is enabled, the `Get coverage info` action should be visible on top of each Kani harness in the project.
108
+
Running the `Get coverage info` highlights all lines for which coverage information was obtained.
109
+
110
+
Coverage information (as described in the [RFC for line coverage](https://model-checking.github.io/kani/rfc/rfcs/0008-line-coverage.html#postprocessing-coverage-checks)) is represented with three colors:
111
+
-**Green:** Indicates `FULL` coverage.
112
+
-**Yellow:** Indicates `PARTIAL` coverage.
113
+
-**Red:** Indicates `NONE` coverage.
114
+
115
+
**NOTE**: Line-based coverage information is an unstable feature.
0 commit comments