Skip to content

Commit 63d5cc8

Browse files
Kasper JungeRalphify
authored andcommitted
docs: add missing bug fixes to 0.2.4 changelog and troubleshooting
Add changelog entries for the ValueError wrapping fix (753eeef) and the empty args cwd detection fix (b5bb046). Add a troubleshooting entry for the new "invalid syntax" error message so users can find it. Co-authored-by: Ralphify <noreply@ralphify.co>
1 parent 753eeef commit 63d5cc8

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

docs/changelog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ All notable changes to ralphify are documented here.
2020
- **Indented `---` in YAML block scalars mistaken for closing frontmatter delimiter** — the frontmatter parser used `line.strip()` to detect the closing `---`, which caused indented `---` inside YAML block scalars (e.g. `notes: |` with ` ---` content) to be treated as the end of the frontmatter. Now only `---` at column 0 is recognized as the closing delimiter.
2121
- **Indented opening `---` delimiter accepted inconsistently** — the opening frontmatter delimiter check used `strip()` which accepted leading whitespace (e.g. ` ---`), while the closing delimiter required column 0. Both delimiters now require `---` at column 0 per the YAML frontmatter spec.
2222
- **Arg values with spaces breaking command execution** — when `{{ args.name }}` placeholders were substituted into command `run` strings, values containing spaces (e.g. `"hello world"`) were split into separate tokens by `shlex.split`, causing the wrong command to execute. Arg values are now shell-quoted before substitution so they are always treated as single tokens.
23+
- **Helpful error when command has invalid syntax** — when a command's `run` string has malformed shell syntax (e.g. unmatched quotes), the error now identifies which command failed and points to the `commands` field. Previously this surfaced as a bare `ValueError` like "No closing quotation" with no context.
24+
- **Empty arg values breaking `./` working directory detection** — when an `{{ args.name }}` placeholder resolved to an empty string, the substitution could introduce leading whitespace that prevented the `./` prefix from being detected, causing the command to run from the project root instead of the ralph directory.
2325

2426
### Improved
2527

docs/troubleshooting.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,16 @@ commands:
162162

163163
## Command issues
164164

165+
### "Command '...' has invalid syntax"
166+
167+
A command's `run` string has malformed shell syntax — usually an unmatched quote. The error message tells you which command failed:
168+
169+
```
170+
Command 'tests' has invalid syntax: 'uv run pytest -x "unclosed'. Check the 'commands' field in your RALPH.md frontmatter.
171+
```
172+
173+
Fix the quoting in the `run` value. If your command needs complex quoting, point it at a script instead — see [Command with pipes or redirections not working](#command-with-pipes-or-redirections-not-working).
174+
165175
### "Command '...' binary not found"
166176

167177
A command in your `commands` field references a binary that isn't installed or isn't on your PATH. The error message tells you which command failed:

0 commit comments

Comments
 (0)