feat(skills): ship a consumer skill with the package - #5
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 |
Member
Author
|
@greptile review |
1 similar comment
Member
Author
|
@greptile review |
Member
Author
|
@greptile review |
1 similar comment
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/redis-interface/SKILL.md) alongside the package and wires it for distribution viaantelopeJs.skillsand the npmfilesarray. All claims in the skill document — import paths, API signatures (GetClient,internal.SetClient,internal.UnsetClient), and behavioral gotchas — were verified directly againstsrc/index.tsand are accurate.skills/redis-interface/SKILL.md: New guide covering consumer usage, provider lifecycle wiring, and gotchas (no-cache rule, pending-latch behaviour, pub/sub duplication, ownership ofquit()). Thevoid internal.UnsetClient()comment from the previous review thread has been addressed with a clear inline explanation.package.json: Adds"docs"and"skills"to the npmfilesarray and appends"skills": ["./skills"]to theantelopeJsfield. Note thatdocsis added silently alongsideskills— thedocs/directory exists in the repo and the SKILL.md references it, so this is coherent, though the PR description only calls outskills.Confidence Score: 5/5
Documentation-only addition; no runtime code is changed, and the new skill guide is factually accurate against the existing source.
Every import path, function signature, and behavioural claim in SKILL.md was cross-checked against
src/index.tsand the exports map — all correct. Thepackage.jsonchanges are additive (new entries infilesandantelopeJs) and do not affect build output or the published API surface.No files require special attention.
Important Files Changed
docsandskillsto the npmfilesarray and wiresantelopeJs.skillsto./skills; changes are correct and intentional.src/index.ts— all accurate. Prior thread onvoid UnsetClient()has been addressed with an inline comment.Sequence Diagram
%%{init: {'theme': 'neutral'}}%% sequenceDiagram participant Consumer as Consumer Module participant I as @antelopejs/interface-redis participant Provider as Provider Module (e.g. @antelopejs/redis) participant R as Redis Server Provider->>R: new Redis(options) Provider->>I: internal.SetClient(client) — resolves latch Consumer->>I: await GetClient() I-->>Consumer: Redis client (ioredis) Consumer->>R: client.set / client.get / etc. Note over Provider,I: On provider stop() Provider->>R: client.quit() Provider->>I: void internal.UnsetClient() — re-latches to new Promise Note over Consumer,I: Next GetClient() waits until next start()%%{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"}}}%% sequenceDiagram participant Consumer as Consumer Module participant I as @antelopejs/interface-redis participant Provider as Provider Module (e.g. @antelopejs/redis) participant R as Redis Server Provider->>R: new Redis(options) Provider->>I: internal.SetClient(client) — resolves latch Consumer->>I: await GetClient() I-->>Consumer: Redis client (ioredis) Consumer->>R: client.set / client.get / etc. Note over Provider,I: On provider stop() Provider->>R: client.quit() Provider->>I: void internal.UnsetClient() — re-latches to new Promise Note over Consumer,I: Next GetClient() waits until next start()Reviews (6): Last reviewed commit: "fix(skills): ship docs with the package ..." | Re-trigger Greptile