docs(config): document the full opener configuration - #1356
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 6 remain after this review. 📝 WalkthroughWalkthroughThe PR updates the opener configuration reference and adds tests for custom opener arguments, launch logs, and built-in Codex argument overrides. ChangesOpener configuration
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This PR documents the opener configuration and extends related tests without changing runtime behavior; no actionable merge-blocking risk remains after normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 2 files. (1 skipped: 1 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/cli.md`:
- Around line 368-374: Update the “claude” CLI example to avoid silently
disabling permission checks: replace “--dangerously-skip-permissions” with a
neutral example flag, or add an explicit warning that it is only appropriate for
trusted or sandboxed workspaces.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
Good catch, fixed in 2c26e4b. The example now uses |
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
|
Ready for human review at Thanks @ChampPABA for identifying the documentation gap and contributing the original fix. Your commits remain in the PR history. The follow-up moves the reference to the current published docs, clarifies the existing contract, and verifies both examples with regression tests; there are no production-code changes. Build, type checking, lint, and all 64 opener/workset tests pass. Independent review and the latest CodeRabbit review found no remaining actionable issues. The rendered page was checked at desktop and phone widths. Full-suite results and environment-specific rerun evidence are in the PR description. The remaining gate is human approval of the CI and Security workflows, followed by review of their results before merging. Those runs have not executed for this commit. No merge or release has been performed. |
|
Thanks for picking this up. Looks good to me. Ping me if anything needs changing on my end after CI runs. |
alfred-openspec
left a comment
There was a problem hiding this comment.
Reviewed at 66a4b77. The opener reference matches the current configuration and launch behavior, including built-in overrides and disabled attach-dirs handling. Build and all 64 focused tests pass.
Status
LGTM. Ready for human review at
6d6b552ca. Two fresh reviews found one overbroad documentation claim, now corrected, and no further actionable issues. The final commit changes one documentation sentence; code and tests are unchanged from66a4b7732, whose CI and Security passed on Linux, macOS, and Windows. The final commit's workflow runs require maintainer approval. No merge has been performed.What was missing
The opener documentation did not explain the full configuration contract, especially static
argsand how overrides affect built-in tools. This made an existing capability hard to discover (#1347).What it does
attach-dirslaunches are temporarily disabled by default and that custom workspace editors must accept.code-workspacefiles.docs-lab/reference/configuration/config-json.mdpage. The legacydocs/cli.mdis unchanged from main, following the current docs policy.Proof it works
66a4b7732, CI and Security pass, including Linux/macOS/Windows tests, dependency review, audits, and website lockfile validation. Final-commit CI and Security await approval.Notes
The branch includes main through
a0ddb60d0. There are no production-code changes and no merge has been performed. Real editors were not launched; VS Code executable names and the example flag were also checked against its official CLI documentation. The original author's commits remain in the PR history.Summary by CodeRabbit
Documentation
Tests