{"id":19385746,"url":"https://github.com/karinjs/puppeteer","last_synced_at":"2026-02-23T08:11:14.726Z","repository":{"id":257803977,"uuid":"864563456","full_name":"KarinJS/puppeteer","owner":"KarinJS","description":"puppeteer for karin plugin","archived":false,"fork":false,"pushed_at":"2025-03-31T11:31:36.000Z","size":960,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-31T11:36:29.756Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KarinJS.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-28T14:56:02.000Z","updated_at":"2025-03-31T11:31:24.000Z","dependencies_parsed_at":"2024-11-11T19:28:26.366Z","dependency_job_id":"bb12e113-c298-4032-909a-0ab382323e5b","html_url":"https://github.com/KarinJS/puppeteer","commit_stats":null,"previous_names":["karinjs/puppeteer"],"tags_count":68,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarinJS%2Fpuppeteer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarinJS%2Fpuppeteer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarinJS%2Fpuppeteer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KarinJS%2Fpuppeteer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KarinJS","download_url":"https://codeload.github.com/KarinJS/puppeteer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250527125,"owners_count":21445307,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T10:02:55.749Z","updated_at":"2026-02-23T08:11:14.719Z","avatar_url":"https://github.com/KarinJS.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @karinjs/plugin-puppeteer\n\n[node-karin](https://github.com/KarinJS/Karin) 的 Puppeteer 截图/渲染插件，基于 [@snapka/puppeteer](https://www.npmjs.com/package/@snapka/puppeteer) 封装。\n\n## 功能\n\n- 自动下载/查找系统中的 Chrome 浏览器\n- 支持 CDP 和 WebDriver BiDi 两种协议\n- 页面池管理（复用 / 一次性模式）\n- 并发截图队列与限速\n- 提供 Web 管理面板（通过 node-karin Web UI 配置）\n- 配置热更新\n\n## 安装\n\n作为 [node-karin](https://github.com/KarinJS/Karin) 插件安装：\n\n```bash\npnpm add @karinjs/plugin-puppeteer -w\n```\n\n## 配置\n\n插件首次运行时会自动生成默认配置文件，位于 `\u003ckarin数据目录\u003e/@karinjs-plugin-puppeteer/config/config.json`。\n\n也可以通过 node-karin 的 Web 管理面板修改配置。\n\n### 配置项\n\n| 配置项 | 类型 | 默认值 | 说明 |\n|---|---|---|---|\n| `protocol` | `'cdp' \\| 'webDriverBiDi'` | `'cdp'` | 浏览器通信协议。CDP 稳定，BiDi 更快但仍在开发中 |\n| `headless` | `'new' \\| 'shell' \\| false` | `'shell'` | 无头模式。`'new'` 新版无头、`'shell'` 传统无头（仅 chrome-headless-shell）、`false` 有头 |\n| `debug` | `boolean` | `false` | 调试模式，浏览器前台运行且页面不自动关闭（仅 Windows） |\n| `findBrowser` | `boolean` | `true` | 是否使用 @snapka/browser-finder 自动查找系统/puppeteer/playwright 已有的浏览器 |\n| `pipe` | `boolean` | `false` | 是否使用管道模式与浏览器通信 |\n| `slowMo` | `number` | `0` | 操作延迟（毫秒），用于调试 |\n| `maxOpenPages` | `number` | `10` | 最大同时打开的标签页数量，超出排队 |\n| `pageMode` | `'reuse' \\| 'disposable'` | `'reuse'` | 页面模式。复用模式性能好，一次性模式隔离性强 |\n| `pageIdleTimeout` | `number` | `60000` | 页面空闲超时时间（毫秒），`0` 表示永不超时 |\n| `defaultViewport` | `{ width, height }` | `{ width: 800, height: 600 }` | 默认视窗大小 |\n| `executablePath` | `string` | - | 浏览器可执行文件路径，为空则自动下载/查找 |\n| `userDataDir` | `string` | - | 浏览器用户数据目录 |\n| `args` | `string[]` | 见下方 | Chrome 启动参数 |\n| `download.enable` | `boolean` | `true` | 是否启用浏览器自动下载 |\n| `download.browser` | `'chrome' \\| 'chromium' \\| 'chrome-headless-shell'` | `'chrome-headless-shell'` | 下载的浏览器类型 |\n| `download.version` | `string` | `'latest'` | 浏览器版本，支持 `latest`、`stable`、`beta`、`dev`、`canary` 或具体版本号 |\n| `download.dir` | `string` | - | 下载目录，为空使用默认路径 |\n| `download.baseUrl` | `string` | - | 自定义下载源 URL |\n\n### 默认启动参数\n\n```\n--window-size=800,600\n--disable-gpu\n--no-sandbox\n--disable-setuid-sandbox\n--no-zygote\n--disable-extensions\n--disable-dev-shm-usage\n--disable-background-networking\n--disable-sync\n--disable-crash-reporter\n--disable-translate\n--disable-notifications\n--disable-device-discovery-notifications\n--disable-accelerated-2d-canvas\n```\n\n## 开发\n\n### 环境要求\n\n- Node.js \u003e= 18\n- pnpm\n\n### 目录结构\n\n```\n├── src/\n│   ├── index.ts          # 插件入口，注册渲染器\n│   ├── app.ts            # 开发模式入口\n│   ├── web.config.ts     # Web 管理面板配置\n│   ├── utils.ts          # 工具函数\n│   ├── config/\n│   │   └── index.ts      # 配置管理\n│   └── __mocks__/        # 测试 mock\n├── tsconfig.json\n├── tsup.config.ts\n├── vitest.config.ts\n├── eslint.config.mjs\n└── package.json\n```\n\n### 常用命令\n\n```bash\n# 安装依赖\npnpm install\n\n# 开发模式\npnpm dev\n\n# 构建\npnpm build\n\n# 运行测试\npnpm test\n\n# 监听模式测试\npnpm test:watch\n\n# 测试覆盖率\npnpm test:coverage\n\n# Lint\npnpm lint\n\n# 发布\npnpm pub\n```\n\n### 构建产物\n\n构建输出到 `dist/` 目录，包含：\n\n- `dist/index.js` - 插件入口\n- `dist/web.config.js` - Web 管理面板配置\n- `dist/*.d.ts` - 类型声明\n\n## 协议\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarinjs%2Fpuppeteer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarinjs%2Fpuppeteer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarinjs%2Fpuppeteer/lists"}