feat(skills): ship a consumer skill with the package - #12
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 guide (
skills/database-decorators-interface/SKILL.md) alongside the package and wires it for distribution via theantelopeJs.skillsconfig and thefilesarray. All import paths in the skill were verified against theexportsmap inpackage.json, and all function/decorator signatures (BasicDataModel,GetModel,Model,RegisterSchema,testHash,localize) match the corresponding implementations insrc/.SKILL.md: Imports, minimal usage example, modifier section, and gotchas are all accurate; the previously flaggedModelcallback return type (InstanceId | undefined) has been corrected.package.json: Addsskills(new) anddocs(previously unpublished) tofiles, and registers./skillsunderantelopeJs; thedocsaddition is implicit from the skill's "deeper reference" pointer but not called out in the PR description.Confidence Score: 5/5
Safe to merge — the change is a documentation artifact with no runtime logic; all documented APIs match the current source.
The only code change is in
package.json(adding directories tofilesand a config key), and the newSKILL.mdis a consumer guide with no executable code. Every import path, decorator signature, and behavioural claim in the skill was cross-checked againstsrc/and found accurate. No logic is affected at runtime.No files require special attention; the implicit
docsaddition to the published package is worth a quick confirmation of intent but is not a blocker.Important Files Changed
docsandskillsto the publishedfilesarray and wires./skillsinto theantelopeJsconfig block; thedocsdirectory exists in the repo so the path is valid.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A["@RegisterTable(tableName, schemaName)\nclass MyTable extends Table"] --> B["@Field / @Index / @Fixture\n@Relation / modifier decorators"] B --> C["BasicDataModel(MyTable)"] C --> D["RegisterSchema(schemaName)\n(one-time startup)"] D -->|"provisions tables\nruns fixtures (if count===0)"| E["Schema + DB adapter"] C --> F["GetModel(MyModel, instanceId?)\n(cached per class + instanceId)"] F --> G["model.insert / .get / .getBy\n.getAll / .update / .delete"] G <--> E H["@Model(MyModel) in Controller\n(parameter or property decorator)"] --> F%%{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["@RegisterTable(tableName, schemaName)\nclass MyTable extends Table"] --> B["@Field / @Index / @Fixture\n@Relation / modifier decorators"] B --> C["BasicDataModel(MyTable)"] C --> D["RegisterSchema(schemaName)\n(one-time startup)"] D -->|"provisions tables\nruns fixtures (if count===0)"| E["Schema + DB adapter"] C --> F["GetModel(MyModel, instanceId?)\n(cached per class + instanceId)"] F --> G["model.insert / .get / .getBy\n.getAll / .update / .delete"] G <--> E H["@Model(MyModel) in Controller\n(parameter or property decorator)"] --> FReviews (5): Last reviewed commit: "docs(skills): use fictional domains in c..." | Re-trigger Greptile