create-warlock 4.3.0 → 4.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +0 -2
- package/package.json +2 -2
- package/templates/warlock/AGENTS.md +101 -0
- package/templates/warlock/yarn.lock +16 -16
package/CHANGELOG.md
CHANGED
|
@@ -4,8 +4,6 @@ All notable changes to `create-warlock` are documented in this file.
|
|
|
4
4
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). `@warlock.js/*` packages are released in lockstep — every package shares the same version number, so a version below may list only the changes that affected this package.
|
|
6
6
|
|
|
7
|
-
## [Unreleased]
|
|
8
|
-
|
|
9
7
|
## 4.2.11
|
|
10
8
|
|
|
11
9
|
### Changed
|
package/package.json
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"dependencies": {
|
|
10
10
|
"@clack/prompts": "^0.7.0",
|
|
11
11
|
"@mongez/copper": "^2.1.2",
|
|
12
|
-
"@warlock.js/fs": "4.
|
|
12
|
+
"@warlock.js/fs": "4.4.0",
|
|
13
13
|
"@mongez/reinforcements": "^3.3.0",
|
|
14
14
|
"cross-spawn": "^7.0.3",
|
|
15
15
|
"rimraf": "^6.0.1",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"bin": {
|
|
19
19
|
"create-warlock": "bin/create-app.js"
|
|
20
20
|
},
|
|
21
|
-
"version": "4.
|
|
21
|
+
"version": "4.4.0",
|
|
22
22
|
"type": "module",
|
|
23
23
|
"main": "./esm/index.mjs",
|
|
24
24
|
"module": "./esm/index.mjs",
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# AGENTS.md
|
|
2
|
+
|
|
3
|
+
> This file is the single source of truth for instructions given to AI coding
|
|
4
|
+
> agents working in this project. Tool-specific files (`CLAUDE.md`,
|
|
5
|
+
> `.gemini/GEMINI.md`, `.github/copilot-instructions.md`, `CONVENTIONS.md`, …)
|
|
6
|
+
> are **derived** from this file by
|
|
7
|
+
> [agent-kit](https://github.com/hassanzohdy/agent-kit). Edit **this** file, then
|
|
8
|
+
> run `yarn skills:sync` (or `npx agent-kit sync`) to regenerate them — never edit
|
|
9
|
+
> the derived files directly.
|
|
10
|
+
|
|
11
|
+
## Project overview
|
|
12
|
+
|
|
13
|
+
This is a [Warlock.js](https://warlock.js.org) application — a TypeScript, Node.js
|
|
14
|
+
framework for building APIs. The framework and its companion libraries ship under
|
|
15
|
+
the `@warlock.js/*` scope (`core`, `cascade`, `cache`, `seal`, `auth`, `logger`,
|
|
16
|
+
`fs`, `scheduler`, …). Application code lives under `src/app/**`, organized one
|
|
17
|
+
module per domain noun.
|
|
18
|
+
|
|
19
|
+
## Skills come first — read them before anything else
|
|
20
|
+
|
|
21
|
+
**Before you work out how any package or framework feature works, read the
|
|
22
|
+
matching skill.** Skills are the authoritative, maintained source of truth for how
|
|
23
|
+
to use this project's packages and conventions. They are short and task-focused.
|
|
24
|
+
|
|
25
|
+
Whenever you need to know how to use a package (`@warlock.js/*`, `@mongez/*`) or
|
|
26
|
+
how to do a task (write a controller, define a model, add a migration, validate
|
|
27
|
+
input, cache, schedule a job, …), follow this order **strictly**:
|
|
28
|
+
|
|
29
|
+
1. **Read the relevant `SKILL.md` first.** Match the package name or the task to a
|
|
30
|
+
skill's `name` / `description` / triggers, load that skill, and follow it.
|
|
31
|
+
2. **Only if no skill matches**, fall back to the package's own
|
|
32
|
+
types / source / README under `node_modules/<pkg>`.
|
|
33
|
+
3. **The public internet is the last resort, not the first.** Do not web-search
|
|
34
|
+
for how a `@warlock.js/*` or `@mongez/*` API works while a skill for it exists —
|
|
35
|
+
the skill is more current and project-correct than anything online.
|
|
36
|
+
|
|
37
|
+
**Do not reverse-engineer how a package works by grepping for similar or existing
|
|
38
|
+
source files and copying their usage before you have checked the skills.** Existing
|
|
39
|
+
code can be outdated, mid-refactor, or simply wrong; the skill is the contract.
|
|
40
|
+
The rule is: **skill first, source second, web last.**
|
|
41
|
+
|
|
42
|
+
## Where skills live
|
|
43
|
+
|
|
44
|
+
- **Project conventions** — hand-authored skills in this repo's `skills/`
|
|
45
|
+
directory (architecture, code standards, API design, etc. — listed below).
|
|
46
|
+
- **Package skills** — how to use each installed `@warlock.js/*` / `@mongez/*`
|
|
47
|
+
package. These are synced from `node_modules` into your agent's skills
|
|
48
|
+
directory on every install (Claude Code → `.claude/skills/`, Cursor →
|
|
49
|
+
`.cursor/skills/`, GitHub Copilot → `.github/skills/`, Codex → `.codex/skills/`,
|
|
50
|
+
and the equivalent directory for other agents).
|
|
51
|
+
|
|
52
|
+
If a skill you expect is missing, run `yarn skills:sync` (it also runs
|
|
53
|
+
automatically on `postinstall`).
|
|
54
|
+
|
|
55
|
+
## Available project skills (`skills/`)
|
|
56
|
+
|
|
57
|
+
- **api-design** — HTTP conventions: response envelopes, status codes, pagination,
|
|
58
|
+
typed controllers, resources, and routes.
|
|
59
|
+
- **code-standards** — TypeScript style: `interface` (contracts) vs `type` (data),
|
|
60
|
+
access modifiers on every class member, no `any`, single-responsibility files
|
|
61
|
+
with the documented naming suffixes, JSDoc on the public surface.
|
|
62
|
+
- **data-and-persistence** — modeling, storing, and migrating data with
|
|
63
|
+
`@warlock.js/cascade` (money as integer minor units, migrations, indexes).
|
|
64
|
+
- **module-boundaries** — how modules under `src/app/**` relate; one domain noun
|
|
65
|
+
per module; what may import what.
|
|
66
|
+
- **security-baseline** — input validation at every boundary via `@warlock.js/seal`
|
|
67
|
+
schemas, authentication, and secrets handling.
|
|
68
|
+
- **observability-and-resilience** — structured logging, retries, timeouts, and
|
|
69
|
+
avoiding N+1 work.
|
|
70
|
+
- **testing-strategy** — Vitest test pyramid with co-located `*.spec.ts` files.
|
|
71
|
+
- **git-workflow** — conventional commits, branching, PRs, and CI gates.
|
|
72
|
+
|
|
73
|
+
## Commands
|
|
74
|
+
|
|
75
|
+
- `yarn dev` — start the dev server (`warlock dev`)
|
|
76
|
+
- `yarn build` — type-check then build for production (`tsc && warlock build`)
|
|
77
|
+
- `yarn start` — start the production server (`warlock start`)
|
|
78
|
+
- `yarn migrate` / `yarn migrate.fresh` / `yarn migrate.list` — run migrations
|
|
79
|
+
- `yarn seed` — run database seeders
|
|
80
|
+
- `yarn lint` / `yarn format` / `yarn tsc` — lint (eslint --fix), format
|
|
81
|
+
(prettier), and type-check (`tsc --noEmit`)
|
|
82
|
+
- `yarn skills:sync` — re-sync skills from `node_modules` and regenerate the
|
|
83
|
+
derived per-agent files from this `AGENTS.md`
|
|
84
|
+
|
|
85
|
+
## Code style
|
|
86
|
+
|
|
87
|
+
Follow the **code-standards** skill (`skills/code-standards/SKILL.md`) for all
|
|
88
|
+
TypeScript — read it before writing or reviewing any `.ts` / `.tsx`. In short:
|
|
89
|
+
`interface` for contracts and `type` for data shapes, no `any`, access modifiers
|
|
90
|
+
on every class member, single-responsibility files with the documented naming
|
|
91
|
+
suffixes, and JSDoc on the public surface. The bar is senior-level clean code, not
|
|
92
|
+
"it compiles."
|
|
93
|
+
|
|
94
|
+
## Boundaries
|
|
95
|
+
|
|
96
|
+
- Respect **module-boundaries** — do not reach across module internals.
|
|
97
|
+
- Never weaken the **security-baseline** — always validate input at boundaries.
|
|
98
|
+
- Follow **git-workflow** for commits and branches; do not commit or push unless
|
|
99
|
+
explicitly asked.
|
|
100
|
+
- When you are unsure how a package or feature works, **stop and read its skill**
|
|
101
|
+
rather than guessing from other files or the web.
|
|
@@ -1430,15 +1430,15 @@ foreground-child@^3.3.1:
|
|
|
1430
1430
|
signal-exit "^4.0.1"
|
|
1431
1431
|
|
|
1432
1432
|
form-data@^4.0.4:
|
|
1433
|
-
version "4.0.
|
|
1434
|
-
resolved "https://registry.yarnpkg.com/form-data/-/form-data-4.0.
|
|
1435
|
-
integrity sha512-
|
|
1433
|
+
version "4.0.6"
|
|
1434
|
+
resolved "https://registry.yarnpkg.com/form-data/-/form-data-4.0.6.tgz#28e864e1b786dbebb68db1f452f9635278665827"
|
|
1435
|
+
integrity sha512-vKatAh4SlVfgbv+YtmhiRjhEMJsYpsG1Y2rMQtR+SVSbytsSD1YGzDIcrAJmdFec88u/+VoGmxnl+80gL1tRCQ==
|
|
1436
1436
|
dependencies:
|
|
1437
1437
|
asynckit "^0.4.0"
|
|
1438
1438
|
combined-stream "^1.0.8"
|
|
1439
1439
|
es-set-tostringtag "^2.1.0"
|
|
1440
|
-
hasown "^2.0.
|
|
1441
|
-
mime-types "^2.1.
|
|
1440
|
+
hasown "^2.0.4"
|
|
1441
|
+
mime-types "^2.1.35"
|
|
1442
1442
|
|
|
1443
1443
|
fsevents@~2.3.3:
|
|
1444
1444
|
version "2.3.3"
|
|
@@ -1534,10 +1534,10 @@ has-tostringtag@^1.0.2:
|
|
|
1534
1534
|
dependencies:
|
|
1535
1535
|
has-symbols "^1.0.3"
|
|
1536
1536
|
|
|
1537
|
-
hasown@^2.0.2:
|
|
1538
|
-
version "2.0.
|
|
1539
|
-
resolved "https://registry.yarnpkg.com/hasown/-/hasown-2.0.
|
|
1540
|
-
integrity sha512-
|
|
1537
|
+
hasown@^2.0.2, hasown@^2.0.4:
|
|
1538
|
+
version "2.0.4"
|
|
1539
|
+
resolved "https://registry.yarnpkg.com/hasown/-/hasown-2.0.4.tgz#8c62d8cb90beb2aad5d0a5b67581ad9854c3f003"
|
|
1540
|
+
integrity sha512-T2UbfbBEF32wiepXIsMlTW9+dDYC6wMh/t/vYA4tuOMKqWz/n3vr1NFSxQiyP+zk2mXsoMA/i/7qV6LKut1t1A==
|
|
1541
1541
|
dependencies:
|
|
1542
1542
|
function-bind "^1.1.2"
|
|
1543
1543
|
|
|
@@ -1732,7 +1732,7 @@ mime-db@1.52.0:
|
|
|
1732
1732
|
resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70"
|
|
1733
1733
|
integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==
|
|
1734
1734
|
|
|
1735
|
-
mime-types@^2.1.
|
|
1735
|
+
mime-types@^2.1.35:
|
|
1736
1736
|
version "2.1.35"
|
|
1737
1737
|
resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.35.tgz#381a871b62a734450660ae3deee44813f70d959a"
|
|
1738
1738
|
integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==
|
|
@@ -2262,9 +2262,9 @@ undici-types@~7.16.0:
|
|
|
2262
2262
|
integrity sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw==
|
|
2263
2263
|
|
|
2264
2264
|
undici@^7.0.0:
|
|
2265
|
-
version "7.
|
|
2266
|
-
resolved "https://registry.yarnpkg.com/undici/-/undici-7.
|
|
2267
|
-
integrity sha512-
|
|
2265
|
+
version "7.28.0"
|
|
2266
|
+
resolved "https://registry.yarnpkg.com/undici/-/undici-7.28.0.tgz#97d64564198b285bc281f0e8e29597e3d11fe7ec"
|
|
2267
|
+
integrity sha512-cRZYrTDwWznlnRiPjggAGxZXanty6M8RV1ff8Wm4LWXBp7/IG8v5DnOm74DtUBp9OONpK75YlPnIjQqX0dBDtA==
|
|
2268
2268
|
|
|
2269
2269
|
uri-js@^4.2.2:
|
|
2270
2270
|
version "4.4.1"
|
|
@@ -2322,9 +2322,9 @@ wrappy@1:
|
|
|
2322
2322
|
integrity sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==
|
|
2323
2323
|
|
|
2324
2324
|
ws@^8.18.3:
|
|
2325
|
-
version "8.
|
|
2326
|
-
resolved "https://registry.yarnpkg.com/ws/-/ws-8.
|
|
2327
|
-
integrity sha512-
|
|
2325
|
+
version "8.21.0"
|
|
2326
|
+
resolved "https://registry.yarnpkg.com/ws/-/ws-8.21.0.tgz#012e413fc07429945121b0c153158c4343086951"
|
|
2327
|
+
integrity sha512-Vsp28b7DRcimFQvrqu2Wek3z1iYxDCWqHYB8Qsnk/S4RfaCQzPGPyBNuVjJV3cd6UiKtUtp6sNM77gWvzcCH+g==
|
|
2328
2328
|
|
|
2329
2329
|
yocto-queue@^0.1.0:
|
|
2330
2330
|
version "0.1.0"
|