https://github.com/vknabel/vscode-swift-coverage

Display coverage reports next to your code for Swift Package Manager projects.
https://github.com/vknabel/vscode-swift-coverage

codecov codecoverage coverage swift vscode vscode-extension

Last synced: 4 days ago
JSON representation

Display coverage reports next to your code for Swift Package Manager projects.

• Host: GitHub
• URL: https://github.com/vknabel/vscode-swift-coverage
• Owner: vknabel
• License: mit
• Created: 2020-08-29T11:11:55.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-28T07:15:17.000Z (5 months ago)
• Last Synced: 2024-06-28T08:37:28.014Z (5 months ago)
• Topics: codecov, codecoverage, coverage, swift, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=vknabel.swift-coverage
• Size: 1.1 MB
• Stars: 9
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# swift-coverage

Display coverage reports next to your code for Swift Package Manager projects.

![](./assets/docs/example.png)

To update and show your coverage statistics, run your tests with code coverage enabled.

```bash

swift test --enable-code-coverage

```

## Configuration

| Config                                        | Type                    | Default                                       | Description                                                             |

| --------------------------------------------- | ----------------------- | --------------------------------------------- | ----------------------------------------------------------------------- |

| swift-coverage.coverageFilePattern            | `string`; glob pattern  | `**/.build/*/debug/{coverage,codecov}/*.json` | The pattern where to find the llvm-codecov JSON-reports.                |

| swift-coverage.highlightsCoveredText          | `boolean`               | `false`                                       | Wether code with coverage should have a higlighted background.          |

| swift-coverage.highlightsNotCoveredText       | `boolean`               | `true`                                        | Wether code with no coverage should have a higlighted background.       |

| swift-coverage.coveredTextBackground.dark     | `string`, CSS-color     | `rgba(48, 209, 88, 0.25)`                     | The brackground color used to highlight code with coverage.             |

| swift-coverage.coveredTextBackground.light    | `string`, CSS-color     | `rgba(52, 199, 89, 0.25)`                     | The brackground color used to highlight code with coverage.             |

| swift-coverage.notCoveredTextBackground.dark  | `string`, CSS-color     | `rgba(255, 69, 58, 0.25)`                     | The brackground color used to highlight code with no coverage.          |

| swift-coverage.notCoveredTextBackground.light | `string`, CSS-color     | `rgba(255, 59, 48, 0.25)`                     | The brackground color used to highlight code with no coverage.          |

| swift-coverage.highlightsCoveredGutter        | `boolean`               | `true`                                        | Wether lines with coverage should have a highlight-gutter.              |

| swift-coverage.highlightsNotCoveredGutter     | `boolean`               | `true`                                        | Wether lines with no coverage should have a highlight-gutter.           |

| swift-coverage.highlightsMixedGutter          | `boolean`               | `true`                                        | Wether lines with mixed coverage should have a highlight-gutter.        |

| swift-coverage.coveredGutterIcon.dark         | `string`, absolute path | green indicator (builtin)                     | The path to the gutter-icon used to highlight code with coverage.       |

| swift-coverage.coveredGutterIcon.light        | `string`, absolute path | green indicator (builtin)                     | The path to the gutter-icon used to highlight code with coverage.       |

| swift-coverage.notCoveredGutterIcon.dark      | `string`, absolute path | red indicator (builtin)                       | The path to the gutter-icon used to highlight code without coverage.    |

| swift-coverage.notCoveredGutterIcon.light     | `string`, absolute path | red indicator (builtin)                       | The path to the gutter-icon used to highlight code without coverage.    |

| swift-coverage.mixedGutterIcon.dark           | `string`, absolute path | orange indicator (builtin)                    | The path to the gutter-icon used to highlight code with mixed coverage. |

| swift-coverage.mixedGutterIcon.light          | `string`, absolute path | orange indicator (builtin)                    | The path to the gutter-icon used to highlight code with mixed coverage. |

## Contributors

- Valentin Knabel, [@vknabel](https://github.com/vknabel)

## License

vscode-swift-coverage is available under the [MIT](./LICENSE) license.