Installations

npm install jest-puppeteer-istanbul

Pull Requests

Open

7

Total

59

Closed

27

Merged

25

Issues

Open

2

Total

11

Closed

9

Releases

1

jest-puppeteer-istanbul@0.5.3

Published on 05 May 2020

View all 1 releases

Developer

ocavue

Developer Guide

BETA

Module System

Unable to determine the module system for this package.

Min. Node Version

Typescript Support

No

Node Version

12.16.3

NPM Version

6.14.4 Statistics

27 Stars

107 Commits

1 Forks

3 Watching

24 Branches

2 Contributors

Updated on 07 Feb 2024

Languages

TypeScript (90.15%)

JavaScript (5.65%)

Shell (4.2%)

Total Downloads

Cumulative downloads

Total Downloads

161,113

Last day

-29.4%

125

Compared to previous day

Last week

-2.6%

700

Compared to previous week

Last month

-0.3%

3,056

Compared to previous month

Last year

32.9%

31,283

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

2

jest puppeteer

Dev Dependencies

13

@changesets/cli @types/expect-puppeteer @types/jest-environment-puppeteer @types/puppeteer @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-prettier prettier prettier-eslint jest typescript

Versions

jest-puppeteer-istanbul

Using Playwright? Check https://github.com/ccpu/jest-playwright-istanbul, which is a fork of this project.

Install

1yarn add -D jest-puppeteer-istanbul
2// or
3npm install -D jest-puppeteer-istanbul

Configure

[1/4]

Make sure that you have Jest and Babel installed and configured.

[2/4]

Install babel-plugin-istanbul and add it to your Babel config.

You should ONLY use this plugin when you are in development mode. This plugin will add a lot of code for keeping track of the coverage statements. You definitely won't want them in your final production code.

Babel configuration examples:

1// .babelrc.js
2
3const plugins = [ /* Your babel plugins */ ]
4if (process.env.NODE_ENV === "development") {
5  plugins.push("istanbul")
6}
7module.exports = {
8  plugins: plugins
9}

1// babel.config.json
2
3{
4  "plugins": [
5    // Your babel plugins
6  ],
7  "env": {
8    "development": {
9      "plugins": [
10         "istanbul"
11      ]
12    }
13  }
14}

[3/4]

Update your Jest configuration:

Add json to coverageReporters. Since the defualt value of coverageReporters has json inclued, you don't need to change coverageReporters if you havn't specify it.
Add jest-puppeteer-istanbul/lib/setup to setupFilesAfterEnv.
Add jest-puppeteer-istanbul/lib/reporter to reporters.

Notice:

If custom reporters are specified, the default Jest reporters will be overridden. To keep default reporters, default can be passed as a module name.

A Jest configuration example:

1{
2  coverageReporters: ["json", "text", "lcov"],
3  setupFilesAfterEnv: ["jest-puppeteer-istanbul/lib/setup"],
4  reporters: ["default", "jest-puppeteer-istanbul/lib/reporter"],
5  collectCoverage: true,
6}

[4/4]

jest-puppeteer-istanbul need to access puppeteer page from global variable page to get coverage information. If you use jest-puppeteer, jest-puppeteer will do it for you and you can skip this step. Otherwise you need to do it yourself, like below:

1beforeAll(async () => {
2    const browser = await puppeteer.launch()
3    const page = await browser.newPage()
4    global.page = page
5})
6describe("E2E Tests", () => {
7    test(async () => { /* Your test code */ })
8})

Examples

Check this link for complete examples.

Troubleshooting

If you can't get the code coverage correctly when using the Jest from IntelliJ IDEA or WebStorm, that's because the IDE ignores jest-puppeteer-istanbul/lib/reporter in the jest.config.js in favour of its own Jest reporter. You can add --reporters jest-puppeteer-istanbul/lib/reporter in your IDE's Jest configuration like below to fix this.

IDEA config

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More