Skip to content

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

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

feat(skills): ship a consumer skill with the package#5
Upd4ting merged 3 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-facing skill guide (skills/rethinkdb-interface/SKILL.md) alongside the package and wires it for distribution via antelopeJs.skills and the files array.

  • package.json: Adds docs and skills to the published files array and registers ./skills under antelopeJs.skills so the AntelopeJS toolchain can pick up the skill automatically.
  • skills/rethinkdb-interface/SKILL.md: Documents the two public exports (RunQuery and r), verified accurate against src/index.ts — the import path, generic signature RunQuery<T extends RQuery>(query, options?), and ReturnType<T["run"]> return type all match the source exactly.

Confidence Score: 5/5

Safe to merge — adds only a documentation artifact and two packaging config lines, with no logic changes.

The only code changes are additive entries in package.json (files and antelopeJs.skills). The new SKILL.md content was cross-checked against src/index.ts and the exports map: import paths, generic signature, and return type are all accurate. No runtime behavior is touched.

No files require special attention.

Important Files Changed

Filename Overview
package.json Adds docs and skills to the published files array and registers ./skills under antelopeJs.skills. Both changes are minimal and correct.
skills/rethinkdb-interface/SKILL.md New consumer-facing skill guide; imports, function signatures, and return type all verified against src/index.ts and the exports map in package.json. Content is accurate.

Sequence Diagram

%%{init: {'theme': 'neutral'}}%%
sequenceDiagram
    participant Consumer as Consumer Module
    participant Pkg as @antelopejs/interface-rethinkdb
    participant Proxy as AsyncProxy (InterfaceFunction)
    participant Impl as Implementing Module

    Note over Pkg: Published with files[] + antelopeJs.skills
    Consumer->>Pkg: "import { RunQuery, r }"
    Consumer->>Consumer: r.table("books").get(id) — pure, no network
    Consumer->>Proxy: RunQuery(query, options?)
    Proxy->>Impl: routes to registered implementation
    Impl->>Impl: query.run(connection, options)
    Impl-->>Proxy: Promise result
    Proxy-->>Consumer: ReturnType T run
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 Pkg as @antelopejs/interface-rethinkdb
    participant Proxy as AsyncProxy (InterfaceFunction)
    participant Impl as Implementing Module

    Note over Pkg: Published with files[] + antelopeJs.skills
    Consumer->>Pkg: "import { RunQuery, r }"
    Consumer->>Consumer: r.table("books").get(id) — pure, no network
    Consumer->>Proxy: RunQuery(query, options?)
    Proxy->>Impl: routes to registered implementation
    Impl->>Impl: query.run(connection, options)
    Impl-->>Proxy: Promise result
    Proxy-->>Consumer: ReturnType T run
Loading

Reviews (5): Last reviewed commit: "docs(skills): use fictional domains in c..." | 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).
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

1 similar comment
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

…nce pointer

Also note that under the test harness (test-stub mode) a missing provider rejects immediately instead of hanging.
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting
Upd4ting merged commit 566184d into main Jul 20, 2026
3 checks passed
@Upd4ting
Upd4ting deleted the feat/package-shipped-skill branch July 20, 2026 19:52
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