fix(writing-plans): avoid invalid placeholder chars in plan filenames#635
Conversation
📝 WalkthroughWalkthroughUpdated the plan-saving filename format from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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
🧹 Nitpick comments (1)
skills/writing-plans/SKILL.md (1)
106-106: Consider replacing<filename>placeholder for consistency.While this is a message template (not an actual filename), the angle bracket notation could create confusion given the new explicit rule on line 23: "Never leave placeholder characters like
<>in the actual filename."♻️ Suggested alternative wording
-**"Plan complete and saved to `docs/plans/<filename>.md`. Two execution options:** +**"Plan complete and saved to `docs/plans/[YYYY-MM-DD-your-feature-name].md`. Two execution options:**This uses square brackets to distinguish template variables from the angle bracket placeholders that must be avoided in actual filenames.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/writing-plans/SKILL.md` at line 106, Replace the angle-bracket placeholder in the message template that reads "**Plan complete and saved to `docs/plans/<filename>.md`. Two execution options:**" with a non-angle form to avoid confusion with the rule banning `<` and `>` in filenames; change `<filename>` to `[filename]` (or a similar bracketed token) and adjust the surrounding text if needed to make clear it’s a template variable in SKILL.md.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@skills/writing-plans/SKILL.md`:
- Around line 20-23: The brainstorming skill uses angle-bracket placeholders in
filename patterns — specifically the pattern
"docs/plans/YYYY-MM-DD-<topic>-design.md" — which violates the filename rules;
update both occurrences to use a plain slug (e.g.,
"docs/plans/YYYY-MM-DD-topic-design.md") and add the filename rules (use
lowercase a-z, 0-9, hyphens, no `<` or `>`) into the brainstorming skill
documentation in SKILL.md so users see the constraints; search for the pattern
"docs/plans/YYYY-MM-DD-<topic>-design.md" and replace it with
"docs/plans/YYYY-MM-DD-topic-design.md" and append or integrate the filename
rules paragraph near the skill instructions.
---
Nitpick comments:
In `@skills/writing-plans/SKILL.md`:
- Line 106: Replace the angle-bracket placeholder in the message template that
reads "**Plan complete and saved to `docs/plans/<filename>.md`. Two execution
options:**" with a non-angle form to avoid confusion with the rule banning `<`
and `>` in filenames; change `<filename>` to `[filename]` (or a similar
bracketed token) and adjust the surrounding text if needed to make clear it’s a
template variable in SKILL.md.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 56cc0e1e-3604-475e-831d-d9636b25d117
📒 Files selected for processing (1)
skills/writing-plans/SKILL.md
| Filename rules (to avoid tool/path errors across macOS/Linux/Windows): | ||
| - Replace `feature-name` with a real lowercase slug (e.g., `oauth-login`, `invoice-export`) | ||
| - Use only: `a-z`, `0-9`, and hyphens (`-`) | ||
| - Never leave placeholder characters like `<` `>` in the actual filename |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for filename patterns with angle brackets in brainstorming skill
rg -n -C3 'YYYY-MM-DD' skills/brainstorming/SKILL.mdRepository: obra/superpowers
Length of output: 797
Update brainstorming skill to match new filename rules.
The brainstorming skill still uses angle bracket placeholders in filename patterns (lines 30 and 81: docs/plans/YYYY-MM-DD-<topic>-design.md), which contradicts the new rule on line 23 that states "Never leave placeholder characters like < > in the actual filename." Users following the brainstorming skill could create files with invalid filenames and encounter tool errors.
Update both instances to use plain alphanumeric slugs (e.g., docs/plans/YYYY-MM-DD-topic-design.md) and add the filename rules to the brainstorming skill's documentation for consistency.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@skills/writing-plans/SKILL.md` around lines 20 - 23, The brainstorming skill
uses angle-bracket placeholders in filename patterns — specifically the pattern
"docs/plans/YYYY-MM-DD-<topic>-design.md" — which violates the filename rules;
update both occurrences to use a plain slug (e.g.,
"docs/plans/YYYY-MM-DD-topic-design.md") and add the filename rules (use
lowercase a-z, 0-9, hyphens, no `<` or `>`) into the brainstorming skill
documentation in SKILL.md so users see the constraints; search for the pattern
"docs/plans/YYYY-MM-DD-<topic>-design.md" and replace it with
"docs/plans/YYYY-MM-DD-topic-design.md" and append or integrate the filename
rules paragraph near the skill instructions.
Explicit slug rules: lowercase, hyphens, no angle brackets in plan filenames. Upstream PR: obra#635 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary
This targets intermittent "invalid argument passed to tool" failures when /superpowers:write-plan tries to save a plan using literal placeholder characters.
Closes #408