Skip to content

docs(config): document opener settings - #1945

Merged
clay-good merged 2 commits into
mainfrom
codex/docs-opener-config
Sep 22, 2026
Merged

clay-good merged 2 commits into
mainfrom
codex/docs-opener-config

Conversation

@clay-good

@clay-good clay-good commented Sep 21, 2026 •

Copy link
Copy Markdown
Collaborator

Status

LGTM. Ready for human review; not merged.

What changed

  • Document the complete openers configuration contract.
  • Cover built-in overrides, static arguments, validation, and disabled attach-dirs openers.
  • Add regression tests for both launch styles.

Proof

  • 64 focused tests pass.
  • Full CI passes on Linux, macOS, and Windows.
  • Lint, build, security checks, and independent docs verification pass.

Closes #1347

Supersedes #1356. Related: #1257.

@clay-good
clay-good requested a review from a team as a code owner September 21, 2026 18:43
@clay-good
clay-good requested review from TabishB and removed request for a team September 21, 2026 18:43
@coderabbitai

coderabbitai Bot commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: Fission-AI/OpenSpec/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 0d5fa86b-7bf4-4deb-b0d9-bbf134518a8e

📥 Commits

Reviewing files that changed from the base of the PR and between e3e55b4 and 73331c9.

📒 Files selected for processing (3)
  • docs-lab/reference/configuration/config-json.md
  • test/commands/workset.test.ts
  • test/core/openers.test.ts
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs-lab/reference/configuration/config-json.md

Included review availability: Your plan provides up to 10 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The opener configuration reference now documents per-tool settings, launch styles, defaults, restrictions, and validation. Tests verify argument replacement, validation errors, workspace-file launches, and attach-directory argument ordering.

Changes

Opener configuration

Layer / File(s) Summary
Configuration contract and merge validation
docs-lab/reference/configuration/config-json.md, test/core/openers.test.ts
The documentation defines the openers map, per-tool fields, launch styles, defaults, restrictions, validation behavior, and JSON examples. Tests verify argument replacement without mutating built-in definitions and reject non-string arguments.
Launch argument ordering
test/commands/workset.test.ts
Tests verify workspace-file paths and working directories for code-insiders and code. Attach-dirs tests verify that configured arguments precede configured attach pairs.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other · Severity of issue fixed: Medium

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Issue #1347 requires static CLI arguments for attach-dirs openers. The reviewed head documents the existing args field, its ordering before generated attach arguments, replacement behavior, valida…
Out of Scope Changes check ✅ Passed The changes are limited to config.json opener documentation and opener/workset tests. Each change documents or verifies the static-argument behavior requested by issue #1347. No unrelated runtime, c…
Docstring Coverage ✅ Passed 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…
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary change: documenting opener configuration settings in the configuration reference.
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@openspec-cloud

Copy link
Copy Markdown
Contributor

No PR-relevant drift confirmed.

AI-generated · A citation proves the line exists, not that it makes the case — verify before acting.
No issue was confirmed at e3e55b4; 2 requirements could not be verified.
This is not a full-repository clean result; see the check for coverage and any broader findings.
View results · Click Refresh, then Scan again in the check. Or comment /openspec-cloud.

@alfred-openspec alfred-openspec left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the current head. Looks good.

@clay-good
clay-good added this pull request to the merge queue Sep 22, 2026
Merged via the queue into main with commit 91f2925 Sep 22, 2026
17 checks passed
@clay-good
clay-good deleted the codex/docs-opener-config branch September 22, 2026 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

openers config: allow extra CLI args for the claude (and other attach-dirs) opener, e.g. --dangerously-skip-permissions

2 participants