create-forgeon 0.1.2 → 0.1.6

package/templates/base/packages/i18n/src/forgeon-i18n.module.ts

@@ -1,47 +1,47 @@
-import { DynamicModule, Module } from '@nestjs/common';
-import {
-  AcceptLanguageResolver,
-  I18nJsonLoader,
-  I18nModule,
-  QueryResolver,
-} from 'nestjs-i18n';
-import { join } from 'path';
-
-export interface ForgeonI18nOptions {
-  enabled: boolean;
-  defaultLang: string;
-  fallbackLang: string;
-  path?: string;
-}
-
-@Module({})
-export class ForgeonI18nModule {
-  static register(options: ForgeonI18nOptions): DynamicModule {
-    if (!options.enabled) {
-      return { module: ForgeonI18nModule };
-    }
-
-    const translationsPath =
-      options.path ?? join(process.cwd(), 'resources', 'i18n');
-
-    return {
-      module: ForgeonI18nModule,
-      imports: [
-        I18nModule.forRoot({
-          fallbackLanguage: options.fallbackLang,
-          loader: I18nJsonLoader,
-          loaderOptions: {
-            path: translationsPath,
-            watch: false,
-          },
-          resolvers: [
-            { use: AcceptLanguageResolver, options: { matchType: 'strict-loose' } },
-            { use: QueryResolver, options: ['lang'] },
-          ],
-        }),
-      ],
-      exports: [I18nModule],
-    };
-  }
+import { DynamicModule, Module } from '@nestjs/common';
+import {
+  AcceptLanguageResolver,
+  I18nJsonLoader,
+  I18nModule,
+  QueryResolver,
+} from 'nestjs-i18n';
+import { join } from 'path';
+
+export interface ForgeonI18nOptions {
+  enabled: boolean;
+  defaultLang: string;
+  fallbackLang: string;
+  path?: string;
+}
+
+@Module({})
+export class ForgeonI18nModule {
+  static register(options: ForgeonI18nOptions): DynamicModule {
+    if (!options.enabled) {
+      return { module: ForgeonI18nModule };
+    }
+
+    const translationsPath =
+      options.path ?? join(process.cwd(), 'resources', 'i18n');
+
+    return {
+      module: ForgeonI18nModule,
+      imports: [
+        I18nModule.forRoot({
+          fallbackLanguage: options.fallbackLang,
+          loader: I18nJsonLoader,
+          loaderOptions: {
+            path: translationsPath,
+            watch: false,
+          },
+          resolvers: [
+            { use: AcceptLanguageResolver, options: { matchType: 'strict-loose' } },
+            { use: QueryResolver, options: ['lang'] },
+          ],
+        }),
+      ],
+      exports: [I18nModule],
+    };
+  }
 }
 

package/templates/base/packages/i18n/tsconfig.json

@@ -1,9 +1,9 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist",
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"]
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist",
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"]
 }

package/templates/base/pnpm-workspace.yaml

@@ -1,3 +1,3 @@
-packages:
-  - apps/*
+packages:
+  - apps/*
   - packages/*

package/templates/base/resources/i18n/en/common.json

@@ -1,5 +1,5 @@
-{
-  "errors.accessDenied": "Access denied",
-  "errors.notFound": "Resource not found",
-  "common.ok": "OK"
+{
+  "errors.accessDenied": "Access denied",
+  "errors.notFound": "Resource not found",
+  "common.ok": "OK"
 }

package/templates/base/resources/i18n/en/validation.json

@@ -1,3 +1,3 @@
-{
-  "validation.required": "Field is required"
+{
+  "validation.required": "Field is required"
 }

package/templates/base/resources/i18n/uk/common.json

@@ -1,5 +1,5 @@
-{
-  "errors.accessDenied": "Доступ заборонено",
-  "errors.notFound": "Ресурс не знайдено",
-  "common.ok": "OK"
+{
+  "errors.accessDenied": "Доступ заборонено",
+  "errors.notFound": "Ресурс не знайдено",
+  "common.ok": "OK"
 }

package/templates/base/resources/i18n/uk/validation.json

@@ -1,3 +1,3 @@
-{
-  "validation.required": "Поле є обов'язковим"
+{
+  "validation.required": "Поле є обов'язковим"
 }

package/templates/base/tsconfig.base.json

@@ -1,17 +1,17 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "strict": true,
-    "esModuleInterop": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "declaration": true,
-    "sourceMap": true,
-    "outDir": "dist"
-  }
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "strict": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+    "sourceMap": true,
+    "outDir": "dist"
+  }
 }

package/templates/docs-fragments/AI_ARCHITECTURE/00_title.md

@@ -1 +1 @@
-# ARCHITECTURE
+# ARCHITECTURE

package/templates/docs-fragments/AI_ARCHITECTURE/10_layout_base.md

@@ -1,6 +1,6 @@
-## Monorepo Layout
-
-- `apps/*` - deployable apps
-- `packages/*` - reusable modules and presets
-
-Canonical stack is fixed for now: NestJS API + React web + Prisma/Postgres + Docker.
+## Monorepo Layout
+
+- `apps/*` - deployable apps
+- `packages/*` - reusable modules and presets
+
+Canonical stack is fixed for now: NestJS API + React web + Prisma/Postgres + Docker.

package/templates/docs-fragments/AI_ARCHITECTURE/11_layout_infra.md

@@ -1 +1 @@
-- `infra/*` - runtime infrastructure (compose, proxy, env examples)
+- `infra/*` - runtime infrastructure (compose, proxy, env examples)

package/templates/docs-fragments/AI_ARCHITECTURE/12_layout_i18n_resources.md

@@ -1 +1 @@
-- `resources/*` - static assets (includes translation dictionaries when i18n is enabled)
+- `resources/*` - static assets (includes translation dictionaries when i18n is enabled)

package/templates/docs-fragments/AI_ARCHITECTURE/20_env_base.md

@@ -1,4 +1,4 @@
-## Environment Flags
-
-- `PORT` - API port (default 3000)
-- `DATABASE_URL` - DB connection string for Prisma
+## Environment Flags
+
+- `PORT` - API port (default 3000)
+- `DATABASE_URL` - DB connection string for Prisma

package/templates/docs-fragments/AI_ARCHITECTURE/21_env_i18n.md

@@ -1,3 +1,3 @@
-- `I18N_ENABLED` - toggles i18n package wiring
-- `I18N_DEFAULT_LANG` - default language
-- `I18N_FALLBACK_LANG` - fallback language
+- `I18N_ENABLED` - toggles i18n package wiring
+- `I18N_DEFAULT_LANG` - default language
+- `I18N_FALLBACK_LANG` - fallback language

package/templates/docs-fragments/AI_ARCHITECTURE/30_default_db.md

@@ -1,7 +1,7 @@
-## Default DB Stack
-
-Current default stack is `{{DB_LABEL}}`.
-
-- Prisma schema and migrations live in `apps/api/prisma`
-- DB access is encapsulated via `PrismaModule` (`apps/api/src/prisma`)
-- Additional DB presets are intentionally out of scope for the current milestone.
+## Default DB Stack
+
+Current default stack is `{{DB_LABEL}}`.
+
+- Prisma schema and migrations live in `apps/api/prisma`
+- DB access is encapsulated via `PrismaModule` (`apps/api/src/prisma`)
+- Additional DB presets are intentionally out of scope for the current milestone.

package/templates/docs-fragments/AI_ARCHITECTURE/31_docker_runtime.md

@@ -1,5 +1,5 @@
-## Docker Runtime Flow
-
-- Compose file: `infra/docker/compose.yml`
-- API starts through migration deploy, then NestJS server boot.
-- Active reverse proxy preset: `{{PROXY_LABEL}}` (`{{PROXY_CONFIG_PATH}}`)
+## Docker Runtime Flow
+
+- Compose file: `infra/docker/compose.yml`
+- API starts through migration deploy, then NestJS server boot.
+- Active reverse proxy preset: `{{PROXY_LABEL}}` (`{{PROXY_CONFIG_PATH}}`)

package/templates/docs-fragments/AI_ARCHITECTURE/32_scope_freeze.md

@@ -1,5 +1,5 @@
-## Scope Freeze (Current)
-
-- Frontend preset selection is disabled (React is fixed).
-- DB preset selection is disabled (Prisma/Postgres is fixed).
-- Docker is always generated; runtime proxy is selectable (`caddy|nginx|none`).
+## Scope Freeze (Current)
+
+- Frontend preset selection is disabled (React is fixed).
+- DB preset selection is disabled (Prisma/Postgres is fixed).
+- Docker is always generated; runtime proxy is selectable (`caddy|nginx|none`).

package/templates/docs-fragments/AI_ARCHITECTURE/40_docs_generation.md

@@ -1,9 +1,9 @@
-## Docs Generation Pipeline
-
-Project docs are assembled from markdown fragments in:
-
-- `packages/create-forgeon/templates/docs-fragments/README`
-- `packages/create-forgeon/templates/docs-fragments/AI_PROJECT`
-- `packages/create-forgeon/templates/docs-fragments/AI_ARCHITECTURE`
-
-During scaffold generation, the CLI selects fragments based on chosen flags and writes final docs into project root and `docs/AI`.
+## Docs Generation Pipeline
+
+Project docs are assembled from markdown fragments in:
+
+- `packages/create-forgeon/templates/docs-fragments/README`
+- `packages/create-forgeon/templates/docs-fragments/AI_PROJECT`
+- `packages/create-forgeon/templates/docs-fragments/AI_ARCHITECTURE`
+
+During scaffold generation, the CLI selects fragments based on chosen flags and writes final docs into project root and `docs/AI`.

package/templates/docs-fragments/AI_ARCHITECTURE/50_extension_points.md

@@ -1,8 +1,8 @@
-## Extension Points
-
-Future presets should extend both code and docs in parallel:
-
-1. Add or update fullstack module templates (`contracts/api/web`).
-2. Register modules in `create-forgeon add` registry.
-3. Add module docs fragments and update module spec docs.
-4. Keep canonical core stack stable unless a major version changes it.
+## Extension Points
+
+Future presets should extend both code and docs in parallel:
+
+1. Add or update fullstack module templates (`contracts/api/web`).
+2. Register modules in `create-forgeon add` registry.
+3. Add module docs fragments and update module spec docs.
+4. Keep canonical core stack stable unless a major version changes it.

package/templates/docs-fragments/AI_PROJECT/00_title.md

@@ -1 +1 @@
-# PROJECT
+# PROJECT

package/templates/docs-fragments/AI_PROJECT/10_what_is.md

@@ -1,3 +1,3 @@
-## What This Repository Is
-
-A canonical fullstack monorepo scaffold intended to be reused as a project starter.
+## What This Repository Is
+
+A canonical fullstack monorepo scaffold intended to be reused as a project starter.

package/templates/docs-fragments/AI_PROJECT/20_structure_base.md

@@ -1,5 +1,5 @@
-## Structure
-
-- `apps/api` - NestJS backend
-- `apps/web` - React frontend (`{{FRONTEND_LABEL}}`, fixed)
-- `packages/core` - shared backend core placeholder
+## Structure
+
+- `apps/api` - NestJS backend
+- `apps/web` - React frontend (`{{FRONTEND_LABEL}}`, fixed)
+- `packages/core` - shared backend core placeholder

package/templates/docs-fragments/AI_PROJECT/21_structure_i18n.md

@@ -1,2 +1,4 @@
 - `packages/i18n` - reusable nestjs-i18n integration package
+- `packages/i18n-contracts` - shared locale/query constants
+- `packages/i18n-web` - frontend locale helper package
 - `resources/i18n` - translation dictionaries

package/templates/docs-fragments/AI_PROJECT/22_structure_docker.md

@@ -1 +1 @@
-- `infra` - Docker Compose (always) + proxy preset (`{{PROXY_LABEL}}`)
+- `infra` - Docker Compose (always) + proxy preset (`{{PROXY_LABEL}}`)

package/templates/docs-fragments/AI_PROJECT/23_structure_docs.md

@@ -1 +1 @@
-- `docs` - documentation, AI prompts, and module spec contracts
+- `docs` - documentation, AI prompts, and module spec contracts

package/templates/docs-fragments/AI_PROJECT/30_run_dev.md

@@ -1,8 +1,8 @@
-## Run Modes
-
-### Dev mode
-
-```bash
-pnpm install
-pnpm dev
-```
+## Run Modes
+
+### Dev mode
+
+```bash
+pnpm install
+pnpm dev
+```

package/templates/docs-fragments/AI_PROJECT/31_run_docker.md

@@ -1,5 +1,5 @@
-### Docker mode
-
-```bash
-docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up --build
-```
+### Docker mode
+
+```bash
+docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up --build
+```

package/templates/docs-fragments/AI_PROJECT/32_proxy_notes.md

@@ -1,5 +1,5 @@
-### Proxy Notes
-
-- Active proxy preset: `{{PROXY_LABEL}}`
-- Main proxy config: `{{PROXY_CONFIG_PATH}}`
-- Keep service names `api` and `db` stable unless you update compose and proxy config together.
+### Proxy Notes
+
+- Active proxy preset: `{{PROXY_LABEL}}`
+- Main proxy config: `{{PROXY_CONFIG_PATH}}`
+- Keep service names `api` and `db` stable unless you update compose and proxy config together.

package/templates/docs-fragments/AI_PROJECT/32_proxy_notes_none.md

@@ -1,5 +1,5 @@
-### Proxy Notes
-- Active proxy preset: `none`
-- No proxy config file is used.
-- API is exposed directly from compose on `localhost:3000`.
-- For OAuth/SSL test scenarios, switch to `proxy=caddy`.
+### Proxy Notes
+- Active proxy preset: `none`
+- No proxy config file is used.
+- API is exposed directly from compose on `localhost:3000`.
+- For OAuth/SSL test scenarios, switch to `proxy=caddy`.

package/templates/docs-fragments/AI_PROJECT/33_i18n_notes.md

@@ -2,3 +2,5 @@
 
 - Toggle via `I18N_ENABLED`.
 - Default/fallback are controlled by `I18N_DEFAULT_LANG` and `I18N_FALLBACK_LANG`.
+- Locale contracts live in `@forgeon/i18n-contracts`.
+- Frontend helpers live in `@forgeon/i18n-web`.

package/templates/docs-fragments/AI_PROJECT/40_change_boundaries_base.md

@@ -1,3 +1,3 @@
-## Change Boundaries
-
-- Safe to change first: env files, host ports, and app code under `apps/*`.
+## Change Boundaries
+
+- Safe to change first: env files, host ports, and app code under `apps/*`.

package/templates/docs-fragments/AI_PROJECT/41_change_boundaries_docker.md

@@ -1 +1 @@
-- Change carefully: proxy config and docker service names because routing depends on them.
+- Change carefully: proxy config and docker service names because routing depends on them.

package/templates/docs-fragments/README/00_title.md

@@ -1,3 +1,3 @@
-# Forgeon Fullstack Scaffold
-
-Canonical monorepo scaffold for NestJS + frontend with shared packages and generated docs.
+# Forgeon Fullstack Scaffold
+
+Canonical monorepo scaffold for NestJS + frontend with shared packages and generated docs.

package/templates/docs-fragments/README/10_stack.md

@@ -1,8 +1,8 @@
-## Generated Preset
-
-- Stack: `NestJS + React + Prisma/Postgres + Docker`
-- Frontend: `{{FRONTEND_LABEL}}` (fixed)
-- Database: `{{DB_LABEL}}` (fixed)
-- i18n: `{{I18N_STATUS}}`
-- Docker/infra: `enabled` (fixed)
-- Reverse proxy: `{{PROXY_LABEL}}` (`caddy|nginx|none`)
+## Generated Preset
+
+- Stack: `NestJS + React + Prisma/Postgres + Docker`
+- Frontend: `{{FRONTEND_LABEL}}` (fixed)
+- Database: `{{DB_LABEL}}` (fixed)
+- i18n: `{{I18N_STATUS}}`
+- Docker/infra: `enabled` (fixed)
+- Reverse proxy: `{{PROXY_LABEL}}` (`caddy|nginx|none`)

package/templates/docs-fragments/README/20_quick_start_dev_intro.md

@@ -1,6 +1,6 @@
-## Quick Start (Dev)
-
-1. Install dependencies:
-   ```bash
-   pnpm install
-   ```
+## Quick Start (Dev)
+
+1. Install dependencies:
+   ```bash
+   pnpm install
+   ```

package/templates/docs-fragments/README/21_quick_start_dev_db_docker.md

@@ -1,4 +1,4 @@
-2. Start local Postgres (Docker):
-   ```bash
-   docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up db -d
-   ```
+2. Start local Postgres (Docker):
+   ```bash
+   docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up db -d
+   ```

package/templates/docs-fragments/README/21_quick_start_dev_db_local.md

@@ -1 +1 @@
-2. Ensure PostgreSQL is running locally and configure `DATABASE_URL` in `apps/api/.env`.
+2. Ensure PostgreSQL is running locally and configure `DATABASE_URL` in `apps/api/.env`.

package/templates/docs-fragments/README/22_quick_start_dev_outro.md

@@ -1,7 +1,7 @@
-3. Run API + web in dev mode:
-   ```bash
-   pnpm dev
-   ```
-4. Open:
-   - Web: `http://localhost:5173`
-   - API health: `http://localhost:3000/api/health`
+3. Run API + web in dev mode:
+   ```bash
+   pnpm dev
+   ```
+4. Open:
+   - Web: `http://localhost:5173`
+   - API health: `http://localhost:3000/api/health`

package/templates/docs-fragments/README/30_quick_start_docker.md

@@ -1,7 +1,7 @@
-## Quick Start (Docker)
-
-```bash
-docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up --build
-```
-
-Open `http://localhost:8080`.
+## Quick Start (Docker)
+
+```bash
+docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up --build
+```
+
+Open `http://localhost:8080`.

package/templates/docs-fragments/README/30_quick_start_docker_none.md

@@ -1,9 +1,9 @@
-## Quick Start (Docker)
-
-```bash
-docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up --build
-```
-
-Open API at `http://localhost:3000/api/health`.
-
-Frontend is not served by Docker in `proxy=none` mode. Use `pnpm dev` for web.
+## Quick Start (Docker)
+
+```bash
+docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up --build
+```
+
+Open API at `http://localhost:3000/api/health`.
+
+Frontend is not served by Docker in `proxy=none` mode. Use `pnpm dev` for web.

package/templates/docs-fragments/README/31_proxy_preset_caddy.md

@@ -1,9 +1,9 @@
-### Proxy Preset: Caddy
-
-- `/api/*` is proxied to `api:3000`.
-- Static frontend build is served by Caddy.
-- Main proxy config: `infra/caddy/Caddyfile`.
-- Compose service wiring: `infra/docker/compose.yml` (`caddy` service).
-- Safe to edit: host ports and env values in `infra/docker/.env.example`.
-- Avoid renaming service hosts (`api`, `db`) unless you also update proxy/compose config.
-- Recommended preset for local SSL/OAuth-style testing.
+### Proxy Preset: Caddy
+
+- `/api/*` is proxied to `api:3000`.
+- Static frontend build is served by Caddy.
+- Main proxy config: `infra/caddy/Caddyfile`.
+- Compose service wiring: `infra/docker/compose.yml` (`caddy` service).
+- Safe to edit: host ports and env values in `infra/docker/.env.example`.
+- Avoid renaming service hosts (`api`, `db`) unless you also update proxy/compose config.
+- Recommended preset for local SSL/OAuth-style testing.

package/templates/docs-fragments/README/31_proxy_preset_nginx.md

@@ -1,8 +1,8 @@
-### Proxy Preset: Nginx
-
-- `/api/*` is proxied to `api:3000`.
-- Static frontend build is served by Nginx.
-- Main proxy config: `infra/nginx/nginx.conf`.
-- Compose service wiring: `infra/docker/compose.yml` (`nginx` service).
-- Safe to edit: host ports and env values in `infra/docker/.env.example`.
-- Avoid renaming service hosts (`api`, `db`) unless you also update proxy/compose config.
+### Proxy Preset: Nginx
+
+- `/api/*` is proxied to `api:3000`.
+- Static frontend build is served by Nginx.
+- Main proxy config: `infra/nginx/nginx.conf`.
+- Compose service wiring: `infra/docker/compose.yml` (`nginx` service).
+- Safe to edit: host ports and env values in `infra/docker/.env.example`.
+- Avoid renaming service hosts (`api`, `db`) unless you also update proxy/compose config.

package/templates/docs-fragments/README/31_proxy_preset_none.md

@@ -1,6 +1,6 @@
-### Proxy Preset: none
-
-- No reverse proxy container is started.
-- API is exposed directly on `http://localhost:3000`.
-- Useful for minimal local backend testing.
-- For OAuth/SSL-style local tests, prefer `proxy=caddy`.
+### Proxy Preset: none
+
+- No reverse proxy container is started.
+- API is exposed directly on `http://localhost:3000`.
+- Useful for minimal local backend testing.
+- For OAuth/SSL-style local tests, prefer `proxy=caddy`.

package/templates/docs-fragments/README/32_prisma_container_start.md

@@ -1,5 +1,5 @@
-### Prisma In Container Start
-
-API container starts with:
-1. `pnpm --filter @forgeon/api prisma:migrate:deploy`
-2. `node apps/api/dist/main.js`
+### Prisma In Container Start
+
+API container starts with:
+1. `pnpm --filter @forgeon/api prisma:migrate:deploy`
+2. `node apps/api/dist/main.js`

package/templates/docs-fragments/README/40_i18n.md

@@ -1,10 +1,16 @@
-## i18n Configuration
-
-Environment keys:
-- `I18N_ENABLED=true|false`
-- `I18N_DEFAULT_LANG=en`
-- `I18N_FALLBACK_LANG=en`
-
+## i18n Configuration
+
+Environment keys:
+- `I18N_ENABLED=true|false`
+- `I18N_DEFAULT_LANG=en`
+- `I18N_FALLBACK_LANG=en`
+
 Resources location: `resources/i18n`.
 
-When `I18N_ENABLED=false`, API starts without loading `@forgeon/i18n`.
+Packages:
+- `@forgeon/i18n`
+- `@forgeon/i18n-contracts`
+- `@forgeon/i18n-web`
+
+You can apply i18n later with:
+`npx create-forgeon@latest add i18n --project .`