Repository navigation
Conversation
📝 WalkthroughWalkthroughThe change adds a runtime capability documentation map and lookup utilities. Tests verify documentation completeness, conditional capabilities, and filtering of unknown flags. JSON status output now includes Priority: ➖ Normal Severity of issue fixed: Medium Merge Risk: 🔵 Low · up to A future runtime capability could be added without agent-readable documentation, weakening the advertised JSON contract. Add the completeness assertion before merge. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Description checkExplanation The description explains the main change, motivation, linked issue, and test coverage. It does not follow the required template and omits the ELI5, Visual Proof, AI Disclosure, Review, Agent skill upstream boundary, Notes, and Checklist sections. It also does not include the required manual-testing checklist details. Resolution Add all required template sections. Include an ELI5 summary, explicit What Changed and Why sections, the linked issue in the required format, Visual Proof with N/A and a reason if applicable, AI Disclosure, Review, Agent skill upstream boundary, Notes, and the complete Checklist. Document manual testing and platform coverage.
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.
🧹 Nitpick comments (1)
src/shared/runtime-capability-docs.ts (1)
33-36: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winReduce these implementation comments to one concise line each.
Both comments explain nearby code across several lines. Keep only the non-obvious rationale.
src/shared/runtime-capability-docs.ts#L33-L36: State that known advertised capabilities have descriptions and unknown flags are omitted.src/cli/handlers/core.ts#L143-L145: State that JSON status receives local enrichment without a wire change.As per coding guidelines, “Comments must be concise, limited to non-obvious information, and preferably one line.”
Source: Coding guidelines
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 3ba4893a-26ff-40e4-a58d-f38cef097ccb
📥 Commits
Reviewing files that changed from the base of the PR and between 6da7b8e and 7b1f9eb60550f78e214fd3562915d8c379745f58.
📒 Files selected for processing (5)
src/cli/handlers/core.test.tssrc/cli/handlers/core.tssrc/cli/specs/core.tssrc/shared/runtime-capability-docs.test.tssrc/shared/runtime-capability-docs.ts
7b1f9eb to
b6c0e82
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Advanced
Run ID: 8f4cb4da-9585-43f2-8edf-de59b0fd154b
📥 Commits
Reviewing files that changed from the base of the PR and between 7b1f9eb60550f78e214fd3562915d8c379745f58 and b6c0e82.
📒 Files selected for processing (4)
src/cli/handlers/core.test.tssrc/cli/handlers/core.tssrc/cli/specs/core.tssrc/shared/runtime-capability-docs.test.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- src/cli/specs/core.ts
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.
| const undocumented = listUndocumentedRuntimeCapabilities() | ||
| expect(Array.isArray(undocumented)).toBe(true) |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Require complete catalog coverage.
The current assertions pass when one or more runtime capabilities lack documentation. Assert that undocumented is empty. This makes a missing RUNTIME_CAPABILITY_DOCS entry fail the test.
Proposed fix
const undocumented = listUndocumentedRuntimeCapabilities()
+ expect(undocumented).toEqual([])
expect(Array.isArray(undocumented)).toBe(true)Based on learnings: fixed registries must have complete coverage.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const undocumented = listUndocumentedRuntimeCapabilities() | |
| expect(Array.isArray(undocumented)).toBe(true) | |
| const undocumented = listUndocumentedRuntimeCapabilities() | |
| expect(undocumented).toEqual([]) | |
| expect(Array.isArray(undocumented)).toBe(true) |
Source: Learnings
Summary
RUNTIME_CAPABILITY_DOCS).orca status --jsonnow includesruntime.capabilityDocsfor the advertised flags (client-side enrichment; no wire change).orca status --helpnotes describe how to usecapabilities+capabilityDocs.Why
Closes #13202 — status advertised ~31 bare flag names with no agent-readable semantics.
Test plan
RUNTIME_CAPABILITIESentry has a doc lineorca status --json | jq '.result.runtime.capabilityDocs'