Skip to content

feat(skills): ship a consumer skill with the package - #5

Merged
Upd4ting merged 4 commits into
mainfrom
feat/package-shipped-skill
Jul 20, 2026
Merged

feat(skills): ship a consumer skill with the package#5
Upd4ting merged 4 commits into
mainfrom
feat/package-shipped-skill

Conversation

@Upd4ting

@Upd4ting Upd4ting commented Jul 19, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds skills/<name>-interface/SKILL.md: a lean, source-grounded consumer guide (imports per subpath, minimal example, gotchas, pointer to the shipped .d.ts)
  • Wires it for distribution: antelopeJs.skills: ["./skills"] + skills in the files array
  • Consumers get it automatically: the antelopejs Claude Code plugin syncs package-shipped skills into .claude/skills/; the cms-ai chatbox loads them at runtime
  • Content fact-checked against src//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 via antelopeJs.skills and the npm files array. All claims in the skill document — import paths, API signatures (GetClient, internal.SetClient, internal.UnsetClient), and behavioral gotchas — were verified directly against src/index.ts and 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 of quit()). The void internal.UnsetClient() comment from the previous review thread has been addressed with a clear inline explanation.
  • package.json: Adds "docs" and "skills" to the npm files array and appends "skills": ["./skills"] to the antelopeJs field. Note that docs is added silently alongside skills — the docs/ directory exists in the repo and the SKILL.md references it, so this is coherent, though the PR description only calls out skills.

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.ts and the exports map — all correct. The package.json changes are additive (new entries in files and antelopeJs) and do not affect build output or the published API surface.

No files require special attention.

Important Files Changed

Filename Overview
package.json Adds docs and skills to the npm files array and wires antelopeJs.skills to ./skills; changes are correct and intentional.
skills/redis-interface/SKILL.md New consumer skill guide; imports, API signatures, and gotchas verified against src/index.ts — all accurate. Prior thread on void 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()
Loading
%%{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()
Loading

Reviews (6): Last reviewed commit: "fix(skills): ship docs with the package ..." | Re-trigger Greptile

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).
Comment thread skills/redis-interface/SKILL.md
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

1 similar comment
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

1 similar comment
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting
Upd4ting merged commit c9b5067 into main Jul 20, 2026
2 checks passed
@Upd4ting
Upd4ting deleted the feat/package-shipped-skill branch July 20, 2026 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant