Skip to content

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

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

feat(skills): ship a consumer skill with the package#11
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-facing skill guide (skills/database-interface/SKILL.md) for the AQL interface and wires it for npm distribution by adding "docs" and "skills" to the files array, along with an antelopeJs.skills pointer 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 against src/ (root re-exports, subpath-only types, and Query async-iteration behaviour all check out).
  • package.json: Adds "docs" and "skills" to the published files list (the docs/ directory already exists and is explicitly cross-referenced by the skill) and adds the antelopeJs.skills distribution 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

Filename Overview
skills/database-interface/SKILL.md New AI consumer skill guide; import references, example code, and gotchas all verified accurate against src/ — no factual errors found.
package.json Adds "docs" and "skills" to npm files list and wires the antelopeJs.skills distribution hook; both directories exist and the change is intentional.

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]
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"}}}%%
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]
Loading

Reviews (6): Last reviewed commit: "docs(skills): use fictional library doma..." | 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/database-interface/SKILL.md Outdated
Comment thread skills/database-interface/SKILL.md Outdated
@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

…nce pointer

Also note that group's mapper receives a staged Stream as its first parameter, whose staged methods travel too.
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

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