feat(skills): ship a consumer skill with the package - #11
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 |
…nce pointer Also note that group's mapper receives a staged Stream as its first parameter, whose staged methods travel too.
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/database-interface/SKILL.md) for the AQL interface and wires it for npm distribution by adding"docs"and"skills"to thefilesarray, along with anantelopeJs.skillspointer so the AntelopeJS Claude Code plugin can sync it automatically.skills/database-interface/SKILL.md: Adds an AI-consumable reference covering imports, a minimal end-to-end example, and a detailed gotchas section; import paths and example code have been validated againstsrc/(root re-exports, subpath-only types, andQueryasync-iteration behaviour all check out).package.json: Adds"docs"and"skills"to the publishedfileslist (thedocs/directory already exists and is explicitly cross-referenced by the skill) and adds theantelopeJs.skillsdistribution hook.Confidence Score: 5/5
Safe to merge — the change adds a documentation artifact and two package.json distribution entries with no runtime code paths affected.
The SKILL.md content was verified against src/index.ts, src/schema.ts, src/common.ts, src/query.ts, src/stream.ts, src/selection.ts, and src/valueproxy.ts. All root re-exports, subpath-exclusive types, the async-iteration behaviour of Query, and every method referenced in the example and gotchas section match the actual implementation.
No files require special attention.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[package.json\nfiles: dist, docs, skills\nantelopeJs.skills: ./skills] --> B[npm publish] B --> C[Published package\nincludes skills/ and docs/] C --> D[AntelopeJS Claude Code plugin\nsyncs skill to .claude/skills/] C --> E[cms-ai chatbox\nloads skill at runtime] D --> F[AI assistant reads\nskills/database-interface/SKILL.md] E --> F F --> G[Knows: imports, example,\ngotchas, docs/ pointer]%%{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[package.json\nfiles: dist, docs, skills\nantelopeJs.skills: ./skills] --> B[npm publish] B --> C[Published package\nincludes skills/ and docs/] C --> D[AntelopeJS Claude Code plugin\nsyncs skill to .claude/skills/] C --> E[cms-ai chatbox\nloads skill at runtime] D --> F[AI assistant reads\nskills/database-interface/SKILL.md] E --> F F --> G[Knows: imports, example,\ngotchas, docs/ pointer]Reviews (6): Last reviewed commit: "docs(skills): use fictional library doma..." | Re-trigger Greptile