feat(skills): ship a consumer skill with the package - #4
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 |
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 skill guide (
skills/mongodb-interface/SKILL.md) alongside the package and wires it for distribution by addingdocsandskillsto the npmfilesarray and registering the skills directory inantelopeJs.skills.SKILL.md: DocumentsGetClient(), theinternalprovider namespace (SetClient/UnsetClient/connected), key gotchas (pending-forever promise, don't cache the client, don't callclient.close()), and pointers todocs/1.introduction.mdanddist/index.d.ts— all cross-checked againstsrc/index.tsand the existing docs.package.json: Adds"docs"and"skills"tofiles, and sets"antelopeJs": { "skills": ["./skills"] }so the AntelopeJS Claude Code plugin can sync the skill automatically.Confidence Score: 5/5
Safe to merge — purely additive documentation and packaging changes with no logic modifications.
Every claim in SKILL.md was verified against
src/index.tsanddocs/1.introduction.md: exported symbols match, behavioural descriptions are accurate, and the docs/dist references are now valid because both directories are added to the npmfilesarray in the same commit. No existing behaviour is altered.No files require special attention.
Important Files Changed
docsandskillsto the npmfilesarray and registers./skillsin theantelopeJsskills manifest — both changes are consistent with distributing the new SKILL.md and making docs reachable from the referenced skill path.GetClient,internal.SetClient,internal.UnsetClient,internal.connected), behavioural gotchas, and the docs reference verified againstsrc/index.tsanddocs/1.introduction.md.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A["npm publish<br/>(@antelopejs/interface-mongodb)"] --> B["Package contents<br/>dist/ + docs/ + skills/"] B --> C["AntelopeJS Claude Code plugin<br/>(syncs package skills)"] B --> D["cms-ai chatbox<br/>(loads skills at runtime)"] C --> E[".claude/skills/mongodb-interface/SKILL.md"] D --> F["AI assistant context:<br/>GetClient usage, gotchas, provider lifecycle"] E --> F%%{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<br/>(@antelopejs/interface-mongodb)"] --> B["Package contents<br/>dist/ + docs/ + skills/"] B --> C["AntelopeJS Claude Code plugin<br/>(syncs package skills)"] B --> D["cms-ai chatbox<br/>(loads skills at runtime)"] C --> E[".claude/skills/mongodb-interface/SKILL.md"] D --> F["AI assistant context:<br/>GetClient usage, gotchas, provider lifecycle"] E --> FReviews (4): Last reviewed commit: "docs(skills): use fictional domains in c..." | Re-trigger Greptile