feat(skills): ship a consumer skill with the package - #20
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 |
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 document (
skills/data-api-interface/SKILL.md) alongside updates topackage.jsonthat publish thedocs/andskills/directories with the npm package and register the skills path in the AntelopeJS config.@Joined/@Computedsort/filter behavior). All import paths, exported symbols, and behavioral claims were cross-validated againstsrc/index.ts,src/metadata.ts, andsrc/components.ts."docs"and"skills"to thefilesarray so both are published to npm, and adds"skills": ["./skills"]to theantelopeJsconfig block for plugin-driven skill syncing.Confidence Score: 5/5
This PR is safe to merge — it adds a documentation artifact and updates packaging metadata with no changes to runtime code.
All exported symbols listed in the skill's import block were confirmed present in the respective source files. Behavioral descriptions — default/max list limit (10/100), 400 on unsortable sortKey, filter format, @Joined/@computed read-only enforcement — were traced to their implementations. The docs and skills directories existed in the repo prior to this PR; their addition to the npm files array simply makes them accessible to consumers of the published package.
No files require special attention.
Important Files Changed
docsandskillsto npmfilesarray and registers the skills directory in the AntelopeJS config; straightforward packaging change.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A["npm publish\n(package.json files array)"] --> B["dist/"] A --> C["docs/\n(now included)"] A --> D["skills/\n(now included)"] D --> E["data-api-interface/SKILL.md"] F["antelopeJs.skills\n./skills"] --> G["AntelopeJS Claude Code plugin\nsyncs to .claude/skills/"] F --> H["cms-ai chatbox\nloads at runtime"] E --> G E --> H%%{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\n(package.json files array)"] --> B["dist/"] A --> C["docs/\n(now included)"] A --> D["skills/\n(now included)"] D --> E["data-api-interface/SKILL.md"] F["antelopeJs.skills\n./skills"] --> G["AntelopeJS Claude Code plugin\nsyncs to .claude/skills/"] F --> H["cms-ai chatbox\nloads at runtime"] E --> G E --> HReviews (5): Last reviewed commit: "docs(skills): use fictional domains in c..." | Re-trigger Greptile