35 lines
1.0 KiB
Markdown
35 lines
1.0 KiB
Markdown
# `Coverage.py` Highlighter (coveragetool)
|
|
|
|
An extension to highlight lines according to a `coverage.json` generated by `Coverage.py`
|
|
|
|
## Features
|
|
|
|
---
|
|
|
|
## Requirements
|
|
|
|
* Python `coverage` package
|
|
* A `coverage.json` file generated by `coverage`
|
|
|
|
---
|
|
|
|
## Extension Settings
|
|
|
|
This extension contributes the following settings:
|
|
* `coveragetool.coverageFileName`: Name of the json file containing coverage data
|
|
* `coveragetool.coverageFilePath`: Path to the folder containing the coverage JSON file
|
|
* `coveragetool.replacePath`: Substring in paths that needs to be replaced
|
|
* `coveragetool.replacePathWith`: Substring to replace with in the paths
|
|
* `coveragetool.colors.executedColor`: Background color value for executed lines
|
|
* `coveragetool.colors.excludedColor`: Background color value for excluded lines
|
|
* `coveragetool.colors.missingColor`: Background color value for missing lines
|
|
|
|
## Commands
|
|
|
|
---
|
|
|
|
## Known Issues
|
|
|
|
* Decorations do not reload when coverage file changes.
|
|
* No warnings when coverage data is outdated.
|