Gathering detailed insights and metrics for @zooshdigital/bitbucket-v8-coverage-report
Gathering detailed insights and metrics for @zooshdigital/bitbucket-v8-coverage-report
Installations
npm install @zooshdigital/bitbucket-v8-coverage-reportDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
18.x || 20.x || 22.x
Node Version
22.11.0
NPM Version
10.9.0
Releases
Unable to fetch releases
Languages
2
JavaScript
TypeScript
JavaScript (59.48%)
TypeScript (40.52%)
Developer
zooshgroup
Download Statistics
Total Downloads
7,608
Last Day
25
Last Week
96
Last Month
444
Last Year
6,388
GitHub Statistics
GPL-3.0 License
1 Stars
5 Commits
2 Watchers
3 Branches
3 Contributors
Updated on Dec 11, 2024
Bundle Size
118.24 kB
Minified
29.55 kB
Minified + Gzipped
Maintainers
4
Package Meta Information
Latest Version
1.3.1
Package Id
@zooshdigital/bitbucket-v8-coverage-report@1.3.1
Unpacked Size
48.32 kB
Size
16.20 kB
File Count
5
NPM Version
10.9.0
Node Version
22.11.0
Published on
Dec 13, 2024
Total Downloads
Cumulative downloads
Total Downloads
7,608
Last Day
525%
25
Compared to previous day
Last Week
14.3%
96
Compared to previous week
Last Month
-32.4%
444
Compared to previous month
Last Year
423.6%
6,388
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Zoosh bitbucket-v8-coverage-report
Zoosh bitbucket-v8-coverage-report is designed to facilitate the upload of V8 test coverage reports to Bitbucket Pull Requests. This package provides functions to automate the process of uploading reports generated during build processes.
Installation
To install Zoosh bitbucket-v8-coverage-report, simply include it as a dependency in your project's package.json file:
1npm install @zooshdigital/bitbucket-v8-coverage-report
or
1yarn add @zooshdigital/bitbucket-v8-coverage-report
Usage
This tool enables you to upload coverage reports to Bitbucket pipelines.
Configuring Jest for Code Coverage Analysis
When configuring Jest for code coverage analysis, you may need to specify which files should be included in the coverage report. The collectCoverageFrom property in Jest configuration allows you to specify these files. Here's an example of a possible configuration:
1coverageProvider: 'v8', 2coverageReporters: ['json-summary'], 3collectCoverageFrom: [ 4 './**/*.{js,ts}', 5 '!**/node_modules/**', 6 '!./.eslintrc.js', 7 '!./jest.config.ts', 8 '!./coverage/**', 9],
Consuming the analysis
Simply run the tool using npx. Below is an example of how to execute the command-line utility @zooshdigital/bitbucket-v8-coverage-report with npx directly from your terminal or a pipeline:
1npx @zooshdigital/bitbucket-v8-coverage-report -n reportName -p ./path-to-the-v8-coverage-report
or
1yarn bitbucket-v8-coverage-report -n reportName -p ./path-to-the-v8-coverage-report
If you prefer using yarn, ensure that the @zooshdigital/bitbucket-v8-coverage-report is listed in the dependencies of the current workspace if you're using multiple workspaces.
Configuration
It takes the following arguments:
-n [name]or--name [name](required): The name of the report in Bitbucket.-p [path]or--path [path](required): The path to the V8 coverage report file.-c [percentage]or--min-coverage [percentage](optional): Optional threshold for the average coverage (average of the other four metrics).-l [percentage]or--min-lines-coverage [percentage](optional): Optional threshold for the line coverage value.-s [percentage]or--min-statements-coverage [percentage](optional): Optional threshold for the statements coverage value.-f [percentage]or--min-functions-coverage [percentage](optional): Optional threshold for the functions coverage value.-b [percentage]or--min-branches-coverage [percentage](optional): Optional threshold for the branches coverage value.-aor--add-build(optional): Create a success/failed "build" as well besides the report.-j [path]orjunit-path [path]: (required for thefailed-test-commentflag): The path to a junit XML file with unit test results.-tor--failed-test-comment: Create a comment on a PR in case there are failed unit tests in the junit XML file.
Ensure that the specified path leads to a V8 coverage report that can be passed to the Bitbucket API.
Prerequisites
Authentication
While some requests could be automatically authenticated running in a pipeline, Bitbucket doesn't allow that for all endpoints. Thus, for simplicity, the library expects an access token for all API calls. This can be a repository, project or workspace access token in the BITBUCKET_BUILD_TOKEN environment variable. Create a token and make it available as a repository or deployment variable to the pipeline.
Other identifiers
Since information is attached to a commit (even in case of a pull request), the library needs the BITBUCKET_REPO_FULL_NAME and BITBUCKET_COMMIT environment variables to do that. These two are standard Bitbucket pipeline variables, so there is no need to set them explicitly if running the script in a pipeline.
The tool uses BITBUCKET_PR_ID for the failed-test-comment functionality.
License
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.
No vulnerabilities found.
No security vulnerabilities found.