enhancement : Add onboarding validation command (webwright doctor)
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- playwright, python
调研方向
从 @app.command() 所示的 CLI 集成点开始,检查提议的 webwright/run/doctor.py 模块和 CHECKS 结构。实现所列出的环境、Playwright、配置和运行时检查,使 webwright doctor 能够报告 pass/fail 结果,并针对设置问题提供可执行的修复措施。
由索引模型根据 Issue 内容生成。
描述
Add webwright doctor onboarding validation command
Summary
Add a webwright doctor CLI command that validates local environment setup and provides actionable fixes for common onboarding/runtime issues.
Current State
Webwright setup currently requires multiple manual steps:
- Python environment setup
- Playwright installation
- Chromium browser installation
- Claude/Codex plugin setup
- API key configuration
- Browser runtime validation
When something is misconfigured, failures often happen later during runtime with limited debugging guidance.
Examples:
- Missing Chromium binaries
- Playwright not installed
- Missing API keys
- Plugin manifest/configuration issues
- Screenshot permission failures
This creates onboarding friction for new contributors and users.
Desired State
Provide a command:
webwright doctor
that validates the local environment before runtime.
Example output:
Webwright Doctor
[PASS] Python 3.11 detected
[PASS] playwright installed
[FAIL] Chromium missing
Fix: playwright install chromium
[PASS] OPENAI_API_KEY detected
[FAIL] Claude plugin manifest missing
4/6 checks passed
Proposed Checks
Environment
- Python version compatibility
- Required package availability
- Writable directories
Playwright
- Playwright installation
- Chromium/browser availability
- Headless launch validation
Configuration
- API key detection
- Plugin manifest detection
- Environment variable validation
Runtime Validation
- Launch browser
- Open simple webpage
- Capture screenshot successfully
Proposed Implementation
New Module
webwright/run/doctor.py
CLI Integration
@app.command()
def doctor():
run_doctor()
Suggested Structure
CHECKS = [
check_python,
check_playwright,
check_chromium,
check_api_keys,
check_plugins,
check_screenshot,
]
Optional Enhancements
--verbose--fix- JSON output mode
- CI compatibility
Benefits
- Easier onboarding
- Better contributor experience
- Faster debugging
- Fewer duplicate setup issues
- Reduced maintainer support burden
Scope
This should be relatively self-contained and beginner/intermediate contributor friendly.
- 主要语言
- Python
- 星标
- 6k
- 派生
- 385
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
microsoft/Webwright 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 88/100
-
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 1/5 1 小时以内 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 4/5 3-5 天 新手友好度 45/100
查看 microsoft/Webwright 的全部 Issue
相似的 Issue
-
bug priority:low
难度 2/5 1-3 小时 新手友好度 76/100
CyberAgent/psd2svg#436 ·
-
area/install-update comp/cli comp/desktop P3 sweeper:risk-compatibility type/bug
难度 2/5 1-3 小时 新手友好度 86/100
NousResearch/hermes-agent#122386 · 1 条评论 ·
-
ai-generated
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 78/100
vllm-project/production-stack#1105 ·
-
难度 2/5 1-3 小时 新手友好度 88/100