@warlock.js/core 5.2.3 → 5.2.4

package/esm/warlock-config/warlock-config.manager.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"warlock-config.manager.mjs","names":[],"sources":["../../../../../../../core/src/warlock-config/warlock-config.manager.ts"],"sourcesContent":["import { fileExistsAsync } from \"@warlock.js/fs\";\r\nimport { get } from \"@mongez/reinforcements\";\r\nimport { readFile, unlink, writeFile } from \"node:fs/promises\";\r\nimport { pathToFileURL } from \"url\";\r\nimport { rootPath } from \"../utils\";\r\nimport { type WarlockConfig } from \"./types\";\r\n\r\n/**\r\n * True when `error` is Node's \"this runtime can't import a `.ts` file\" error.\r\n *\r\n * Node only executes TypeScript natively from v22.18 / v23.6 onward (earlier\r\n * 22.x needs `--experimental-strip-types`). On older runtimes a bare\r\n * `import(\"warlock.config.ts\")` throws `ERR_UNKNOWN_FILE_EXTENSION` — which is\r\n * the signal to fall back to transpiling the config ourselves.\r\n */\r\nexport function isUnknownTsExtensionError(error: unknown): boolean {\r\n  return (\r\n    (error as { code?: string })?.code === \"ERR_UNKNOWN_FILE_EXTENSION\" ||\r\n    /Unknown file extension \"\\.tsx?\"/.test(String((error as Error)?.message))\r\n  );\r\n}\r\n\r\n/**\r\n * Warlock Config Manager\r\n *\r\n * Manages lazy loading of the pre-compiled warlock.config.js file\r\n * from the .warlock/cache directory.\r\n */\r\nexport class WarlockConfigManager {\r\n  /**\r\n   * Cached config instance\r\n   */\r\n  private config?: WarlockConfig;\r\n\r\n  /**\r\n   * Loading promise to prevent duplicate loads\r\n   */\r\n  private loading?: Promise<WarlockConfig | undefined>;\r\n\r\n  /**\r\n   * Load warlock.config.js (cached after first load)\r\n   *\r\n   * @returns The resolved Warlock configuration\r\n   */\r\n  public async load(): Promise<WarlockConfig | undefined> {\r\n    // Already loaded\r\n    if (this.config) {\r\n      return this.config;\r\n    }\r\n\r\n    // Currently loading (prevent duplicate loads)\r\n    if (this.loading) {\r\n      return this.loading;\r\n    }\r\n\r\n    // Start loading\r\n    this.loading = this.doLoad();\r\n    this.config = await this.loading;\r\n    this.loading = undefined;\r\n\r\n    return this.config;\r\n  }\r\n\r\n  /**\r\n   * Internal load implementation\r\n   *\r\n   * The ESM loader hook transpiles `warlock.config.ts` on import — no\r\n   * separate compile-to-disk step is needed.\r\n   */\r\n  private async doLoad(): Promise<WarlockConfig | undefined> {\r\n    const configPath = rootPath(\"warlock.config.ts\");\r\n\r\n    if (!(await fileExistsAsync(configPath))) {\r\n      // Written straight to the console, NOT through `@warlock.js/logger`.\r\n      // This runs during CLI bootstrap, before `LoggerConnector.start()` has\r\n      // configured a single channel, so a logger call here reaches nobody in\r\n      // any application — the warning would be silently dropped exactly when\r\n      // the user most needs it.\r\n      console.warn(\"warlock.config.ts is missing — run `warlock init` to create it\");\r\n      return;\r\n    }\r\n\r\n    try {\r\n      const configModule = await import(pathToFileURL(configPath).href);\r\n      return configModule.default;\r\n    } catch (error) {\r\n      // `dev` registers a TS loader hook, and Node ≥ 22.18 / 23.6 strips types\r\n      // natively — in both cases the direct import above works. But `build` /\r\n      // `start` register no hook, so on an older Node the import throws\r\n      // ERR_UNKNOWN_FILE_EXTENSION. Transpile the config with esbuild ourselves\r\n      // so config loading is Node-version-independent rather than relying on an\r\n      // experimental runtime feature.\r\n      if (isUnknownTsExtensionError(error)) {\r\n        return await this.loadViaEsbuild(configPath);\r\n      }\r\n\r\n      throw new Error(`Failed to load warlock.config.ts: ${error}`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Fallback config loader for runtimes without native TypeScript support.\r\n   *\r\n   * Transpiles `warlock.config.ts` with esbuild (already a core dependency),\r\n   * writes the result as a sibling `.mjs` — so the config's own imports (bare\r\n   * `@warlock.js/*` and any relative paths) resolve exactly as they would from\r\n   * the original location — imports it, then removes the temp file.\r\n   */\r\n  private async loadViaEsbuild(configPath: string): Promise<WarlockConfig | undefined> {\r\n    const { transformSync } = await import(\"esbuild\");\r\n    const source = await readFile(configPath, \"utf8\");\r\n\r\n    const { code } = transformSync(source, {\r\n      loader: \"ts\",\r\n      format: \"esm\",\r\n      target: `node${process.versions.node.split(\".\")[0]}`,\r\n      sourcefile: configPath,\r\n    });\r\n\r\n    // Unique sibling name so concurrent processes never clobber each other.\r\n    const compiledPath = configPath.replace(\r\n      /warlock\\.config\\.ts$/,\r\n      `.warlock.config.${process.pid}.mjs`,\r\n    );\r\n\r\n    await writeFile(compiledPath, code, \"utf8\");\r\n\r\n    try {\r\n      const configModule = await import(pathToFileURL(compiledPath).href);\r\n      return configModule.default;\r\n    } finally {\r\n      await unlink(compiledPath).catch(() => {});\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Get config value by key (dot notation supported)\r\n   *\r\n   * @example\r\n   * config.get(\"server.port\") // Returns 3000\r\n   * config.get(\"cli.commands\") // Returns array of commands\r\n   *\r\n   * @param key - Config key (supports dot notation), autocompletes for first level only\r\n   * @returns The config value\r\n   * @throws Error if config is not loaded\r\n   */\r\n  public get<Key extends keyof WarlockConfig>(\r\n    key: Key,\r\n    defaultValue?: WarlockConfig[Key],\r\n  ): WarlockConfig[Key] {\r\n    if (!this.config) {\r\n      throw new Error(\"WarlockConfig not loaded. Call load() first or use lazyGet().\");\r\n    }\r\n\r\n    return get(this.config, key as string, defaultValue);\r\n  }\r\n\r\n  /**\r\n   * Lazy get - loads config if not already loaded\r\n   *\r\n   * @example\r\n   * const port = await config.lazyGet(\"server\");\r\n   *\r\n   * @param key - Config key (supports dot notation), autocompletes for first level only\r\n   * @param defaultValue - Default value if config key is undefined\r\n   * @returns The config value\r\n   */\r\n  async lazyGet<Key extends keyof WarlockConfig>(\r\n    key: Key,\r\n    defaultValue?: WarlockConfig[Key],\r\n  ): Promise<WarlockConfig[Key]> {\r\n    await this.load();\r\n    return this.get(key, defaultValue);\r\n  }\r\n\r\n  /**\r\n   * Check if config is loaded\r\n   */\r\n  public get isLoaded(): boolean {\r\n    return this.config !== undefined;\r\n  }\r\n\r\n  /**\r\n   * Get the entire config object\r\n   *\r\n   * @throws Error if config is not loaded\r\n   */\r\n  public getAll(): WarlockConfig {\r\n    if (!this.config) {\r\n      throw new Error(\"WarlockConfig not loaded. Call load() first or use lazyGet().\");\r\n    }\r\n\r\n    return this.config;\r\n  }\r\n\r\n  /**\r\n   * Reload config (useful for HMR/development)\r\n   */\r\n  public async reload(): Promise<void> {\r\n    this.config = undefined;\r\n    this.loading = undefined;\r\n    await this.load();\r\n  }\r\n}\r\n\r\n/**\r\n * Exported singleton instance\r\n *\r\n * @example\r\n * import { warlockConfig } from \"@warlock.js/core\";\r\n *\r\n * // Lazy load and get value\r\n * const port = await warlockConfig.lazyGet(\"server.port\");\r\n *\r\n * // Or load first, then get\r\n * await warlockConfig.load();\r\n * const commands = warlockConfig.get(\"cli.commands\");\r\n */\r\nexport const warlockConfigManager = new WarlockConfigManager();\r\n"],"mappings":";;;;;;;;;;;;;;;;AAeA,SAAgB,0BAA0B,OAAyB;CACjE,OACG,OAA6B,SAAS,gCACvC,kCAAkC,KAAK,OAAQ,OAAiB,OAAO,CAAC;AAE5E;;;;;;;AAQA,IAAa,uBAAb,MAAkC;;;;;;CAgBhC,MAAa,OAA2C;EAEtD,IAAI,KAAK,QACP,OAAO,KAAK;EAId,IAAI,KAAK,SACP,OAAO,KAAK;EAId,KAAK,UAAU,KAAK,OAAO;EAC3B,KAAK,SAAS,MAAM,KAAK;EACzB,KAAK,UAAU;EAEf,OAAO,KAAK;CACd;;;;;;;CAQA,MAAc,SAA6C;EACzD,MAAM,aAAa,SAAS,mBAAmB;EAE/C,IAAI,CAAE,MAAM,gBAAgB,UAAU,GAAI;GAMxC,QAAQ,KAAK,gEAAgE;GAC7E;EACF;EAEA,IAAI;GAEF,QAAO,MADoB,OAAO,cAAc,UAAU,EAAE,OACxC;EACtB,SAAS,OAAO;GAOd,IAAI,0BAA0B,KAAK,GACjC,OAAO,MAAM,KAAK,eAAe,UAAU;GAG7C,MAAM,IAAI,MAAM,qCAAqC,OAAO;EAC9D;CACF;;;;;;;;;CAUA,MAAc,eAAe,YAAwD;EACnF,MAAM,EAAE,kBAAkB,MAAM,OAAO;EAGvC,MAAM,EAAE,SAAS,cAAc,MAFV,SAAS,YAAY,MAAM,GAET;GACrC,QAAQ;GACR,QAAQ;GACR,QAAQ,OAAO,QAAQ,SAAS,KAAK,MAAM,GAAG,EAAE;GAChD,YAAY;EACd,CAAC;EAGD,MAAM,eAAe,WAAW,QAC9B,wBACA,mBAAmB,QAAQ,IAAI,KACjC;EAEA,MAAM,UAAU,cAAc,MAAM,MAAM;EAE1C,IAAI;GAEF,QAAO,MADoB,OAAO,cAAc,YAAY,EAAE,OAC1C;EACtB,UAAU;GACR,MAAM,OAAO,YAAY,EAAE,YAAY,CAAC,CAAC;EAC3C;CACF;;;;;;;;;;;;CAaA,AAAO,IACL,KACA,cACoB;EACpB,IAAI,CAAC,KAAK,QACR,MAAM,IAAI,MAAM,+DAA+D;EAGjF,OAAO,IAAI,KAAK,QAAQ,KAAe,YAAY;CACrD;;;;;;;;;;;CAYA,MAAM,QACJ,KACA,cAC6B;EAC7B,MAAM,KAAK,KAAK;EAChB,OAAO,KAAK,IAAI,KAAK,YAAY;CACnC;;;;CAKA,IAAW,WAAoB;EAC7B,OAAO,KAAK,WAAW;CACzB;;;;;;CAOA,AAAO,SAAwB;EAC7B,IAAI,CAAC,KAAK,QACR,MAAM,IAAI,MAAM,+DAA+D;EAGjF,OAAO,KAAK;CACd;;;;CAKA,MAAa,SAAwB;EACnC,KAAK,SAAS;EACd,KAAK,UAAU;EACf,MAAM,KAAK,KAAK;CAClB;AACF;;;;;;;;;;;;;;AAeA,MAAa,uBAAuB,IAAI,qBAAqB"}
+{"version":3,"file":"warlock-config.manager.mjs","names":[],"sources":["../../../../../../../core/src/warlock-config/warlock-config.manager.ts"],"sourcesContent":["import { fileExistsAsync } from \"@warlock.js/fs\";\r\nimport { get } from \"@mongez/reinforcements\";\r\nimport { readFile, unlink, writeFile } from \"node:fs/promises\";\r\nimport { pathToFileURL } from \"url\";\r\nimport { rootPath } from \"../utils\";\r\nimport { type WarlockConfig } from \"./types\";\r\n\r\n/**\r\n * True when `error` is Node's \"this runtime can't import a `.ts` file\" error.\r\n *\r\n * Node only executes TypeScript natively from v22.18 / v23.6 onward (earlier\r\n * 22.x needs `--experimental-strip-types`). On older runtimes a bare\r\n * `import(\"warlock.config.ts\")` throws `ERR_UNKNOWN_FILE_EXTENSION` — which is\r\n * the signal to fall back to transpiling the config ourselves.\r\n */\r\nexport function isUnknownTsExtensionError(error: unknown): boolean {\r\n  return (\r\n    (error as { code?: string })?.code === \"ERR_UNKNOWN_FILE_EXTENSION\" ||\r\n    /Unknown file extension \"\\.tsx?\"/.test(String((error as Error)?.message))\r\n  );\r\n}\r\n\r\n/**\r\n * Warlock Config Manager\r\n *\r\n * Manages lazy loading of the pre-compiled warlock.config.js file\r\n * from the .warlock/cache directory.\r\n */\r\nexport class WarlockConfigManager {\r\n  /**\r\n   * Cached config instance\r\n   */\r\n  private config?: WarlockConfig;\r\n\r\n  /**\r\n   * Loading promise to prevent duplicate loads\r\n   */\r\n  private loading?: Promise<WarlockConfig | undefined>;\r\n\r\n  /**\r\n   * Load warlock.config.js (cached after first load)\r\n   *\r\n   * @returns The resolved Warlock configuration\r\n   */\r\n  public async load(): Promise<WarlockConfig | undefined> {\r\n    // Already loaded\r\n    if (this.config) {\r\n      return this.config;\r\n    }\r\n\r\n    // Currently loading (prevent duplicate loads)\r\n    if (this.loading) {\r\n      return this.loading;\r\n    }\r\n\r\n    // Start loading\r\n    this.loading = this.doLoad();\r\n    this.config = await this.loading;\r\n    this.loading = undefined;\r\n\r\n    return this.config;\r\n  }\r\n\r\n  /**\r\n   * Internal load implementation\r\n   *\r\n   * The ESM loader hook transpiles `warlock.config.ts` on import — no\r\n   * separate compile-to-disk step is needed.\r\n   */\r\n  private async doLoad(): Promise<WarlockConfig | undefined> {\r\n    const configPath = rootPath(\"warlock.config.ts\");\r\n\r\n    if (!(await fileExistsAsync(configPath))) {\r\n      // Written straight to the console, NOT through `@warlock.js/logger`.\r\n      // This runs during CLI bootstrap, before `LoggerConnector.start()` has\r\n      // configured a single channel, so a logger call here reaches nobody in\r\n      // any application — the warning would be silently dropped exactly when\r\n      // the user most needs it.\r\n      console.warn(\"warlock.config.ts is missing — run `warlock init` to create it\");\r\n      return;\r\n    }\r\n\r\n    try {\r\n      const configModule = await import(pathToFileURL(configPath).href);\r\n      return configModule.default;\r\n    } catch (error) {\r\n      // `dev` registers a TS loader hook, and Node ≥ 22.18 / 23.6 strips types\r\n      // natively — in both cases the direct import above works. But `build` /\r\n      // `start` register no hook, so on an older Node the import throws\r\n      // ERR_UNKNOWN_FILE_EXTENSION. Transpile the config with esbuild ourselves\r\n      // so config loading is Node-version-independent rather than relying on an\r\n      // experimental runtime feature.\r\n      if (isUnknownTsExtensionError(error)) {\r\n        return await this.loadViaEsbuild(configPath);\r\n      }\r\n\r\n      throw new Error(`Failed to load warlock.config.ts: ${error}`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Fallback config loader for runtimes without native TypeScript support.\r\n   *\r\n   * Transpiles `warlock.config.ts` with esbuild (already a core dependency),\r\n   * writes the result as a sibling `.mjs` — so the config's own imports (bare\r\n   * `@warlock.js/*` and any relative paths) resolve exactly as they would from\r\n   * the original location — imports it, then removes the temp file.\r\n   */\r\n  private async loadViaEsbuild(configPath: string): Promise<WarlockConfig | undefined> {\r\n    const { transformSync } = await import(\"esbuild\");\r\n    const source = await readFile(configPath, \"utf8\");\r\n\r\n    const { code } = transformSync(source, {\r\n      loader: \"ts\",\r\n      format: \"esm\",\r\n      target: `node${process.versions.node.split(\".\")[0]}`,\r\n      sourcefile: configPath,\r\n    });\r\n\r\n    // Unique sibling name so concurrent processes never clobber each other.\r\n    const compiledPath = configPath.replace(\r\n      /warlock\\.config\\.ts$/,\r\n      `.warlock.config.${process.pid}.mjs`,\r\n    );\r\n\r\n    await writeFile(compiledPath, code, \"utf8\");\r\n\r\n    try {\r\n      const configModule = await import(pathToFileURL(compiledPath).href);\r\n      return configModule.default;\r\n    } finally {\r\n      await unlink(compiledPath).catch(() => {});\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Get config value by key (dot notation supported)\r\n   *\r\n   * @example\r\n   * config.get(\"server.port\") // Returns 3000\r\n   * config.get(\"cli.commands\") // Returns array of commands\r\n   *\r\n   * @param key - Config key (supports dot notation), autocompletes for first level only\r\n   * @returns The config value\r\n   * @throws Error if config is not loaded\r\n   */\r\n  public get<Key extends keyof WarlockConfig>(\r\n    key: Key,\r\n    defaultValue?: WarlockConfig[Key],\r\n  ): WarlockConfig[Key] {\r\n    if (!this.config) {\r\n      throw new Error(\"WarlockConfig not loaded. Call load() first or use lazyGet().\");\r\n    }\r\n\r\n    return get(this.config, key as string, defaultValue);\r\n  }\r\n\r\n  /**\r\n   * Lazy get - loads config if not already loaded\r\n   *\r\n   * @example\r\n   * const port = await config.lazyGet(\"server\");\r\n   *\r\n   * @param key - Config key (supports dot notation), autocompletes for first level only\r\n   * @param defaultValue - Default value if config key is undefined\r\n   * @returns The config value\r\n   */\r\n  async lazyGet<Key extends keyof WarlockConfig>(\r\n    key: Key,\r\n    defaultValue?: WarlockConfig[Key],\r\n  ): Promise<WarlockConfig[Key]> {\r\n    await this.load();\r\n    return this.get(key, defaultValue);\r\n  }\r\n\r\n  /**\r\n   * Check if config is loaded\r\n   */\r\n  public get isLoaded(): boolean {\r\n    return this.config !== undefined;\r\n  }\r\n\r\n  /**\r\n   * Get the entire config object\r\n   *\r\n   * @throws Error if config is not loaded\r\n   */\r\n  public getAll(): WarlockConfig {\r\n    if (!this.config) {\r\n      throw new Error(\"WarlockConfig not loaded. Call load() first or use lazyGet().\");\r\n    }\r\n\r\n    return this.config;\r\n  }\r\n\r\n  /**\r\n   * Reload config (useful for HMR/development)\r\n   */\r\n  public async reload(): Promise<void> {\r\n    this.config = undefined;\r\n    this.loading = undefined;\r\n    await this.load();\r\n  }\r\n}\r\n\r\n/**\r\n * Exported singleton instance\r\n *\r\n * @example\r\n * import { warlockConfig } from \"@warlock.js/core\";\r\n *\r\n * // Lazy load and get value\r\n * const port = await warlockConfig.lazyGet(\"server.port\");\r\n *\r\n * // Or load first, then get\r\n * await warlockConfig.load();\r\n * const commands = warlockConfig.get(\"cli.commands\");\r\n */\r\nexport const warlockConfigManager = new WarlockConfigManager();\r\n"],"mappings":";;;;;;;;;;;;;;;;AAeA,SAAgB,0BAA0B,OAAyB;CACjE,OACG,OAA6B,SAAS,gCACvC,kCAAkC,KAAK,OAAQ,OAAiB,OAAO,CAAC;AAE5E;;;;;;;AAQA,IAAa,uBAAb,MAAkC;;;;;;CAgBhC,MAAa,OAA2C;EAEtD,IAAI,KAAK,QACP,OAAO,KAAK;EAId,IAAI,KAAK,SACP,OAAO,KAAK;EAId,KAAK,UAAU,KAAK,OAAO;EAC3B,KAAK,SAAS,MAAM,KAAK;EACzB,KAAK,UAAU;EAEf,OAAO,KAAK;CACd;;;;;;;CAQA,MAAc,SAA6C;EACzD,MAAM,aAAa,SAAS,mBAAmB;EAE/C,IAAI,CAAE,MAAM,gBAAgB,UAAU,GAAI;GAMxC,QAAQ,KAAK,gEAAgE;GAC7E;EACF;EAEA,IAAI;GAEF,QAAO,MADoB,OAAO,cAAc,UAAU,CAAC,CAAC,MACzC,CAAC;EACtB,SAAS,OAAO;GAOd,IAAI,0BAA0B,KAAK,GACjC,OAAO,MAAM,KAAK,eAAe,UAAU;GAG7C,MAAM,IAAI,MAAM,qCAAqC,OAAO;EAC9D;CACF;;;;;;;;;CAUA,MAAc,eAAe,YAAwD;EACnF,MAAM,EAAE,kBAAkB,MAAM,OAAO;EAGvC,MAAM,EAAE,SAAS,cAAc,MAFV,SAAS,YAAY,MAAM,GAET;GACrC,QAAQ;GACR,QAAQ;GACR,QAAQ,OAAO,QAAQ,SAAS,KAAK,MAAM,GAAG,CAAC,CAAC;GAChD,YAAY;EACd,CAAC;EAGD,MAAM,eAAe,WAAW,QAC9B,wBACA,mBAAmB,QAAQ,IAAI,KACjC;EAEA,MAAM,UAAU,cAAc,MAAM,MAAM;EAE1C,IAAI;GAEF,QAAO,MADoB,OAAO,cAAc,YAAY,CAAC,CAAC,MAC3C,CAAC;EACtB,UAAU;GACR,MAAM,OAAO,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC;EAC3C;CACF;;;;;;;;;;;;CAaA,AAAO,IACL,KACA,cACoB;EACpB,IAAI,CAAC,KAAK,QACR,MAAM,IAAI,MAAM,+DAA+D;EAGjF,OAAO,IAAI,KAAK,QAAQ,KAAe,YAAY;CACrD;;;;;;;;;;;CAYA,MAAM,QACJ,KACA,cAC6B;EAC7B,MAAM,KAAK,KAAK;EAChB,OAAO,KAAK,IAAI,KAAK,YAAY;CACnC;;;;CAKA,IAAW,WAAoB;EAC7B,OAAO,KAAK,WAAW;CACzB;;;;;;CAOA,AAAO,SAAwB;EAC7B,IAAI,CAAC,KAAK,QACR,MAAM,IAAI,MAAM,+DAA+D;EAGjF,OAAO,KAAK;CACd;;;;CAKA,MAAa,SAAwB;EACnC,KAAK,SAAS;EACd,KAAK,UAAU;EACf,MAAM,KAAK,KAAK;CAClB;AACF;;;;;;;;;;;;;;AAeA,MAAa,uBAAuB,IAAI,qBAAqB"}

package/llms-full.txt

@@ -8624,7 +8624,7 @@ CLI commands, scheduled jobs, queue workers — anything running outside an HTTP
 
 ---
 name: write-cli-command
-description: 'Author a custom `warlock <my-cmd>` command via the `command()` factory — name, description, action, options, preload, then register in `warlock.config.ts > cli.commands` or drop in `src/app/<module>/commands/`. Triggers: `command`, `CLICommand`, `CLICommandPreload`, `CLICommandOption`, `preload`, `preAction`, `persistent`, `colors`; "write a custom warlock command", "one-off maintenance task", "ship a CLI from a package", "framework built-in commands"; typical import `import { command } from "@warlock.js/core"`. Skip: framework dev/build/start — `@warlock.js/core/run-app/SKILL.md`; warlock.config.ts wiring — `@warlock.js/core/configure-app/SKILL.md`; competing libs `commander`, `yargs`, `oclif`.'
+description: 'Author a custom `warlock <my-cmd>` command via the `command()` factory — name, description, action, options, preload, then register in `warlock.config.ts > cli.commands` or drop in `src/app/<module>/commands/`. Also covers built-in `warlock add` feature scaffolding, including the Web starter and `index.register.ts`. Triggers: `command`, `CLICommand`, `CLICommandPreload`, `CLICommandOption`, `preload`, `preAction`, `persistent`, `colors`, `warlock add`, `index.register.ts`; "write a custom warlock command", "one-off maintenance task", "ship a CLI from a package", "framework built-in commands"; typical import `import { command } from "@warlock.js/core"`. Skip: framework dev/build/start — `@warlock.js/core/run-app/SKILL.md`; warlock.config.ts wiring — `@warlock.js/core/configure-app/SKILL.md`; competing libs `commander`, `yargs`, `oclif`.'
 ---
 
 # Warlock — write a CLI command
@@ -8829,6 +8829,7 @@ warlock generate                         (alias: g)      — interactive picker
 | Feature       | Installs                                                                                            |
 | ------------- | --------------------------------------------------------------------------------------------------- |
 | `react-email` | `react-email` + `@react-email/components` + `@react-email/render` + `@react-email/tailwind`; drops a `welcome-email.tsx` sample; patches `tsconfig.json` |
+| `web`         | Warlock Web + React stack; scaffolds the application page, localization, contact endpoint, and Web configuration                         |
 | `react`       | `react` + `react-dom` + types                                                                       |
 | `image`       | `sharp` (for the `Image` class)                                                                     |
 | `mail`        | `nodemailer` + types                                                                                |
@@ -8846,6 +8847,8 @@ warlock generate                         (alias: g)      — interactive picker
 
 Run `warlock add --list` to see what's currently registered. Pass `--packageManager <yarn\|pnpm\|npm>` to override auto-detection (defaults to whichever lockfile is present).
 
+The Web starter keeps the page's universal non-component setup in `src/web/index.register.ts`, while `src/web/index.page.tsx` re-exports `register`. Warlock still discovers and runs the hook from the page namespace in both SSR and the browser, but editing the page component remains inside React's Fast Refresh boundary. Do not move the `register()` declaration inline beside the component: React Refresh treats that non-component export as incompatible and reloads the page, losing component state.
+
 ### Misc
 
 | Command  | Purpose                                                     |

package/llms.txt

@@ -42,7 +42,7 @@
 - [warlock-doctor](@warlock.js/core/warlock-doctor/SKILL.md): Run `warlock doctor` — a read-only diagnostics command that checks routes / config / connectors / optional-peers / health endpoints / release hygiene and prints a pass/warn/fail report, exiting non-zero on any failure. Add your own probe with the `DoctorCheck` contract and `runChecks` / `formatReportLines`. Triggers: `warlock doctor`, `doctorCommand`, `DoctorCheck`, `CheckResult`, `CheckStatus`, `DoctorReport`, `runChecks`, `formatReportLines`, `printReport`, `defaultDoctorChecks`; "diagnose my app", "preflight / preflight check", "is the app healthy", "why are there 0 routes", "pre-release sanity check", "CI smoke check"; run as `pnpm warlock doctor`. Skip: the live `/health` + `/ready` HTTP probes — `@warlock.js/core/health-checks/SKILL.md`; authoring a general CLI command — `@warlock.js/core/write-cli-command/SKILL.md`; releasing the package — `releasing-warlock-monorepo`; competing tools `npm doctor`, `nest info`, hand-rolled preflight scripts.
 - [warlock-routes](@warlock.js/core/warlock-routes/SKILL.md): Run `warlock routes` — a read-only command that lists the registered HTTP routes as a verb-colored table (method / path / name / action / middleware-count / source), a sibling of `warlock doctor`. Filter with `--method` / `--path` / `--name`, or emit normalized rows as JSON with `--json`. Also covers `warlock routes:diff`, which compares live page routes against the last `warlock build`'s route snapshot and exits non-zero on drift. Triggers: `warlock routes`, `routesCommand`, `warlock routes:diff`, `routesDiffCommand`, "list my routes", "show all routes", "route table", "what endpoints does my app expose", "dump routes as JSON", "which routes have middleware", "route map for CI", "did my page routes drift from the last build"; run as `pnpm warlock routes` / `pnpm warlock routes:diff`. Skip: read-only health/preflight checks — `@warlock.js/core/warlock-doctor/SKILL.md`; defining/naming/grouping routes — `@warlock.js/core/register-route/SKILL.md`; authoring a general CLI command — `@warlock.js/core/write-cli-command/SKILL.md`; competing tools `nest`/`express` route listers, `php artisan route:list`.
 - [wire-socket](@warlock.js/core/wire-socket/SKILL.md): Configure Socket.IO via `src/config/socket.ts`, reach the live server through `getSocketServer()` (or `app.socket` post-bootstrap), register `connection` handlers once the late-phase socket connector has booted, emit from controllers/services, use rooms and namespaces. Triggers: `app.socket`, `getSocketServer`, `SocketOptions`, `socket.io` `Server`, `socket.join`, `socket.to`, `io.of`, `io.use`; "add realtime chat", "emit socket events from a service", "use rooms and namespaces", "per-socket JWT auth". Skip: connector lifecycle — `@warlock.js/core/add-connector/SKILL.md`; app context accessors — `@warlock.js/core/use-app-context/SKILL.md`; competing libs `ws`, `socket.io` direct without Warlock connector, `uWebSockets.js`.
-- [write-cli-command](@warlock.js/core/write-cli-command/SKILL.md): Author a custom `warlock <my-cmd>` command via the `command()` factory — name, description, action, options, preload, then register in `warlock.config.ts > cli.commands` or drop in `src/app/<module>/commands/`. Triggers: `command`, `CLICommand`, `CLICommandPreload`, `CLICommandOption`, `preload`, `preAction`, `persistent`, `colors`; "write a custom warlock command", "one-off maintenance task", "ship a CLI from a package", "framework built-in commands"; typical import `import { command } from "@warlock.js/core"`. Skip: framework dev/build/start — `@warlock.js/core/run-app/SKILL.md`; warlock.config.ts wiring — `@warlock.js/core/configure-app/SKILL.md`; competing libs `commander`, `yargs`, `oclif`.
+- [write-cli-command](@warlock.js/core/write-cli-command/SKILL.md): Author a custom `warlock <my-cmd>` command via the `command()` factory — name, description, action, options, preload, then register in `warlock.config.ts > cli.commands` or drop in `src/app/<module>/commands/`. Also covers built-in `warlock add` feature scaffolding, including the Web starter and `index.register.ts`. Triggers: `command`, `CLICommand`, `CLICommandPreload`, `CLICommandOption`, `preload`, `preAction`, `persistent`, `colors`, `warlock add`, `index.register.ts`; "write a custom warlock command", "one-off maintenance task", "ship a CLI from a package", "framework built-in commands"; typical import `import { command } from "@warlock.js/core"`. Skip: framework dev/build/start — `@warlock.js/core/run-app/SKILL.md`; warlock.config.ts wiring — `@warlock.js/core/configure-app/SKILL.md`; competing libs `commander`, `yargs`, `oclif`.
 - [write-middleware](@warlock.js/core/write-middleware/SKILL.md): Author HTTP middleware for @warlock.js/core — the `(request, response)` signature, short-circuit by returning a response, enrich the request with extra fields, register per-route, per-group, or app-wide. Triggers: `Middleware`, `MiddlewareResponse`, `router.group`, `guarded`, `request.detectIp`, `authMiddleware`; "write a custom middleware", "short-circuit a request", "enrich the request with extra fields", "per-route vs per-group middleware"; typical import `import type { Middleware } from "@warlock.js/core"`. Skip: built-in middleware catalog — `@warlock.js/core/use-middleware/SKILL.md`; route attachment — `@warlock.js/core/register-route/SKILL.md`; response helpers — `@warlock.js/core/send-response/SKILL.md`; competing patterns: `express` `(req, res, next)` middleware, Fastify `preHandler` hooks.
 - [write-seeder](@warlock.js/core/write-seeder/SKILL.md): Author a seed file under `src/app/<module>/seeds/<name>.ts` using the `seeder()` factory — `name`, `dependsOn`, `once`, `order`, `batchSize`, `run({ track, now, batchSize })`. Auto-discovered by `warlock seed`; tracked in a `seeds` table; per-record refs in `seed_records` so `warlock seed --drop` can undo a seed. Triggers: `seeder`, `Seeder`, `SeedResult`, `SeedContext`, `SeedClock`, `track`, `now`, `batchSize`, `SeedersManager`, `warlock seed`, `--fresh`, `--drop`, `--list`, `--path`; "seed default roles", "undo a seed", "one-time data migration", "auto-discovered seeds", "order seeds by dependency", "deterministic seed timestamps", "inject a seed clock"; typical import `import { seeder } from "@warlock.js/core"`. Skip: module folder layout — `@warlock.js/core/create-module/SKILL.md`; repository CRUD — `@warlock.js/core/use-repository/SKILL.md`; CLI flags — `@warlock.js/core/write-cli-command/SKILL.md`; competing patterns: hand-rolled `node scripts/seed.js`, `typeorm-seeding`.
 - [write-use-case](@warlock.js/core/write-use-case/SKILL.md): Author `useCase()` pipelines for business logic — guards, schema, before/after middleware, retry, benchmark, broadcast, lifecycle callbacks; transport-agnostic and observable by default. Input is inferred from the `schema`. Triggers: `useCase`, `UseCaseContext`, `UseCaseResult`, `retry`, `benchmark`, `broadcast`, `description`, `globalUseCasesEvents`, `UseCaseBroadcastChannel`; "encapsulate a business operation", "share logic between HTTP and CLI", "add guards and lifecycle hooks", "broadcast a use case result", "transport-agnostic pipeline"; typical import `import { useCase } from "@warlock.js/core"`. Skip: thin handler shape — `@warlock.js/core/create-controller/SKILL.md`; schema details — `@warlock.js/core/validate-input/SKILL.md`; the standalone retry util — `@warlock.js/core/retry-operation/SKILL.md`; competing libs `@nestjs/cqrs`, `inversify`, hand-rolled service classes.

package/package.json

@@ -25,13 +25,13 @@
     "@mongez/slug": "^1.0.7",
     "@mongez/supportive-is": "^2.1.4",
     "@mongez/time-wizard": "^1.0.6",
-    "@warlock.js/auth": "5.2.3",
-    "@warlock.js/cache": "5.2.3",
-    "@warlock.js/cascade": "5.2.3",
-    "@warlock.js/context": "5.2.3",
-    "@warlock.js/logger": "5.2.3",
-    "@warlock.js/seal": "5.2.3",
-    "@warlock.js/fs": "5.2.3",
+    "@warlock.js/auth": "5.2.4",
+    "@warlock.js/cache": "5.2.4",
+    "@warlock.js/cascade": "5.2.4",
+    "@warlock.js/context": "5.2.4",
+    "@warlock.js/logger": "5.2.4",
+    "@warlock.js/seal": "5.2.4",
+    "@warlock.js/fs": "5.2.4",
     "chokidar": "^5.0.0",
     "dayjs": "^1.11.19",
     "es-module-lexer": "^2.0.0",
@@ -57,10 +57,10 @@
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
     "@react-email/render": "^2.0.5",
-    "@warlock.js/herald": "5.2.3",
-    "@warlock.js/ai": "5.2.3",
-    "@warlock.js/access": "5.2.3",
-    "@warlock.js/notifications": "5.2.3"
+    "@warlock.js/herald": "5.2.4",
+    "@warlock.js/ai": "5.2.4",
+    "@warlock.js/access": "5.2.4",
+    "@warlock.js/notifications": "5.2.4"
   },
   "peerDependenciesMeta": {
     "sharp": {
@@ -123,7 +123,7 @@
   ],
   "author": "hassanzohdy",
   "license": "MIT",
-  "version": "5.2.3",
+  "version": "5.2.4",
   "type": "module",
   "main": "./esm/index.mjs",
   "module": "./esm/index.mjs",

package/skills/README.md

@@ -45,7 +45,7 @@ Each folder holds one `SKILL.md` (an agent-facing how-to for a single task). The
 
 - [warlock-doctor](warlock-doctor/SKILL.md) — `warlock doctor`: read-only diagnostics (routes/config/connectors/optional-peers/health/release-hygiene) with a pass/warn/fail report and non-zero exit on failure.
 - [warlock-routes](warlock-routes/SKILL.md) — `warlock routes`: list the registered HTTP routes as a verb-colored table (method/path/name/action/middleware/source); filter by method/path/name or emit JSON. Read-only, no connectors.
-- [write-cli-command](write-cli-command/SKILL.md) — author a custom `warlock <cmd>` via the `command()` factory (name, action, options, preload).
+- [write-cli-command](write-cli-command/SKILL.md) — author a custom `warlock <cmd>` via the `command()` factory, or inspect built-in `warlock add` feature scaffolding such as the Web starter.
 - [run-app](run-app/SKILL.md) — `warlock dev` / `warlock build` / `warlock start` operational commands.
 - [update-packages](update-packages/SKILL.md) — bump every `@warlock.js/*` dependency with `warlock update`.
 

package/skills/write-cli-command/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: write-cli-command
-description: 'Author a custom `warlock <my-cmd>` command via the `command()` factory — name, description, action, options, preload, then register in `warlock.config.ts > cli.commands` or drop in `src/app/<module>/commands/`. Triggers: `command`, `CLICommand`, `CLICommandPreload`, `CLICommandOption`, `preload`, `preAction`, `persistent`, `colors`; "write a custom warlock command", "one-off maintenance task", "ship a CLI from a package", "framework built-in commands"; typical import `import { command } from "@warlock.js/core"`. Skip: framework dev/build/start — `@warlock.js/core/run-app/SKILL.md`; warlock.config.ts wiring — `@warlock.js/core/configure-app/SKILL.md`; competing libs `commander`, `yargs`, `oclif`.'
+description: 'Author a custom `warlock <my-cmd>` command via the `command()` factory — name, description, action, options, preload, then register in `warlock.config.ts > cli.commands` or drop in `src/app/<module>/commands/`. Also covers built-in `warlock add` feature scaffolding, including the Web starter and `index.register.ts`. Triggers: `command`, `CLICommand`, `CLICommandPreload`, `CLICommandOption`, `preload`, `preAction`, `persistent`, `colors`, `warlock add`, `index.register.ts`; "write a custom warlock command", "one-off maintenance task", "ship a CLI from a package", "framework built-in commands"; typical import `import { command } from "@warlock.js/core"`. Skip: framework dev/build/start — `@warlock.js/core/run-app/SKILL.md`; warlock.config.ts wiring — `@warlock.js/core/configure-app/SKILL.md`; competing libs `commander`, `yargs`, `oclif`.'
 ---
 
 # Warlock — write a CLI command
@@ -205,6 +205,7 @@ warlock generate                         (alias: g)      — interactive picker
 | Feature       | Installs                                                                                            |
 | ------------- | --------------------------------------------------------------------------------------------------- |
 | `react-email` | `react-email` + `@react-email/components` + `@react-email/render` + `@react-email/tailwind`; drops a `welcome-email.tsx` sample; patches `tsconfig.json` |
+| `web`         | Warlock Web + React stack; scaffolds the application page, localization, contact endpoint, and Web configuration                         |
 | `react`       | `react` + `react-dom` + types                                                                       |
 | `image`       | `sharp` (for the `Image` class)                                                                     |
 | `mail`        | `nodemailer` + types                                                                                |
@@ -222,6 +223,8 @@ warlock generate                         (alias: g)      — interactive picker
 
 Run `warlock add --list` to see what's currently registered. Pass `--packageManager <yarn\|pnpm\|npm>` to override auto-detection (defaults to whichever lockfile is present).
 
+The Web starter keeps the page's universal non-component setup in `src/web/index.register.ts`, while `src/web/index.page.tsx` re-exports `register`. Warlock still discovers and runs the hook from the page namespace in both SSR and the browser, but editing the page component remains inside React's Fast Refresh boundary. Do not move the `register()` declaration inline beside the component: React Refresh treats that non-component export as incompatible and reloads the page, losing component state.
+
 ### Misc
 
 | Command  | Purpose                                                     |