Installations
npm install puppeteer-extra-plugin-adblockerReleases
Unable to fetch releases
Developer
Developer Guide
Module System
CommonJS
Min. Node Version
>=8
Typescript Support
No
Node Version
18.12.1
NPM Version
lerna/3.22.1/node@v18.12.1+arm64 (darwin)
Statistics
6,528 Stars
604 Commits
744 Forks
114 Watching
5 Branches
49 Contributors
Updated on 28 Nov 2024
Languages
JavaScript (59.86%)
TypeScript (39.86%)
HTML (0.19%)
Shell (0.09%)
Total Downloads
Cumulative downloads
Total Downloads
6,813,408
Last day
-1%
7,180
Compared to previous day
Last week
15.8%
47,430
Compared to previous week
Last month
18.6%
176,304
Compared to previous month
Last year
-24.4%
1,913,422
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
3
puppeteer-extra 
This is the monorepo for puppeteer-extra, a modular plugin framework for puppeteer. :-)
🌟 For the main documentation, please head over to the puppeteer-extra package.
We've also recently introduced support for Playwright, if you're interested in that head over to playwright-extra.
Monorepo
Contributing
Contributing
PRs and new plugins are welcome! The plugin API for puppeteer-extra is clean and fun to use. Have a look the PuppeteerExtraPlugin base class documentation to get going and check out the existing plugins (minimal example is the anonymize-ua plugin) for reference.
We use a monorepo powered by Lerna (and yarn workspaces), ava for testing, the standard style for linting and JSDoc heavily to auto-generate markdown documentation based on code. :-)
Lerna
Lerna
This monorepo is powered by Lerna and yarn workspaces.
Initial setup
1# Install deps 2yarn 3 4# Bootstrap the packages in the current Lerna repo. 5# Installs all of their dependencies and links any cross-dependencies. 6yarn bootstrap 7 8# Build all TypeScript sources 9yarn build
Development flow
1# Install debug in all packages 2yarn lerna add debug 3 4# Install fs-extra to puppeteer-extra-plugin-user-data-dir 5yarn lerna add fs-extra --scope=puppeteer-extra-plugin-user-data-dir 6 7# Remove dependency 8# https://github.com/lerna/lerna/issues/833 9yarn lerna exec --concurrency 1 'yarn remove fs-extra; echo 0' 10 11# Run test in all packages 12yarn test 13 14# Update JSDoc based documentation in markdown files 15yarn docs 16 17# Upgrade project wide deps like puppeteer 18# (We keep the devDependency version blurry) 19rm -rf node_modules 20rm -rf yarn.lock 21yarn 22yarn lerna bootstrap 23 24# Update deps within packages (interactive) 25yarn lernaupdate 26 27# If in doubt :-( 28yarn lerna exec "rm -f yarn.lock; rm -rf node_modules; echo 0" 29rm -f yarn.lock && rm -rf node_modules && yarn cache clean 30 31# Run tests of specific package 32cd packages/puppeteer-extra-plugin-stealth 33yarn test 34 35# Run tests of specific stealth evasion 36cd packages/puppeteer-extra-plugin-stealth 37yarn ava -v ./evasions/user-agent-override/index.test.js 38 39# Test a local monorepo package in an outside folder as it would've been installed from the registry 40# Change PACKAGE_DIR to the path of this monorepo and PACKAGE to the package you wish to install 41PACKAGE=puppeteer-extra PACKAGE_DIR=/Users/foo/puppeteer-extra/packages && yarn remove $(echo $PACKAGE); true && rm -f $(pwd)/$(echo $PACKAGE)-latest.tgz && yarn --cwd $(echo $PACKAGE_DIR)/$(echo $PACKAGE) pack --filename $(pwd)/$(echo $PACKAGE)-latest.tgz && YARN_CACHE_FOLDER=/tmp/yarn yarn add file:$(pwd)/$(echo $PACKAGE)-latest.tgz && rm -rf /tmp/yarn
Publishing
1# make sure you're signed into npm before publishing 2# yarn publishing is broken so lerna uses npm 3npm whoami 4 5# ensure everything is up2date and peachy 6yarn 7yarn bootstrap 8yarn lerna link 9yarn build 10yarn test 11 12# Phew, let's publish these packages! 13# - Will publish all changed packages 14# - Will ask for new pkg version per package 15# - Will updated inter-package dependency versions automatically 16yarn lerna publish 17 18# Fix new dependency version symlinks 19yarn bootstrap && yarn lerna link
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 7/30 approved changesets -- score normalized to 2
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/extract-stealth.yml:1
- Warn: no topLevel permission defined: .github/workflows/label.yml:1
- Warn: no topLevel permission defined: .github/workflows/test.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/extract-stealth.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/berstend/puppeteer-extra/extract-stealth.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/extract-stealth.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/berstend/puppeteer-extra/extract-stealth.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/extract-stealth.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/berstend/puppeteer-extra/extract-stealth.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/label.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/berstend/puppeteer-extra/label.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/berstend/puppeteer-extra/test.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/berstend/puppeteer-extra/test.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/berstend/puppeteer-extra/test.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/berstend/puppeteer-extra/test.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:90: update your workflow using https://app.stepsecurity.io/secureworkflow/berstend/puppeteer-extra/test.yml/master?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 5 third-party GitHubAction dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 9 are checked with a SAST tool
Reason
54 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-wg6g-ppvx-927h
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
- Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
- Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
- Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
- Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
- Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
- Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-9q5w-79cv-947m
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
- Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
- Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
- Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
- Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
- Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
- Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
3
/10
Last Scanned on 2024-11-25
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