fix(agents): parse frontmatter on the --- delimiter line, not any --- substring#3590
Merged
mnriem merged 1 commit intoJul 21, 2026
Merged
Conversation
… substring
CommandRegistrar.parse_frontmatter located the closing delimiter with
content.find("---", 3), a raw substring search. It stopped at the first
"---" anywhere after the opening — including one embedded in a
frontmatter value (e.g. a description "Separate sections with ---
markers") or inside an indented literal block — which truncated the
frontmatter and spilled the remainder into the body, silently corrupting
both the parsed metadata and the rendered command body.
Match the closing "---" on line boundaries, mirroring the line-anchored
scan already used by VibeIntegration._inject_frontmatter_flag.
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes YAML frontmatter parsing so only line-delimited --- closes the block.
Changes:
- Replaces substring matching with line-based delimiter detection.
- Adds regression coverage for
---inside a frontmatter value.
Show a summary per file
| File | Description |
|---|---|
src/specify_cli/agents.py |
Corrects closing-delimiter detection. |
tests/test_extensions.py |
Adds regression test for embedded dashes. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Medium
Collaborator
|
Thank you! |
mnriem
pushed a commit
that referenced
this pull request
Jul 23, 2026
…val (#3634) * fix(extensions): parse SKILL.md on the --- delimiter line during removal ExtensionManager._unregister_extension_skills verified an installed skill before deleting it by reading metadata.source back from its SKILL.md with a raw split("---", 2). That substring split stops at the first "---" anywhere after the opening delimiter, including one embedded in a command description (e.g. "Separate sections with --- markers"). The frontmatter was then truncated mid-value, metadata.source parsed empty, the skill looked unrelated, and its directory was left orphaned on uninstall. Parse on the "---" delimiter *line* instead, reusing CommandRegistrar. parse_frontmatter (the line-anchored parser from #3590) in both the fast (registry-driven) and fallback (directory-scan) removal paths. Add a regression test that installs an extension whose command description contains "---", removes it, and asserts the skill directory is gone. Fails before the fix (dir orphaned), passes after. * test: cover the fallback scan branch for the --- SKILL.md parse Copilot noted the new regression test only exercised the fast removal path (skills_project keeps ai_skills enabled, so remove() resolves the skills dir directly). Add test_skills_removed_with_dashes_via_fallback_scan, which deletes init-options.json after install so _get_skills_dir() returns None and removal takes the fallback directory-scan branch. That branch re-reads metadata.source with an independently duplicated parser; reverting it to the old substring split now fails this test (dir orphaned) while the fast-path test still passes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
CommandRegistrar.parse_frontmatterfinds the closing frontmatter delimiter withcontent.find("---", 3)— a raw substring search (src/specify_cli/agents.py). It stops at the first---anywhere after the opening, including one embedded in a frontmatter value or inside an indented YAML literal block, rather than a---that occupies its own line (the actual YAML document-separator).Any command source file whose frontmatter contains
---in a value gets a corrupted description and a corrupted body written into the generated agent files, silently:{'description': 'Separate sections with'}— description truncated,argument-hintsilently dropped, and the rest (markers\nargument-hint: ...\n---\n...) spills into the body.{'description': 'Separate sections with --- markers', 'argument-hint': '[name]'}and bodyReal body starts here.The sibling frontmatter handler in this codebase,
VibeIntegration._inject_frontmatter_flag(src/specify_cli/integrations/vibe/__init__.py), already scans for a line-anchored---;parse_frontmatterwas the only frontmatter reader using a substringfind. This change makes them consistent.parse_frontmatteris called before rendering every command into each agent's directory (register_commands, extensions, and preset/core commands), so the fix covers all of those paths.Testing
uv sync && uv run pytest—tests/test_extensions.py+tests/test_presets.py→ 724 passed; no regression.test_parse_frontmatter_dash_in_value(inTestParseFrontmatter), which fails onmain(assert 'Separate sections with' == '...--- markers') and passes with the fix.ruff check src/specify_cli/agents.py→ clean.AI Disclosure