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 |
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/stripe-interface/SKILL.md) alongside packaging updates that includedocsandskillsdirectories in the npm bundle and register the skills directory viaantelopeJs.skills. The SKILL.md content was verified againstsrc/index.tsand all function signatures, parameter descriptions, and behavioral gotchas are accurate.skills/stripe-interface/SKILL.md: New skill file covering imports, usage examples for all six exported functions, and a detailed gotchas section — all verified against the actual implementation.package.json: Addsdocsandskillsto thefilesarray (both directories exist) and registers"./skills"underantelopeJs.skillsfor automatic syncing by the AntelopeJS Claude Code plugin.Confidence Score: 5/5
Safe to merge — this is a documentation and packaging-only change with no runtime code modifications.
All function signatures, parameter types, behavioral descriptions, and gotchas in SKILL.md were verified against src/index.ts and match the implementation exactly. The WatchAllPayments example correctly addresses the prior review feedback by splitting into two clearly labelled, mutually exclusive alternatives. Both docs/ and skills/ directories exist in the repo, so adding them to the npm files array is sound. No logic changes were made.
No files require special attention.
Important Files Changed
Sequence Diagram
%%{init: {'theme': 'neutral'}}%% sequenceDiagram participant Consumer participant Interface as @antelopejs/interface-stripe participant Provider as Stripe Provider Module participant Stripe as Stripe API Provider->>Interface: SetClient(stripeInstance) Note over Interface: internal.client resolves Consumer->>Interface: InitializePayment(id, params) Interface->>Stripe: paymentIntents.create(params) Stripe-->>Interface: PaymentIntent Interface-->>Consumer: PaymentIntent Consumer->>Interface: WaitForPayment(intentId) Interface->>Stripe: paymentIntents.retrieve(intentId) Stripe-->>Interface: PaymentIntent (status check) Provider->>Interface: intentChanges.emit(intent, context) Note over Interface: Dispatches to WatchAllPayments,<br/>WatchPayment, WaitForPayment listeners Interface-->>Consumer: "resolved PaymentIntent (succeeded)<br/>or throws cancellation_reason (canceled)"%%{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 participant Interface as @antelopejs/interface-stripe participant Provider as Stripe Provider Module participant Stripe as Stripe API Provider->>Interface: SetClient(stripeInstance) Note over Interface: internal.client resolves Consumer->>Interface: InitializePayment(id, params) Interface->>Stripe: paymentIntents.create(params) Stripe-->>Interface: PaymentIntent Interface-->>Consumer: PaymentIntent Consumer->>Interface: WaitForPayment(intentId) Interface->>Stripe: paymentIntents.retrieve(intentId) Stripe-->>Interface: PaymentIntent (status check) Provider->>Interface: intentChanges.emit(intent, context) Note over Interface: Dispatches to WatchAllPayments,<br/>WatchPayment, WaitForPayment listeners Interface-->>Consumer: "resolved PaymentIntent (succeeded)<br/>or throws cancellation_reason (canceled)"Reviews (6): Last reviewed commit: "docs(skills): use fictional domain value..." | Re-trigger Greptile