Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryanluker/vscode-coverage-gutters
Display test coverage generated by lcov and xml - works with many languages
https://github.com/ryanluker/vscode-coverage-gutters
coverage-gutters lcov test-coverage visual-studio-code vscode-extension
Last synced: about 1 month ago
JSON representation
Display test coverage generated by lcov and xml - works with many languages
- Host: GitHub
- URL: https://github.com/ryanluker/vscode-coverage-gutters
- Owner: ryanluker
- License: mit
- Created: 2016-12-10T21:03:50.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-08T17:32:29.000Z (about 1 month ago)
- Last Synced: 2024-12-08T18:27:54.956Z (about 1 month ago)
- Topics: coverage-gutters, lcov, test-coverage, visual-studio-code, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters
- Size: 27.7 MB
- Stars: 466
- Watchers: 11
- Forks: 91
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# coverage-gutters
Display test coverage generated by lcov or xml in your editor.
## Call for Maintainers
Looking for helpful people to assist with bugs, new features or performance improvements.
The project has a full suite of tests and code linting, making it very new contributor friendly.
Take a look at some of the open github issues and see if any catch your eye!
https://github.com/ryanluker/vscode-coverage-gutters/issues
## Features
- Supports any language as long as you can generate a lcov style coverage file
- Extensive logging and insight into operations via the output logs
- Multi coverage file support for both xml and lcov
- Coverage caching layer makes for speedy rendering even in large files
- Relative coverage file resolution for those with complex file paths
- Preview coverage reports inside the editor
- Huge amount of workspace settings to customize the features to your liking
- Colour compatibility with light and dark themes
- Custom coverage paths with a hot swapping feature for remote builds
## Common Commands
**Watch** (activated via command palette or shortcut icon on the status bar):
Activating watch allows the extension to keep track of coverage changes and update its cache. It also will automatically apply coverage to a file if some exists.
**Display** (activated via command palette or shortcut key):
Displays coverage for the current activated file only, does not update if the coverage files change.
**Preview Report** (activated via command palette):
Shows you a html preview of your coverage reports in your editor.
## Officially Supported Languages (Backed by tests ran nightly)
See [examples directory](example) on how to setup a project.
- [Java](example/java)
- [Java with Gradle](example/java-gradle)
- [Multimodule Java](example/multimodule-java)
- [PHP](example/php)
- [Python](example/python)
- [Nodejs](example/node)
- [Ruby](example/ruby)
- [DotNet](example/dotnet)
## Tips and Tricks
**Using Breakpoints**: Currently to both use the extension and code debugging breakpoints, you need to disable the gutter coverage and enable the line coverage via the settings ( `coverage-gutters.showGutterCoverage` and `coverage-gutters.showLineCoverage` respectively).
## Requirements
- vscode 1.27.0 and up
- macos, linux or windows
- Requires Live Preview extension
- vscode extension id: ms-vscode.live-server
- v0.2.12 or higher
## Extension Settings
See extension setting options in IDE.
## Known Issues
### [Open Bugs](https://github.com/ryanluker/vscode-coverage-gutters/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
## Release Notes
### [Changelog](https://github.com/ryanluker/vscode-coverage-gutters/releases)
## Contribution Guidelines
### [Guidelines](/CONTRIBUTING.md)
## About the Maintainers
If you are interested in what else we work on, checkout the maintainers below!
https://luker.dev
https://github.com/mattseddon
https://github.com/timagixe
https://www.spodymek.com/
https://www.kayode.tech/
https://huddleco.com.au/
-----------------------------------------------------------------------------------------------------------