feat(skills): ship a consumer skill with the package - #4
Merged
Merged
Conversation
Add skills/<name>-interface/SKILL.md — a lean, source-grounded guide for agents consuming this interface (imports, minimal example, gotchas) — declared via antelopeJs.skills and published through the files array. Consumers receive it automatically: the antelopejs Claude Code plugin syncs package-shipped skills into a project's .claude/skills/, and the cms-ai chatbox loads them at runtime. Content was fact-checked against src/ and docs/ by an adversarial review pass (imports validated against the exports map, examples verified against real signatures).
Member
Author
|
@greptile review |
1 similar comment
Member
Author
|
@greptile review |
Member
Author
|
@greptile review |
Member
Author
|
@greptile review |
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.
Summary
skills/<name>-interface/SKILL.md: a lean, source-grounded consumer guide (imports per subpath, minimal example, gotchas, pointer to the shipped.d.ts)antelopeJs.skills: ["./skills"]+skillsin thefilesarray.claude/skills/; the cms-ai chatbox loads them at runtimesrc//docs/by an adversarial review pass (imports validated against the exports map, examples verified against real signatures)Test plan
N/A (documentation artifact; frontmatter and import paths validated mechanically)
Greptile Summary
This PR ships a consumer-facing
SKILL.mdguide underskills/api-util-interface/and wires it for distribution by adding"docs"and"skills"to the npmfilesarray and"skills": ["./skills"]to theantelopeJsconfig inpackage.json.skills/api-util-interface/SKILL.mddocuments all exported symbols (assert,assertValidation,RateLimit,RateLimitOptions, and the@internalhelpers), with import paths, usage examples, and gotchas — content was verified againstsrc/index.tsandsrc/rate-limit.tsand is accurate.package.jsonnow publishes bothdocs/andskills/alongsidedist/, enabling the AntelopeJS Claude Code plugin to sync the skill into consumer projects and the cms-ai chatbox to load it at runtime.Confidence Score: 5/5
Safe to merge — the change is purely additive: a new documentation file and two config entries in package.json.
All exported symbols, function signatures, decorator ordering rules, and gotchas in SKILL.md were cross-checked against src/index.ts and src/rate-limit.ts and are accurate. The package.json additions correctly wire the skills directory for distribution. No logic, runtime, or security concerns are introduced.
No files require special attention.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[npm publish] -->|includes dist + docs + skills| B[Published Package] B --> C[Consumer installs package] C --> D{Skill loader} D -->|AntelopeJS Claude Code plugin| E[Syncs to .claude/skills/api-util-interface/SKILL.md] D -->|cms-ai chatbox| F[Loads SKILL.md at runtime] E --> G[AI-assisted usage of assert / assertValidation / RateLimit] F --> G%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%% flowchart TD A[npm publish] -->|includes dist + docs + skills| B[Published Package] B --> C[Consumer installs package] C --> D{Skill loader} D -->|AntelopeJS Claude Code plugin| E[Syncs to .claude/skills/api-util-interface/SKILL.md] D -->|cms-ai chatbox| F[Loads SKILL.md at runtime] E --> G[AI-assisted usage of assert / assertValidation / RateLimit] F --> GReviews (5): Last reviewed commit: "docs(skills): use fictional domains in c..." | Re-trigger Greptile