Skip to content

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

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

feat(skills): ship a consumer skill with the package#12
Upd4ting merged 5 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 guide (skills/database-decorators-interface/SKILL.md) alongside the package and wires it for distribution via the antelopeJs.skills config and the files array. All import paths in the skill were verified against the exports map in package.json, and all function/decorator signatures (BasicDataModel, GetModel, Model, RegisterSchema, testHash, localize) match the corresponding implementations in src/.

  • SKILL.md: Imports, minimal usage example, modifier section, and gotchas are all accurate; the previously flagged Model callback return type (InstanceId | undefined) has been corrected.
  • package.json: Adds skills (new) and docs (previously unpublished) to files, and registers ./skills under antelopeJs; the docs addition 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 to files and a config key), and the new SKILL.md is a consumer guide with no executable code. Every import path, decorator signature, and behavioural claim in the skill was cross-checked against src/ and found accurate. No logic is affected at runtime.

No files require special attention; the implicit docs addition to the published package is worth a quick confirmation of intent but is not a blocker.

Important Files Changed

Filename Overview
package.json Adds docs and skills to the published files array and wires ./skills into the antelopeJs config block; the docs directory exists in the repo so the path is valid.
skills/database-decorators-interface/SKILL.md New consumer-facing skill guide; all subpath imports validated against the exports map, function signatures (BasicDataModel, GetModel, Model, RegisterSchema, testHash, localize) match src/, and gotchas accurately reflect runtime behaviour.

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
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["@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
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).
Comment thread skills/database-decorators-interface/SKILL.md Outdated
@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

Copy link
Copy Markdown
Member Author

@greptile review

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