docs(idd): note the pnpm -- passthrough footgun for four helper scripts - #146
Conversation
pnpm forwards a literal `--` separator to invoked package.json scripts instead of stripping it like npm does. idd-skill's shared cli-args.mts parser strips one leading bare `--`, but four idd:<name> scripts route around that shared parser and reproduce the footgun: idd:post-idd-marker, idd:emit-marker, idd:discover-orphan-filter, and idd:discover-roadmap-graph. Document the failure modes and the no-leading-`--` workaround near the "Authoritative invocation surface per profile" section so operators hit this once, not repeatedly. Refs #145 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Pp83wfp8YJ8HuEegArMJvi
|
Warning Review limit reached
Next review available in: 94 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
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)
📝 WalkthroughWalkthroughThe documentation explains pnpm’s literal ChangesIDD helper script invocation documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Mergeability Score: 🔵 Low · up to The documentation adds a pnpm workaround for four helper scripts, with no runtime or production behavior changes. Mergeability depends on confirming that the affected-script list is complete, or narrowing the note to commands that are verified. Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Warning Billing warning: we have not been able to collect payment for this subscription for more than 72 hours. Please update the payment method or pay any pending invoices in Billing to avoid service interruption. 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.
Pull request overview
Documents the pnpm argument-separator behavior affecting four IDD helper scripts, satisfying issue #145.
Changes:
- Lists the four affected scripts and their errors.
- Provides a concrete no-separator workaround.
- Notes that dependency pin updates may resolve the upstream gap.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
A self-review pass flagged that two inline code spans in the new pnpm passthrough footgun note wrapped mid-span across lines, including the literal error string `missing value for argument: --`. Reflow so every inline code span stays intact on one line, matching this repo's own precedent (commit 1070cee) — the error text stays grep-able for anyone who hits it verbatim. Refs #145 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Pp83wfp8YJ8HuEegArMJvi
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Rejected — coderabbitai[bot] did not review HEAD 36bcb6e (review limit reached / rate limited); this is not a completed review (source: #issuecomment-5283593672) |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
F4 Cleanup Evidence (server-side fallback via
|
Summary
Adds a short note to
docs/idd-helper-scripts.md, next to the existing"Authoritative invocation surface per profile" section, documenting a
pnpm-specific
---forwarding footgun. pnpm forwards a literal--separator to invoked
package.jsonscripts instead of stripping it(npm strips it).
idd-skill's sharedcli-args.mtsparser alreadystrips one leading bare
--, but fouridd:<name>scripts routearound that shared parser and reproduce the footgun:
idd:post-idd-markerand
idd:emit-markerfail withmissing value for argument: --;idd:discover-orphan-filterandidd:discover-roadmap-graphfail withunknown argument: --. The note states the workaround (drop theleading
--) with a concrete before/after example.Closes #145
Background
Two of the six
idd-skillscripts excluded from the shared parser werechecked and found not to need a workaround note, for different
reasons, so this PR deliberately does not list them:
idd:merge-executeabsorbs the stray
--into apassthrougharray that a downstream,already-fixed parser strips, so it never reproduces the bug in
practice;
idd:onboardhas no correspondingpackage.jsonscript inthis repository at all.
This is a known upstream (
idd-skill) gap, not a localmisconfiguration; the note flags itself for review whenever the
@kurone-kito/idd-skillpin changes, since a future bump may narrow orremove the affected list.
Documentation-only change — no code, workflow, or config file changes.
Summary by CodeRabbit
idd:*commands.