create-warlock 4.2.11 → 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 +37 -39
- package/LICENSE +21 -21
- package/esm/features/features-map.mjs.map +1 -1
- package/package.json +2 -2
- package/templates/warlock/AGENTS.md +101 -0
- package/templates/warlock/yarn.lock +16 -16
package/CHANGELOG.md
CHANGED
|
@@ -1,39 +1,37 @@
|
|
|
1
|
-
# Changelog — create-warlock
|
|
2
|
-
|
|
3
|
-
All notable changes to `create-warlock` are documented in this file.
|
|
4
|
-
|
|
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
|
-
|
|
7
|
-
##
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
- Baseline — per-package changelog tracking starts at this version.
|
|
1
|
+
# Changelog — create-warlock
|
|
2
|
+
|
|
3
|
+
All notable changes to `create-warlock` are documented in this file.
|
|
4
|
+
|
|
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
|
+
|
|
7
|
+
## 4.2.11
|
|
8
|
+
|
|
9
|
+
### Changed
|
|
10
|
+
|
|
11
|
+
- Bumped `@mongez/reinforcements` to 3.3.0 (package dependency + project template)
|
|
12
|
+
|
|
13
|
+
## 4.2.10
|
|
14
|
+
|
|
15
|
+
### Changed
|
|
16
|
+
|
|
17
|
+
- The project template now pins the latest `@mongez/*` versions — `@mongez/reinforcements@^3.2.0` and `@mongez/agent-kit@^1.2.0` — so freshly scaffolded apps start on current dependencies. (`@warlock.js/*` versions in the template are still rewritten to the scaffolder's own version at install time.)
|
|
18
|
+
|
|
19
|
+
## 4.2.7
|
|
20
|
+
|
|
21
|
+
### Fixed
|
|
22
|
+
|
|
23
|
+
- The published package now ships its `templates/` folder, so scaffolding a new project works from the installed package — it was missing from the build, which made the wizard fail with "Something went wrong" at the template-copy step. The rest of the family is re-published at 4.2.7 to keep the lockstep version line; no other functional changes.
|
|
24
|
+
|
|
25
|
+
## 4.2.6
|
|
26
|
+
|
|
27
|
+
### Fixed
|
|
28
|
+
|
|
29
|
+
- The published package now ships its `bin` folder again, so the `create-warlock` CLI works from the installed package — it was omitted from the 4.2.5 build. The rest of the family is re-published at 4.2.6 to keep the lockstep version line; no other functional changes.
|
|
30
|
+
|
|
31
|
+
## 4.2.5
|
|
32
|
+
|
|
33
|
+
- The feature wizard now offers **Notifications** (`@warlock.js/notifications`) under "Jobs & Messaging" — opt-in; selecting it delegates to `warlock add notifications` (ejects config + scaffolds the in-app model/migration).
|
|
34
|
+
|
|
35
|
+
## 4.1.15
|
|
36
|
+
|
|
37
|
+
- Baseline — per-package changelog tracking starts at this version.
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) Hassan Zohdy
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) Hassan Zohdy
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"features-map.mjs","names":[],"sources":["../../../../../../@warlock.js/create-warlock/src/features/features-map.ts"],"sourcesContent":["/**\n * Presentation manifest for the scaffolder's feature prompts.\n *\n * This file is **display metadata only** — keys, labels, hints, grouping, and\n * default selections. It deliberately holds NO dependency names or versions:\n * the single source of truth for what each feature installs is the `add`\n * command's feature map in `@warlock.js/core`\n * (`src/generations/add-command.action.ts`). The scaffolder collects the\n * selections here and delegates the actual install to `warlock add`, so the\n * two never drift on versions again.\n *\n * Every `key` below MUST exist in core's `allowedFeatures`; a CI guard should\n * assert that subset relationship so a typo fails the build instead of shipping.\n */\n\nexport type FeatureGroup =\n | \"Auth & Access\"\n | \"Rendering & Mail\"\n | \"Media\"\n | \"Storage & Cache\"\n | \"Jobs & Messaging\"\n | \"Realtime\"\n | \"API Docs\"\n | \"Tooling\";\n\nexport type FeatureOption = {\n /** Must match a key in core's `add` feature map. */\n key: string;\n label: string;\n hint: string;\n group: FeatureGroup;\n defaultSelected?: boolean;\n};\n\n/**\n * Optional features offered in the general multiselect step. The database\n * driver (its own select) and AI providers (their own step) are intentionally\n * NOT here — they have dedicated prompts.\n */\nexport const features: FeatureOption[] = [\n // Auth & Access\n {\n key: \"access\",\n label: \"Access (authorization)\",\n hint: \"RBAC permission checks, ABAC policies, and roles — pairs with auth\",\n group: \"Auth & Access\",\n },\n\n // Rendering & Mail\n {\n key: \"react\",\n label: \"React (rendering & mails)\",\n hint: \"React + ReactDOM for non-interactive rendering and HTML/email generation\",\n group: \"Rendering & Mail\",\n defaultSelected: true,\n },\n {\n key: \"react-email\",\n label: \"React Email\",\n hint: \"Build email templates with React + Tailwind (pulls react + mail)\",\n group: \"Rendering & Mail\",\n },\n {\n key: \"mail\",\n label: \"Mail (Nodemailer)\",\n hint: \"Send emails via SMTP\",\n group: \"Rendering & Mail\",\n },\n {\n key: \"ses\",\n label: \"Amazon SES\",\n hint: \"Send emails via the AWS SES API\",\n group: \"Rendering & Mail\",\n },\n\n // Media\n {\n key: \"image\",\n label: \"Image processing (Sharp)\",\n hint: \"Resize, convert, and optimize images\",\n group: \"Media\",\n },\n\n // Storage & Cache\n {\n key: \"s3\",\n label: \"S3 storage\",\n hint: \"AWS S3 for cloud file storage\",\n group: \"Storage & Cache\",\n },\n {\n key: \"redis\",\n label: \"Redis cache\",\n hint: \"Redis driver for the cache layer\",\n group: \"Storage & Cache\",\n },\n\n // Jobs & Messaging\n {\n key: \"scheduler\",\n label: \"Scheduler\",\n hint: \"Background tasks and cron jobs\",\n group: \"Jobs & Messaging\",\n },\n {\n key: \"herald\",\n label: \"Herald (RabbitMQ)\",\n hint: \"Message broker for event-driven architecture\",\n group: \"Jobs & Messaging\",\n },\n {\n key: \"notifications\",\n label: \"Notifications\",\n hint: \"Multi-channel notifications — mail + in-app database, preferences, idempotency\",\n group: \"Jobs & Messaging\",\n },\n\n // Realtime\n {\n key: \"socket\",\n label: \"Socket.IO\",\n hint: \"Realtime websocket server\",\n group: \"Realtime\",\n },\n\n // API Docs (swagger / postman / openapi) — not shipped yet; they will arrive\n // together in the unified @warlock.js/api-docs package. Re-add the selection\n // once that package exists. (Removed so the wizard can't offer unbuilt features.)\n\n // Tooling\n {\n key: \"test\",\n label: \"Testing (Vitest)\",\n hint: \"Vitest + coverage + per-worker DB/cache test setup\",\n group: \"Tooling\",\n },\n];\n\nexport type AiProviderOption = {\n /** Must match a provider key in core's `add` feature map. */\n key: string;\n label: string;\n hint: string;\n};\n\n/**\n * AI providers offered in the dedicated AI step. Selecting any of these pulls\n * the core `@warlock.js/ai` package automatically via the provider's `requires`\n * in core's feature map — the scaffolder never lists `ai` as a standalone pick.\n */\nexport const aiProviders: AiProviderOption[] = [\n { key: \"openai\", label: \"OpenAI\", hint: \"GPT models via the OpenAI API\" },\n { key: \"google\", label: \"Google (Gemini)\", hint: \"Gemini models via Google AI\" },\n { key: \"anthropic\", label: \"Anthropic (Claude)\", hint: \"Claude models via the Anthropic API\" },\n { key: \"bedrock\", label: \"AWS Bedrock\", hint: \"Foundation models via Amazon Bedrock\" },\n { key: \"ollama\", label: \"Ollama\", hint: \"Local models via Ollama\" },\n];\n\n/**\n * Feature options for the multiselect prompt, ordered by group with the group\n * surfaced in the hint (keeps a flat list scannable without group widgets).\n */\nexport function getFeatureOptions() {\n return features.map(feature => ({\n value: feature.key,\n label: feature.label,\n hint: `${feature.group} — ${feature.hint}`,\n }));\n}\n\n/**\n * Keys pre-checked in the feature multiselect.\n */\nexport function getDefaultFeatureKeys(): string[] {\n return features.filter(feature => feature.defaultSelected).map(feature => feature.key);\n}\n\n/**\n * AI provider options for the dedicated AI multiselect step.\n */\nexport function getAiProviderOptions() {\n return aiProviders.map(provider => ({\n value: provider.key,\n label: provider.label,\n hint: provider.hint,\n }));\n}\n\n/**\n * Every selectable key the scaffolder knows about (features + AI providers).\n * Used to validate `--features` / `--ai` flags in non-interactive mode.\n */\nexport function getAllFeatureKeys(): string[] {\n return [...features.map(feature => feature.key), ...aiProviders.map(provider => provider.key)];\n}\n"],"mappings":";;;;;;AAuCA,MAAa,WAA4B;CAEvC;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAGA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;EACP,iBAAiB;CACnB;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAGA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAGA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAGA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAGA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAOA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;AACF;;;;;;AAcA,MAAa,cAAkC;CAC7C;EAAE,KAAK;EAAU,OAAO;EAAU,MAAM;CAAgC;CACxE;EAAE,KAAK;EAAU,OAAO;EAAmB,MAAM;CAA8B;CAC/E;EAAE,KAAK;EAAa,OAAO;EAAsB,MAAM;CAAsC;CAC7F;EAAE,KAAK;EAAW,OAAO;EAAe,MAAM;CAAuC;CACrF;EAAE,KAAK;EAAU,OAAO;EAAU,MAAM;CAA0B;AACpE;;;;;AAMA,SAAgB,oBAAoB;CAClC,OAAO,SAAS,KAAI,aAAY;EAC9B,OAAO,QAAQ;EACf,OAAO,QAAQ;EACf,MAAM,GAAG,QAAQ,MAAM,KAAK,QAAQ;CACtC,EAAE;AACJ;;;;AAKA,SAAgB,wBAAkC;CAChD,OAAO,SAAS,QAAO,YAAW,QAAQ,eAAe,CAAC,CAAC,KAAI,YAAW,QAAQ,GAAG;AACvF;;;;AAKA,SAAgB,uBAAuB;CACrC,OAAO,YAAY,KAAI,cAAa;EAClC,OAAO,SAAS;EAChB,OAAO,SAAS;EAChB,MAAM,SAAS;CACjB,EAAE;AACJ;;;;;AAMA,SAAgB,oBAA8B;CAC5C,OAAO,CAAC,GAAG,SAAS,KAAI,YAAW,QAAQ,GAAG,GAAG,GAAG,YAAY,KAAI,aAAY,SAAS,GAAG,CAAC;AAC/F"}
|
|
1
|
+
{"version":3,"file":"features-map.mjs","names":[],"sources":["../../../../../../@warlock.js/create-warlock/src/features/features-map.ts"],"sourcesContent":["/**\r\n * Presentation manifest for the scaffolder's feature prompts.\r\n *\r\n * This file is **display metadata only** — keys, labels, hints, grouping, and\r\n * default selections. It deliberately holds NO dependency names or versions:\r\n * the single source of truth for what each feature installs is the `add`\r\n * command's feature map in `@warlock.js/core`\r\n * (`src/generations/add-command.action.ts`). The scaffolder collects the\r\n * selections here and delegates the actual install to `warlock add`, so the\r\n * two never drift on versions again.\r\n *\r\n * Every `key` below MUST exist in core's `allowedFeatures`; a CI guard should\r\n * assert that subset relationship so a typo fails the build instead of shipping.\r\n */\r\n\r\nexport type FeatureGroup =\r\n | \"Auth & Access\"\r\n | \"Rendering & Mail\"\r\n | \"Media\"\r\n | \"Storage & Cache\"\r\n | \"Jobs & Messaging\"\r\n | \"Realtime\"\r\n | \"API Docs\"\r\n | \"Tooling\";\r\n\r\nexport type FeatureOption = {\r\n /** Must match a key in core's `add` feature map. */\r\n key: string;\r\n label: string;\r\n hint: string;\r\n group: FeatureGroup;\r\n defaultSelected?: boolean;\r\n};\r\n\r\n/**\r\n * Optional features offered in the general multiselect step. The database\r\n * driver (its own select) and AI providers (their own step) are intentionally\r\n * NOT here — they have dedicated prompts.\r\n */\r\nexport const features: FeatureOption[] = [\r\n // Auth & Access\r\n {\r\n key: \"access\",\r\n label: \"Access (authorization)\",\r\n hint: \"RBAC permission checks, ABAC policies, and roles — pairs with auth\",\r\n group: \"Auth & Access\",\r\n },\r\n\r\n // Rendering & Mail\r\n {\r\n key: \"react\",\r\n label: \"React (rendering & mails)\",\r\n hint: \"React + ReactDOM for non-interactive rendering and HTML/email generation\",\r\n group: \"Rendering & Mail\",\r\n defaultSelected: true,\r\n },\r\n {\r\n key: \"react-email\",\r\n label: \"React Email\",\r\n hint: \"Build email templates with React + Tailwind (pulls react + mail)\",\r\n group: \"Rendering & Mail\",\r\n },\r\n {\r\n key: \"mail\",\r\n label: \"Mail (Nodemailer)\",\r\n hint: \"Send emails via SMTP\",\r\n group: \"Rendering & Mail\",\r\n },\r\n {\r\n key: \"ses\",\r\n label: \"Amazon SES\",\r\n hint: \"Send emails via the AWS SES API\",\r\n group: \"Rendering & Mail\",\r\n },\r\n\r\n // Media\r\n {\r\n key: \"image\",\r\n label: \"Image processing (Sharp)\",\r\n hint: \"Resize, convert, and optimize images\",\r\n group: \"Media\",\r\n },\r\n\r\n // Storage & Cache\r\n {\r\n key: \"s3\",\r\n label: \"S3 storage\",\r\n hint: \"AWS S3 for cloud file storage\",\r\n group: \"Storage & Cache\",\r\n },\r\n {\r\n key: \"redis\",\r\n label: \"Redis cache\",\r\n hint: \"Redis driver for the cache layer\",\r\n group: \"Storage & Cache\",\r\n },\r\n\r\n // Jobs & Messaging\r\n {\r\n key: \"scheduler\",\r\n label: \"Scheduler\",\r\n hint: \"Background tasks and cron jobs\",\r\n group: \"Jobs & Messaging\",\r\n },\r\n {\r\n key: \"herald\",\r\n label: \"Herald (RabbitMQ)\",\r\n hint: \"Message broker for event-driven architecture\",\r\n group: \"Jobs & Messaging\",\r\n },\r\n {\r\n key: \"notifications\",\r\n label: \"Notifications\",\r\n hint: \"Multi-channel notifications — mail + in-app database, preferences, idempotency\",\r\n group: \"Jobs & Messaging\",\r\n },\r\n\r\n // Realtime\r\n {\r\n key: \"socket\",\r\n label: \"Socket.IO\",\r\n hint: \"Realtime websocket server\",\r\n group: \"Realtime\",\r\n },\r\n\r\n // API Docs (swagger / postman / openapi) — not shipped yet; they will arrive\r\n // together in the unified @warlock.js/api-docs package. Re-add the selection\r\n // once that package exists. (Removed so the wizard can't offer unbuilt features.)\r\n\r\n // Tooling\r\n {\r\n key: \"test\",\r\n label: \"Testing (Vitest)\",\r\n hint: \"Vitest + coverage + per-worker DB/cache test setup\",\r\n group: \"Tooling\",\r\n },\r\n];\r\n\r\nexport type AiProviderOption = {\r\n /** Must match a provider key in core's `add` feature map. */\r\n key: string;\r\n label: string;\r\n hint: string;\r\n};\r\n\r\n/**\r\n * AI providers offered in the dedicated AI step. Selecting any of these pulls\r\n * the core `@warlock.js/ai` package automatically via the provider's `requires`\r\n * in core's feature map — the scaffolder never lists `ai` as a standalone pick.\r\n */\r\nexport const aiProviders: AiProviderOption[] = [\r\n { key: \"openai\", label: \"OpenAI\", hint: \"GPT models via the OpenAI API\" },\r\n { key: \"google\", label: \"Google (Gemini)\", hint: \"Gemini models via Google AI\" },\r\n { key: \"anthropic\", label: \"Anthropic (Claude)\", hint: \"Claude models via the Anthropic API\" },\r\n { key: \"bedrock\", label: \"AWS Bedrock\", hint: \"Foundation models via Amazon Bedrock\" },\r\n { key: \"ollama\", label: \"Ollama\", hint: \"Local models via Ollama\" },\r\n];\r\n\r\n/**\r\n * Feature options for the multiselect prompt, ordered by group with the group\r\n * surfaced in the hint (keeps a flat list scannable without group widgets).\r\n */\r\nexport function getFeatureOptions() {\r\n return features.map(feature => ({\r\n value: feature.key,\r\n label: feature.label,\r\n hint: `${feature.group} — ${feature.hint}`,\r\n }));\r\n}\r\n\r\n/**\r\n * Keys pre-checked in the feature multiselect.\r\n */\r\nexport function getDefaultFeatureKeys(): string[] {\r\n return features.filter(feature => feature.defaultSelected).map(feature => feature.key);\r\n}\r\n\r\n/**\r\n * AI provider options for the dedicated AI multiselect step.\r\n */\r\nexport function getAiProviderOptions() {\r\n return aiProviders.map(provider => ({\r\n value: provider.key,\r\n label: provider.label,\r\n hint: provider.hint,\r\n }));\r\n}\r\n\r\n/**\r\n * Every selectable key the scaffolder knows about (features + AI providers).\r\n * Used to validate `--features` / `--ai` flags in non-interactive mode.\r\n */\r\nexport function getAllFeatureKeys(): string[] {\r\n return [...features.map(feature => feature.key), ...aiProviders.map(provider => provider.key)];\r\n}\r\n"],"mappings":";;;;;;AAuCA,MAAa,WAA4B;CAEvC;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAGA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;EACP,iBAAiB;CACnB;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAGA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAGA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAGA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CACA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAGA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;CAOA;EACE,KAAK;EACL,OAAO;EACP,MAAM;EACN,OAAO;CACT;AACF;;;;;;AAcA,MAAa,cAAkC;CAC7C;EAAE,KAAK;EAAU,OAAO;EAAU,MAAM;CAAgC;CACxE;EAAE,KAAK;EAAU,OAAO;EAAmB,MAAM;CAA8B;CAC/E;EAAE,KAAK;EAAa,OAAO;EAAsB,MAAM;CAAsC;CAC7F;EAAE,KAAK;EAAW,OAAO;EAAe,MAAM;CAAuC;CACrF;EAAE,KAAK;EAAU,OAAO;EAAU,MAAM;CAA0B;AACpE;;;;;AAMA,SAAgB,oBAAoB;CAClC,OAAO,SAAS,KAAI,aAAY;EAC9B,OAAO,QAAQ;EACf,OAAO,QAAQ;EACf,MAAM,GAAG,QAAQ,MAAM,KAAK,QAAQ;CACtC,EAAE;AACJ;;;;AAKA,SAAgB,wBAAkC;CAChD,OAAO,SAAS,QAAO,YAAW,QAAQ,eAAe,CAAC,CAAC,KAAI,YAAW,QAAQ,GAAG;AACvF;;;;AAKA,SAAgB,uBAAuB;CACrC,OAAO,YAAY,KAAI,cAAa;EAClC,OAAO,SAAS;EAChB,OAAO,SAAS;EAChB,MAAM,SAAS;CACjB,EAAE;AACJ;;;;;AAMA,SAAgB,oBAA8B;CAC5C,OAAO,CAAC,GAAG,SAAS,KAAI,YAAW,QAAQ,GAAG,GAAG,GAAG,YAAY,KAAI,aAAY,SAAS,GAAG,CAAC;AAC/F"}
|
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"
|