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 |
1 similar comment
Member
Author
|
@greptile review |
…nce pointer Also note that under the test harness (test-stub mode) a missing provider rejects immediately instead of hanging.
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 guide (
skills/rethinkdb-interface/SKILL.md) alongside the package and wires it for distribution viaantelopeJs.skillsand thefilesarray.package.json: Addsdocsandskillsto the publishedfilesarray and registers./skillsunderantelopeJs.skillsso the AntelopeJS toolchain can pick up the skill automatically.skills/rethinkdb-interface/SKILL.md: Documents the two public exports (RunQueryandr), verified accurate againstsrc/index.ts— the import path, generic signatureRunQuery<T extends RQuery>(query, options?), andReturnType<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(filesandantelopeJs.skills). The new SKILL.md content was cross-checked againstsrc/index.tsand 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
docsandskillsto the publishedfilesarray and registers./skillsunderantelopeJs.skills. Both changes are minimal and correct.src/index.tsand the exports map inpackage.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%%{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 runReviews (5): Last reviewed commit: "docs(skills): use fictional domains in c..." | Re-trigger Greptile