Skip to content

docs(idd): note the pnpm -- passthrough footgun for four helper scripts - #146

Merged
kurone-kito merged 2 commits into
mainfrom
issue/145-docs-idd-document-pnpm-passthrough
Aug 13, 2026
Merged

docs(idd): note the pnpm -- passthrough footgun for four helper scripts#146
kurone-kito merged 2 commits into
mainfrom
issue/145-docs-idd-document-pnpm-passthrough

Conversation

@kurone-kito

@kurone-kito kurone-kito commented Aug 13, 2026

Copy link
Copy Markdown
Owner

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.json scripts instead of stripping it
(npm strips it). idd-skill's shared cli-args.mts parser already
strips one leading bare --, but four idd:<name> scripts route
around that shared parser and reproduce the footgun: idd:post-idd-marker
and idd:emit-marker fail with missing value for argument: --;
idd:discover-orphan-filter and idd:discover-roadmap-graph fail with
unknown argument: --. The note states the workaround (drop the
leading --) with a concrete before/after example.

Closes #145

Background

Two of the six idd-skill scripts excluded from the shared parser were
checked and found not to need a workaround note, for different
reasons, so this PR deliberately does not list them: idd:merge-execute
absorbs the stray -- into a passthrough array that a downstream,
already-fixed parser strips, so it never reproduces the bug in
practice; idd:onboard has no corresponding package.json script in
this repository at all.

This is a known upstream (idd-skill) gap, not a local
misconfiguration; the note flags itself for review whenever the
@kurone-kito/idd-skill pin changes, since a future bump may narrow or
remove the affected list.

Documentation-only change — no code, workflow, or config file changes.

Summary by CodeRabbit

  • Documentation
    • Documented a pnpm argument-forwarding compatibility issue affecting four idd:* commands.
    • Added corrected command examples that omit the argument separator.
    • Noted that the affected command list should be reviewed after dependency updates.

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
Copilot AI balanced review requested due to automatic review settings August 13, 2026 16:36
@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@kurone-kito, you've reached your PR review limit, so we couldn't start this review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 99c16b6d-054a-4e8e-bd55-0760c16b4b35

📥 Commits

Reviewing files that changed from the base of the PR and between 8ed32c2 and 36bcb6e.

📒 Files selected for processing (1)
  • docs/idd-helper-scripts.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 89b86e90-64b4-4dac-8c2f-92d3f551121b

📥 Commits

Reviewing files that changed from the base of the PR and between b422e4e and 8ed32c2.

📒 Files selected for processing (1)
  • docs/idd-helper-scripts.md

📝 Walkthrough

Walkthrough

The documentation explains pnpm’s literal -- forwarding behavior, identifies four affected idd:* scripts, and provides invocation examples without the separator. It also notes that the affected list should be reviewed after dependency pin changes.

Changes

IDD helper script invocation documentation

Layer / File(s) Summary
Document pnpm argument forwarding
docs/idd-helper-scripts.md
Documents the four affected scripts and the workaround to invoke them without a leading --. It states that other scripts tolerate both invocation forms.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Mergeability Score: 🔵 Low · up to 8ed32

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)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change and the pnpm argument-forwarding issue affecting four helper scripts.
Description check ✅ Passed The description explains the change, affected scripts, workaround, scope, background, and linked issue in sufficient detail.
Linked Issues check ✅ Passed The documentation addresses the linked issue objectives, including the exact four scripts, workaround, upstream context, and exclusions.
Out of Scope Changes check ✅ Passed The changes are limited to the requested documentation update, with no unrelated code, workflow, or configuration changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch issue/145-docs-idd-document-pnpm-passthrough

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.

❤️ Share

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

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 13, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

@kurone-kito
kurone-kito requested a balanced review from Copilot August 13, 2026 16:39
@kurone-kito

This comment has been minimized.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@kurone-kito

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
Copilot AI review requested due to automatic review settings August 13, 2026 17:02
@kurone-kito

This comment has been minimized.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@kurone-kito

This comment has been minimized.

@kurone-kito

Copy link
Copy Markdown
Owner Author

Rejected — coderabbitai[bot] did not review HEAD 36bcb6e (review limit reached / rate limited); this is not a completed review (source: #issuecomment-5283593672)

@kurone-kito

This comment has been minimized.

@kurone-kito

This comment has been minimized.

@kurone-kito
kurone-kito merged commit 8cab0f1 into main Aug 13, 2026
26 of 27 checks passed
@kurone-kito
kurone-kito deleted the issue/145-docs-idd-document-pnpm-passthrough branch August 13, 2026 17:11
@github-actions

Copy link
Copy Markdown

F4 Cleanup Evidence (server-side fallback via post-merge-cleanup.yml)

Field Value
Status applied
Applied 4
Failed 0
Skipped 6
Permission-blocked 0
Posted by post-merge-cleanup workflow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(idd): document the pnpm -- passthrough footgun for four idd-skill helper scripts

2 participants