Repository navigation
feat: validate skill reference files - #318
Conversation
Check every Markdown file under a skill's references/ directory for frontmatter, a direct link from SKILL.md, and code examples that typecheck. Require a skill tree entry to list its skill's reference files, and check the list against the files.
🦋 Changeset detectedLatest commit: e937ff6 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 5 minutes. View limit detailsLimit details: You’ve used all 2 included reviews currently available. Review configuration: ⚙️ Run configuration
📒 Files selected for processing (10)
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 |
|
View your CI Pipeline Execution ↗ for commit 6a4e32b
☁️ Nx Cloud last updated this comment at |
commit: |
Merging this PR will degrade performance by 14.06%
Warning Please fix the performance issues or acknowledge them on CodSpeed. Performance Changes
Tip Investigate this regression by commenting Comparing |
…eferences # Conflicts: # packages/intent/src/commands/validate.ts # packages/intent/src/validate/blocks.ts
🎯 Changes
Intent's authoring guidance tells maintainers to move detail into
references/*.mdbeside aSKILL.md, butintent validatelooked only atSKILL.mdfiles. Reference files had no checks. TanStack Table moved 66 files into references and wrote its own script to check them.intent validatenow checks every Markdown file under a skill'sreferences/directory.For every skill that has reference files:
SKILL.md.intent loadreturns onlySKILL.md, so an agent finds a reference through that link. A reference may also link to another reference; that is never an error, and it does not replace the link fromSKILL.md.When the skill has an entry in
skill_tree.yaml:referenceskey. When the key is missing, the error prints the lines to add.references/<name>.mdinside the skill directory, appears once, exists on disk, and every reference file on disk is listed.A skill with no reference files needs nothing. A repository with no planning artifacts gets the file checks only.
Upgrade impact
An existing repository now fails
validatewhen a reference file has frontmatter, has no direct link fromSKILL.md, contains an example that does not typecheck, or is missing from its skill's tree entry. One of Intent's own meta skills needed a link added for the direct-link rule.