feat(skills): ship a consumer skill with the package - #4
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 |
1 similar comment
Member
Author
|
@greptile review |
…otcha Queuing only holds while a provider module is loaded but not yet attached; when no loaded module provides the interface (stubbed optional dependency), the core neutralizes the async proxies and calls reject.
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 for
@antelopejs/interface-authand wires it for distribution by extending thefilesarray and adding askillskey to theantelopeJsconfig inpackage.json. The SKILL.md content was verified against the actual source (header/cookie names, export paths, decorator dispatch model all match).package.json: addsdocsandskillsto the npmfileslist —docswas previously unpublished, so this increases the installed footprint. TheantelopeJs.skillsfield points to./skillsso the AntelopeJS plugin can sync the guide automatically.skills/auth-interface/SKILL.md: new skill guide covering imports, a consuming example, a provider boilerplate, and a gotchas section; import paths and decorator behavior align withsrc/index.ts.Confidence Score: 5/5
Safe to merge — purely additive documentation and packaging changes with no logic modifications.
The change adds a skill guide and updates the npm
fileslist. No runtime code is touched. The SKILL.md claims (header/cookie names, export shape, decorator dispatch) were verified againstsrc/index.tsand all match.No files require special attention.
Important Files Changed
docsandskillsto the npmfilesarray and registers./skillsunderantelopeJs.skills; both additions are intentional and consistent with the PR goals.x-antelopejs-auth, cookie nameANTELOPEJS_AUTH, single root export, decorator dispatch) all verified againstsrc/index.ts.Sequence Diagram
%%{init: {'theme': 'neutral'}}%% sequenceDiagram participant Consumer as Consumer Module participant AntelopePlugin as AntelopeJS Plugin participant NPM as npm registry participant Claude as Claude Code / cms-ai Consumer->>NPM: "npm install @antelopejs/interface-auth" NPM-->>Consumer: dist/ + docs/ + skills/ AntelopePlugin->>Consumer: sync skills/auth-interface/SKILL.md AntelopePlugin-->>Claude: .claude/skills/auth-interface/SKILL.md Note over Claude: Skill loaded at runtime Consumer->>Consumer: "import { Authentication, SignRaw } from "@antelopejs/interface-auth"" Consumer->>Consumer: "@Authentication() injects verified payload" Consumer->>Consumer: SignRaw(payload, options) → proxy → auth provider → token%%{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 as Consumer Module participant AntelopePlugin as AntelopeJS Plugin participant NPM as npm registry participant Claude as Claude Code / cms-ai Consumer->>NPM: "npm install @antelopejs/interface-auth" NPM-->>Consumer: dist/ + docs/ + skills/ AntelopePlugin->>Consumer: sync skills/auth-interface/SKILL.md AntelopePlugin-->>Claude: .claude/skills/auth-interface/SKILL.md Note over Claude: Skill loaded at runtime Consumer->>Consumer: "import { Authentication, SignRaw } from "@antelopejs/interface-auth"" Consumer->>Consumer: "@Authentication() injects verified payload" Consumer->>Consumer: SignRaw(payload, options) → proxy → auth provider → tokenReviews (5): Last reviewed commit: "docs(skills): use fictional domains in c..." | Re-trigger Greptile