quality: convert agent frontmatter tags to YAML block sequences to fix remark-lint reference rules - #170
Conversation
…x remark-lint reference rules
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
✅ Deploy Preview for adt-cli canceled.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (10)
📝 WalkthroughWalkthroughThe change reformats workflow and command ChangesMetadata Formatting
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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.
Summary
This PR correctly converts inline YAML arrays in frontmatter to block sequences to fix remark-lint-no-undefined-references and remark-lint-no-shortcut-reference-link alerts. The changes are well-scoped and accomplish the stated objective.
Changes reviewed:
- 9 markdown files with frontmatter converted from
tags: [...]to block sequence format .prettierignoreupdated to exclude these files from Prettier formatting
All changes function correctly and follow YAML syntax standards. The approach properly addresses the linting issues while preventing future formatting conflicts.
You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.
|
View your CI Pipeline Execution ↗ for commit fdcdcf6
💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗ ☁️ Nx Cloud last updated this comment at |
Up to standards ✅🟢 Issues
|
🤖 CodeAnt AI — Review Status
|
Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
MergerReady to Merge MERGE: low-risk frontmatter formatting-only change with no open discussions; the tags remain YAML lists and the affected files are excluded from Prettier reformatting. CI did not run, but this isolated metadata change has no evident blocker. Commit |
Summary
codacy-remark-linttreats the inline YAML arrays in workflow/command frontmatter as markdown shortcut-reference links, producingremark-lint-no-undefined-referencesandremark-lint-no-shortcut-reference-linkalerts.tags: [...]to unindented YAML block sequences in the 9 agent/claude frontmatter files. This keeps the parsedtagsvalue as a list while avoiding[/]link syntax forremark..prettierignoreso Prettier does not re-indent the list items and reintroducelist-item-bullet-indentfindings.Verified locally with
remark-cli(no-undefined-references, no-shortcut-reference-link, list-item-bullet-indent), Prettier--check, andnx format:check.Link to Devin session: https://app.devin.ai/sessions/754774d02df644c5894ee8b773029700
Requested by: @ThePlenkov
Summary by cubic
Fixes remark-lint reference rule violations by converting frontmatter
tagsfrom inline arrays to YAML block sequences in agent and Claude docs. Adds the edited files to.prettierignoresoPrettierwon’t re-indent the lists.tags: [a, b]with block sequences to satisfyremark-lint-no-undefined-referencesandremark-lint-no-shortcut-reference-link..prettierignoreto prevent reintroducinglist-item-bullet-indentfindings.Written for commit a4f9f21. Summary will update on new commits.
Summary by CodeRabbit