Skip to content

Commit

Permalink
Python xml support for test coverage (#97)
Browse files Browse the repository at this point in the history
* increment version

* setup python example and update deps

* first cut of xml support and updating tests

* cleanup tslint errors and suggestions

* update changelog to latest github release info

* add metric event and fix xml based consumption

* add test to cover xml coverage

* update promotional text to have xml mentions
  • Loading branch information
ryanluker authored Oct 22, 2017
1 parent 3e4e5c5 commit c1933bb
Show file tree
Hide file tree
Showing 27 changed files with 3,578 additions and 329 deletions.
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
out
node_modules
.vscode-test
.cache
coverage
debug.log
npm-debug.log
npm-debug.log
__pycache__
.coverage
cov.xml
6 changes: 5 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,9 @@
"search.exclude": {
"out": true // set this to false to include "out" folder in search results
},
"typescript.tsdk": "./node_modules/typescript/lib" // we want to use the TS server from our node_modules folder to control its version
"typescript.tsdk": "./node_modules/typescript/lib",
"python.unitTest.pyTestArgs": [
"example"
],
"python.unitTest.pyTestEnabled": true // we want to use the TS server from our node_modules folder to control its version
}
33 changes: 32 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,38 @@
### 1.1.3
[Github Milestone](https://github.com/ryanluker/vscode-coverage-gutters/milestone/11?closed=1)
- fix bug where dots in file path would prevent lcov finding

### 1.1.2
[Github Milestone](https://github.com/ryanluker/vscode-coverage-gutters/milestone/10?closed=1)
- fix bug regarding break points and coverage extension
- cleanup preview feature media
- cleanup analytics event naming

### 1.1.1
[Github Milestone](https://github.com/ryanluker/vscode-coverage-gutters/milestone/9?closed=1)
- fixed a critical issue with the lcov report preview for unix type systems

### 1.1.0
[Github Milestone](https://github.com/ryanluker/vscode-coverage-gutters/milestone/8?closed=1)
- allow multiple lcov files and choose between them with a picker
- preview lcov report html files inside vscode
- cleanup outstanding errors and bugs (parse string, document undefined)
- update readme info
- update readme badges

### 1.0.0
[Github Milestone](https://github.com/ryanluker/vscode-coverage-gutters/milestone/7?closed=1)
- cleanup readme and add a buy me a coffee button (donate)
- updated dark theme colours and icons
- show gutters only show option on by default, added metrics for learning
- added more test coverage to config component
- added customization option for the status bar toggler
- fixed a bug related to excluding files in vscode and having the extension not be able to find the lcov file

### 0.6.0
[Github Milestone](https://github.com/ryanluker/vscode-coverage-gutters/milestone/6?closed=1)
- added statusbar action button
- combined watch editors and watch lcov into one command
- combined watch editors and watch coverage into one command
- added a remove watchers command
- refactored gutters to use dependency injection
- cleanup tests and add new ones
Expand Down
48 changes: 5 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@
[![Buy me a coffee](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=XRWWCAZBYB9SG&lc=CA&item_name=vscode%2dcoverage%2dgutters&currency_code=CAD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHostedGuest)

## Features
- watch editors and lcov feature activated via status bar button or command
- watch editors and coverage files feature activated via status bar button or command

![Coverage Gutters features watch](images/coverage-gutters-features-3.gif)

- lcov displayed in full, partial and uncovered options
- lcov displayed in full, partial and uncovered options (can consume xml or info file types)

![Coverage Gutters features options](images/coverage-gutters-features-2.PNG)

- preview overall coverage inside vscode

![Coverage Gutters preview overall coverage](images/vs-gutters-preview-2.gif)

- multi lcov info support via option picker
- relative lcov file resolution option for those with complex file paths
- multi coverage file support via option picker
- relative coverage file resolution option for those with complex file paths
- workspace settings to customize the features to your liking
- colour compatibility with light and dark themes

Expand All @@ -31,45 +31,7 @@
- macos, linux or windows

## Extension Settings

|Setting | Description
|--------|------------
|`coverage-gutters.lcovname`|Allows specification of a custom lcov file name
|`coverage-gutters.altSfCompare`|Uses a relative method of comparing lcov source file paths (default true)
|`coverage-gutters.highlightlight`|Changes the highlight for light themes
|`coverage-gutters.highlightdark`|Changes the highlight for dark themes
|`coverage-gutters.partialHighlightLight`|Changes the partial highlight for light themes
|`coverage-gutters.partialHighlightDark`|Changes the partial highlight for dark themes
|`coverage-gutters.noHighlightLight`|Changes the uncovered highlight for light themes
|`coverage-gutters.noHighlightDark`|Changes the uncovered highlight for dark themes
|`coverage-gutters.gutterIconPathDark`|Relative path to an icon in the extension for dark themes
|`coverage-gutters.gutterIconPathLight`|Relative path to an icon in the extension for light themes
|`coverage-gutters.partialGutterIconPathDark`|Relative path to an icon (partial coverage) in the extension for dark themes
|`coverage-gutters.partialGutterIconPathLight`|Relative path to an icon (partial coverage) in the extension for light themes
|`coverage-gutters.noGutterIconPathDark`|Relative path to an icon (no coverage) in the extension for dark themes
|`coverage-gutters.noGutterIconPathLight`|Relative path to an icon (no coverage) in the extension for light themes
|`coverage-gutters.showLineCoverage`|Show or hide the line coverage
|`coverage-gutters.showRulerCoverage`|Show or hide the ruler coverage
|`coverage-gutters.showGutterCoverage`|Show or hide the gutter coverage
|`coverage-gutters.customizable.status-bar-toggler-watchLcovAndVisibleEditors-enabled`|Setting this to false will remove the status bar item
|`coverage-gutters.customizable.menus-editor-context-previewLcovReport-enabled`|Setting this to false will remove the command from the editor context menu and vice versa
|`coverage-gutters.customizable.menus-editor-context-displayCoverage-enabled`|Setting this to false will remove the command from the editor context menu and vice versa
|`coverage-gutters.customizable.menus-editor-context-watchLcovFile-enabled`|Setting this to false will remove the command from the editor context menu and vice versa
|`coverage-gutters.customizable.menus-editor-context-watchVisibleEditors-enabled`|Setting this to false will remove the command from the editor context menu and vice versa
|`coverage-gutters.customizable.menus-editor-context-removeCoverage-enabled`|Setting this to false will remove the command from the editor context menu and vice versa
|`coverage-gutters.customizable.keybindings-previewLcovReport-enabled`|Setting this to false will remove the shortcut and vice versa
|`coverage-gutters.customizable.keybindings-displayCoverage-enabled`|Setting this to false will remove the shortcut and vice versa
|`coverage-gutters.customizable.keybindings-watchLcovFile-enabled`|Setting this to false will remove the shortcut and vice versa
|`coverage-gutters.customizable.keybindings-watchVisibleEditors-enabled`|Setting this to false will remove the shortcut and vice versa
|`coverage-gutters.customizable.keybindings-removeCoverage-enabled`|Setting this to false will remove the shortcut and vice versa

Some examples for the highlight colour are as follows:
- rgba(102, 153, 51, 0.75) <- recommended syntax based on vscode.d.ts
- keyword values like `lightred`

<a>https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Colors/Color_picker_tool</a>

<a>https://developer.mozilla.org/en/docs/Web/CSS/background-color#Syntax</a>
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)
Expand Down
Loading

0 comments on commit c1933bb

Please sign in to comment.