Use HEREDOC syntax for safe bead description handling#227
Conversation
When PRD content contains shell metacharacters (backticks, $variables, parentheses), the generated bash commands would fail with parse errors. Updates both ralph-tui-create-beads and ralph-tui-create-beads-rust skills to use HEREDOC syntax with single-quoted delimiter (<<'EOF') which prevents all shell expansion inside the description content. Fixes #151
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
WalkthroughUpdated documentation in two skill files for Ralph TUI bead creation tools to mandate HEREDOC syntax (<<'EOF') for multi-line descriptions in command examples. Added critical guidance emphasizing single-quoted delimiters to prevent shell interpretation of special characters. Changes are purely documentation-focused with no underlying logic modifications. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
…KyQs2 Use HEREDOC syntax for safe bead description handling
Summary
Updated bead creation documentation to use HEREDOC syntax (
<<'EOF') for the--descriptionparameter. This prevents shell interpretation of special characters (backticks,$variables, parentheses) that may appear in story descriptions and acceptance criteria.Changes
$(cat <<'EOF'...'EOF')pattern for all--descriptionparameters in bothbr create(Rust) andbd create(base) skill documentation<<'EOF'delimiter to prevent unintended shell expansionImplementation Details
<<'EOF'not<<"EOF") prevent variable and command substitutionWhy This Matters
Story descriptions often contain special characters like pipes (
|), parentheses, and backticks in acceptance criteria. Without HEREDOC syntax, these can cause shell interpretation errors or unexpected behavior. This change ensures robust bead creation regardless of description content.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.