Skip to content

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

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

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.md guide under skills/api-util-interface/ and wires it for distribution by adding "docs" and "skills" to the npm files array and "skills": ["./skills"] to the antelopeJs config in package.json.

  • skills/api-util-interface/SKILL.md documents all exported symbols (assert, assertValidation, RateLimit, RateLimitOptions, and the @internal helpers), with import paths, usage examples, and gotchas — content was verified against src/index.ts and src/rate-limit.ts and is accurate.
  • package.json now publishes both docs/ and skills/ alongside dist/, enabling the AntelopeJS Claude Code plugin to sync the skill into consumer projects and the cms-ai chatbox to load it at runtime.

Confidence Score: 5/5

Safe to merge — the change is purely additive: a new documentation file and two config entries in package.json.

All exported symbols, function signatures, decorator ordering rules, and gotchas in SKILL.md were cross-checked against src/index.ts and src/rate-limit.ts and are accurate. The package.json additions correctly wire the skills directory for distribution. No logic, runtime, or security concerns are introduced.

No files require special attention.

Important Files Changed

Filename Overview
package.json Adds "docs" and "skills" to the npm files array and registers the skills directory in the antelopeJs config; straightforward config change with no logic concerns.
skills/api-util-interface/SKILL.md New consumer skill guide; import paths, function signatures, decorator ordering rules, and gotchas all verified against src/index.ts and src/rate-limit.ts — content is accurate.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[npm publish] -->|includes dist + docs + skills| B[Published Package]
    B --> C[Consumer installs package]
    C --> D{Skill loader}
    D -->|AntelopeJS Claude Code plugin| E[Syncs to .claude/skills/api-util-interface/SKILL.md]
    D -->|cms-ai chatbox| F[Loads SKILL.md at runtime]
    E --> G[AI-assisted usage of assert / assertValidation / RateLimit]
    F --> G
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[npm publish] -->|includes dist + docs + skills| B[Published Package]
    B --> C[Consumer installs package]
    C --> D{Skill loader}
    D -->|AntelopeJS Claude Code plugin| E[Syncs to .claude/skills/api-util-interface/SKILL.md]
    D -->|cms-ai chatbox| F[Loads SKILL.md at runtime]
    E --> G[AI-assisted usage of assert / assertValidation / RateLimit]
    F --> G
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

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting
Upd4ting merged commit 55ca85e into main Jul 20, 2026
3 checks passed
@Upd4ting
Upd4ting deleted the feat/package-shipped-skill branch July 20, 2026 18:49
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