Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fingerprintjs/action-coverage-report-md
GitHub action for creating markdown coverage report from Istanbul text report
https://github.com/fingerprintjs/action-coverage-report-md
coverage coverage-report github-actions jest markdown typescript
Last synced: 6 days ago
JSON representation
GitHub action for creating markdown coverage report from Istanbul text report
- Host: GitHub
- URL: https://github.com/fingerprintjs/action-coverage-report-md
- Owner: fingerprintjs
- License: mit
- Created: 2022-11-04T11:11:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-04T17:35:48.000Z (7 months ago)
- Last Synced: 2024-05-08T23:22:10.681Z (6 months ago)
- Topics: coverage, coverage-report, github-actions, jest, markdown, typescript
- Language: TypeScript
- Homepage:
- Size: 1.19 MB
- Stars: 3
- Watchers: 6
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Jest coverage report in Markdown
This action uses a text coverage report from Jest and generates a Markdown report based on it in the format shown below.
The table shows the status of each file. Each file and uncovered line is properly linked to it's examined version on
GitHub.
St|File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
--|--------------------|---------|----------|---------|---------|-------------------
🟡|All files | 70.58 | 72.22 | 83.33 | 71.42 |
🟡| src| 63.23 | 64.28 | 80 | 64.17 |
🔴| [main.ts](https://github.com/fingerprintjs/action-coverage-report-md/blob/80148ef2d10c51d31e3a472c61ce2ead8b68a2e1/src/main.ts)| 0 | 0 | 0 | 0 |[1-37](https://github.com/fingerprintjs/action-coverage-report-md/blob/80148ef2d10c51d31e3a472c61ce2ead8b68a2e1/src/main.ts#L1-L37)
🟢| [report.ts](https://github.com/fingerprintjs/action-coverage-report-md/blob/80148ef2d10c51d31e3a472c61ce2ead8b68a2e1/src/report.ts)| 95.55 | 100 | 88.88 | 95.55 |[14-15](https://github.com/fingerprintjs/action-coverage-report-md/blob/80148ef2d10c51d31e3a472c61ce2ead8b68a2e1/src/report.ts#L14-L15)
🟢| src/utils| 100 | 100 | 100 | 100 |
🟢| [getReportParts.ts](https://github.com/fingerprintjs/action-coverage-report-md/blob/80148ef2d10c51d31e3a472c61ce2ead8b68a2e1/src/utils/getReportParts.ts)| 100 | 100 | 100 | 100 |
🟢| [status.ts](https://github.com/fingerprintjs/action-coverage-report-md/blob/80148ef2d10c51d31e3a472c61ce2ead8b68a2e1/src/utils/status.ts)| 100 | 100 | 100 | 100 |
> **Note**
> This package isn’t part of our core product. It’s kindly shared “as-is” without any guaranteed level of support from Fingerprint. We warmly welcome community contributions.
## Usage
The action returns a `markdownReport` output that you can use in other actions. The example below shows how to use the
report in a pull request comment.
```yaml
steps:
- name: Prepare coverage report in markdown
uses: fingerprintjs/action-coverage-report-md@v2
id: coverage
- name: Add coverage comment to the PR
uses: marocchino/sticky-pull-request-comment@v2
with:
message: ${{ steps.coverage.outputs.markdownReport }}
```
### Extended usage
```yaml
steps:
- name: Prepare coverage report in markdown
uses: fingerprintjs/action-coverage-report-md@v2
id: coverage
with:
textReportPath: './coverage/text-report.txt'
srcBasePath: './utils'
- name: Add coverage comment to the PR
uses: marocchino/sticky-pull-request-comment@v2
with:
message: ${{ steps.coverage.outputs.markdownReport }}
```
#### Add coverage report to the job summary
You can add a code coverage report to the job summary. For more information, see
[Adding a job summary](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary) in the GitHub Actions documentation.
```yaml
steps:
- name: Prepare coverage report in markdown
uses: fingerprintjs/action-coverage-report-md@v2
id: coverage
with:
textReportPath: './coverage/text-report.txt'
srcBasePath: './utils'
- name: Add coverage report to the job summary
run: |
echo "## Code Coverage" >> $GITHUB_STEP_SUMMARY
echo "${{ steps.coverage.outputs.markdownReport }}" >> $GITHUB_STEP_SUMMARY
```
## API
### Inputs
| Name | Type | Default Value | Description |
|------------------|----------|-----------------------------|--------------------------------------------------------------------------------------|
| `textReportPath` | `string` | `'./coverage/coverage.txt'` | Path to the coverage report in the [Istanbul](https://istanbul.js.org/) text format. |
| `srcBasePath` | `string` | `'./src'` | Base path for the source folder. |
### Outputs
| Name | Type | Description |
|------------------|----------|-------------------------------------|
| `markdownReport` | `string` | Coverage report in Markdown format. |
## How to get a text coverage report
### Jest
* Using a CLI:
```shell
npx jest --coverage --coverageReporters="text" > coverage.txt
```
* Using a Configuration file:
```js
module.exports = {
// ... other settings
coverageReporters: [['text', { file: 'coverage.txt', path: './' }]],
};
```
### nyc (Istanbul)
* Using a CLI:
```shell
npx nyc report --reporter=text > ./coverage/coverage.txt
```
* Using a Configuration file:
```js
module.exports = {
// ... other settings
"reporter": ["text"],
"report-dir": "./coverage" // will generate a file ./coverage/text.txt
}
```
### Karma
```js
module.exports = function(config) {
config.set({
// ... other settings
reporters: ['coverage'],
coverageReporter: {
type : 'text',
dir: './coverage',
file: 'coverage.txt'
}
});
};
```