create-forgeon 0.1.2 → 0.1.6

package/src/run-create-forgeon.mjs

@@ -1,72 +1,72 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { printHelp } from './cli/help.mjs';
-import { parseCliArgs, promptForMissingOptions } from './cli/options.mjs';
-import { DEFAULT_DB, DEFAULT_FRONTEND, DEFAULT_PROXY, FIXED_DOCKER_ENABLED } from './constants.mjs';
-import { runInstall } from './core/install.mjs';
-import { scaffoldProject } from './core/scaffold.mjs';
-import { validatePresetSupport } from './core/validate.mjs';
-import { parseBoolean } from './utils/values.mjs';
-
-export async function runCreateForgeon(argv = process.argv.slice(2)) {
-  const { options: parsedOptions, positional } = parseCliArgs(argv);
-  const options = { ...parsedOptions };
-
-  if (options.help) {
-    printHelp();
-    return;
-  }
-
-  if (!options.name && positional.length > 0) {
-    [options.name] = positional;
-  }
-
-  const promptedOptions = await promptForMissingOptions(options);
-
-  if (!promptedOptions.name || promptedOptions.name.trim().length === 0) {
-    throw new Error('Project name is required.');
-  }
-
-  const frontend = (promptedOptions.frontend ?? DEFAULT_FRONTEND).toString().toLowerCase();
-  const db = (promptedOptions.db ?? DEFAULT_DB).toString().toLowerCase();
-  const i18nEnabled = parseBoolean(promptedOptions.i18n, true);
-  const dockerEnabled = FIXED_DOCKER_ENABLED;
-  const proxy = (promptedOptions.proxy ?? DEFAULT_PROXY).toString().toLowerCase();
-  const installEnabled = parseBoolean(promptedOptions.install, false);
-
-  validatePresetSupport({ frontend, db, dockerEnabled, proxy });
-
-  const projectName = promptedOptions.name.trim();
-  const targetRoot = path.resolve(process.cwd(), projectName);
-  if (fs.existsSync(targetRoot)) {
-    throw new Error(`Target directory already exists: ${targetRoot}`);
-  }
-
-  const srcDir = path.dirname(fileURLToPath(import.meta.url));
-  const packageRoot = path.resolve(srcDir, '..');
-  const templateRoot = path.join(packageRoot, 'templates', 'base');
-
-  scaffoldProject({
-    templateRoot,
-    packageRoot,
-    targetRoot,
-    projectName,
-    frontend,
-    db,
-    i18nEnabled,
-    proxy,
-  });
-
-  if (installEnabled) {
-    runInstall(targetRoot);
-  }
-
-  console.log('Forgeon scaffold generated.');
-  console.log(`- path: ${targetRoot}`);
-  console.log(`- frontend: ${frontend}`);
-  console.log(`- db: ${db}`);
-  console.log(`- i18n: ${i18nEnabled}`);
-  console.log(`- docker: ${dockerEnabled}`);
-  console.log(`- proxy: ${proxy}`);
-}
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { printHelp } from './cli/help.mjs';
+import { parseCliArgs, promptForMissingOptions } from './cli/options.mjs';
+import { DEFAULT_DB, DEFAULT_FRONTEND, DEFAULT_PROXY, FIXED_DOCKER_ENABLED } from './constants.mjs';
+import { runInstall } from './core/install.mjs';
+import { scaffoldProject } from './core/scaffold.mjs';
+import { validatePresetSupport } from './core/validate.mjs';
+import { parseBoolean } from './utils/values.mjs';
+
+export async function runCreateForgeon(argv = process.argv.slice(2)) {
+  const { options: parsedOptions, positional } = parseCliArgs(argv);
+  const options = { ...parsedOptions };
+
+  if (options.help) {
+    printHelp();
+    return;
+  }
+
+  if (!options.name && positional.length > 0) {
+    [options.name] = positional;
+  }
+
+  const promptedOptions = await promptForMissingOptions(options);
+
+  if (!promptedOptions.name || promptedOptions.name.trim().length === 0) {
+    throw new Error('Project name is required.');
+  }
+
+  const frontend = (promptedOptions.frontend ?? DEFAULT_FRONTEND).toString().toLowerCase();
+  const db = (promptedOptions.db ?? DEFAULT_DB).toString().toLowerCase();
+  const i18nEnabled = parseBoolean(promptedOptions.i18n, true);
+  const dockerEnabled = FIXED_DOCKER_ENABLED;
+  const proxy = (promptedOptions.proxy ?? DEFAULT_PROXY).toString().toLowerCase();
+  const installEnabled = parseBoolean(promptedOptions.install, false);
+
+  validatePresetSupport({ frontend, db, dockerEnabled, proxy });
+
+  const projectName = promptedOptions.name.trim();
+  const targetRoot = path.resolve(process.cwd(), projectName);
+  if (fs.existsSync(targetRoot)) {
+    throw new Error(`Target directory already exists: ${targetRoot}`);
+  }
+
+  const srcDir = path.dirname(fileURLToPath(import.meta.url));
+  const packageRoot = path.resolve(srcDir, '..');
+  const templateRoot = path.join(packageRoot, 'templates', 'base');
+
+  scaffoldProject({
+    templateRoot,
+    packageRoot,
+    targetRoot,
+    projectName,
+    frontend,
+    db,
+    i18nEnabled,
+    proxy,
+  });
+
+  if (installEnabled) {
+    runInstall(targetRoot);
+  }
+
+  console.log('Forgeon scaffold generated.');
+  console.log(`- path: ${targetRoot}`);
+  console.log(`- frontend: ${frontend}`);
+  console.log(`- db: ${db}`);
+  console.log(`- i18n: ${i18nEnabled}`);
+  console.log(`- docker: ${dockerEnabled}`);
+  console.log(`- proxy: ${proxy}`);
+}

package/src/utils/fs.mjs

@@ -1,26 +1,26 @@
-import fs from 'node:fs';
-import path from 'node:path';
-
-export function copyRecursive(source, destination) {
-  const stat = fs.statSync(source);
-
-  if (stat.isDirectory()) {
-    fs.mkdirSync(destination, { recursive: true });
-    for (const entry of fs.readdirSync(source)) {
-      copyRecursive(path.join(source, entry), path.join(destination, entry));
-    }
-    return;
-  }
-
-  fs.copyFileSync(source, destination);
-}
-
-export function writeJson(filePath, data) {
-  fs.writeFileSync(filePath, `${JSON.stringify(data, null, 2)}\n`, 'utf8');
-}
-
-export function removeIfExists(targetPath) {
-  if (fs.existsSync(targetPath)) {
-    fs.rmSync(targetPath, { recursive: true, force: true });
-  }
-}
+import fs from 'node:fs';
+import path from 'node:path';
+
+export function copyRecursive(source, destination) {
+  const stat = fs.statSync(source);
+
+  if (stat.isDirectory()) {
+    fs.mkdirSync(destination, { recursive: true });
+    for (const entry of fs.readdirSync(source)) {
+      copyRecursive(path.join(source, entry), path.join(destination, entry));
+    }
+    return;
+  }
+
+  fs.copyFileSync(source, destination);
+}
+
+export function writeJson(filePath, data) {
+  fs.writeFileSync(filePath, `${JSON.stringify(data, null, 2)}\n`, 'utf8');
+}
+
+export function removeIfExists(targetPath) {
+  if (fs.existsSync(targetPath)) {
+    fs.rmSync(targetPath, { recursive: true, force: true });
+  }
+}

package/src/utils/values.mjs

@@ -1,20 +1,20 @@
-export function parseBoolean(value, fallback) {
-  if (value === undefined) return fallback;
-  if (typeof value === 'boolean') return value;
-
-  const normalized = String(value).trim().toLowerCase();
-  if (['true', '1', 'yes', 'y'].includes(normalized)) return true;
-  if (['false', '0', 'no', 'n'].includes(normalized)) return false;
-
-  throw new Error(`Invalid boolean value: ${value}`);
-}
-
-export function toKebabCase(value) {
-  return (
-    value
-      .trim()
-      .toLowerCase()
-      .replace(/[^a-z0-9]+/g, '-')
-      .replace(/^-+|-+$/g, '') || 'forgeon-app'
-  );
-}
+export function parseBoolean(value, fallback) {
+  if (value === undefined) return fallback;
+  if (typeof value === 'boolean') return value;
+
+  const normalized = String(value).trim().toLowerCase();
+  if (['true', '1', 'yes', 'y'].includes(normalized)) return true;
+  if (['false', '0', 'no', 'n'].includes(normalized)) return false;
+
+  throw new Error(`Invalid boolean value: ${value}`);
+}
+
+export function toKebabCase(value) {
+  return (
+    value
+      .trim()
+      .toLowerCase()
+      .replace(/[^a-z0-9]+/g, '-')
+      .replace(/^-+|-+$/g, '') || 'forgeon-app'
+  );
+}

package/templates/base/.dockerignore

@@ -1,7 +1,7 @@
-**/node_modules
-**/dist
-.git
-.gitignore
-.DS_Store
-pnpm-debug.log
-*.log
+**/node_modules
+**/dist
+.git
+.gitignore
+.DS_Store
+pnpm-debug.log
+*.log

package/templates/base/.editorconfig

@@ -1,11 +1,11 @@
-root = true
-
-[*.{ts,tsx,js,mjs,cjs,json,md,yml,yaml,css,html,prisma,sql,conf}]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-indent_style = space
-indent_size = 2
-
-[Makefile]
-indent_style = tab
+root = true
+
+[*.{ts,tsx,js,mjs,cjs,json,md,yml,yaml,css,html,prisma,sql,conf}]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[Makefile]
+indent_style = tab

package/templates/base/README.md

@@ -1,47 +1,47 @@
-# Forgeon Fullstack Scaffold
-
-Canonical monorepo scaffold for NestJS + frontend with shared packages, built-in docs, optional i18n (enabled by default), and default DB stack Prisma + Postgres.
-
-## Quick Start (Dev)
-
-1. Install dependencies:
-   ```bash
-   pnpm install
-   ```
-2. Start local Postgres (Docker):
-   ```bash
-   docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up db -d
-   ```
-3. Run API + web in dev mode:
-   ```bash
-   pnpm dev
-   ```
-4. Open:
-   - Web: `http://localhost:5173`
-   - API health: `http://localhost:3000/api/health`
-
-## Quick Start (Docker)
-
-```bash
-docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up --build
-```
-
-Open `http://localhost:8080`.
-
-## i18n Toggle
-
-Set in env:
-- `I18N_ENABLED=true|false`
-- `I18N_DEFAULT_LANG=en`
-- `I18N_FALLBACK_LANG=en`
-
-When `I18N_ENABLED=false`, API runs without loading i18n module.
-
-## Prisma In Docker Start
-
-API container starts with:
-1. `prisma migrate deploy`
-2. `node apps/api/dist/main.js`
-
-This keeps container startup production-like while still simple.
+# Forgeon Fullstack Scaffold
+
+Canonical monorepo scaffold for NestJS + frontend with shared packages, built-in docs, optional i18n (enabled by default), and default DB stack Prisma + Postgres.
+
+## Quick Start (Dev)
+
+1. Install dependencies:
+   ```bash
+   pnpm install
+   ```
+2. Start local Postgres (Docker):
+   ```bash
+   docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up db -d
+   ```
+3. Run API + web in dev mode:
+   ```bash
+   pnpm dev
+   ```
+4. Open:
+   - Web: `http://localhost:5173`
+   - API health: `http://localhost:3000/api/health`
+
+## Quick Start (Docker)
+
+```bash
+docker compose --env-file infra/docker/.env.example -f infra/docker/compose.yml up --build
+```
+
+Open `http://localhost:8080`.
+
+## i18n Toggle
+
+Set in env:
+- `I18N_ENABLED=true|false`
+- `I18N_DEFAULT_LANG=en`
+- `I18N_FALLBACK_LANG=en`
+
+When `I18N_ENABLED=false`, API runs without loading i18n module.
+
+## Prisma In Docker Start
+
+API container starts with:
+1. `prisma migrate deploy`
+2. `node apps/api/dist/main.js`
+
+This keeps container startup production-like while still simple.
 

package/templates/base/apps/api/Dockerfile

@@ -1,24 +1,24 @@
-FROM node:20-alpine
-
-WORKDIR /app
-RUN corepack enable
-
-COPY package.json pnpm-workspace.yaml tsconfig.base.json ./
-COPY apps/api/package.json apps/api/package.json
-COPY apps/api/prisma apps/api/prisma
-COPY packages/core/package.json packages/core/package.json
-COPY packages/i18n/package.json packages/i18n/package.json
-
-RUN pnpm install --frozen-lockfile=false
-
-COPY apps/api apps/api
-COPY packages/core packages/core
-COPY packages/i18n packages/i18n
-COPY resources resources
-
-RUN pnpm --filter @forgeon/i18n build
-RUN pnpm --filter @forgeon/api prisma:generate
-RUN pnpm --filter @forgeon/api build
-
-EXPOSE 3000
-CMD ["sh", "-c", "pnpm --filter @forgeon/api prisma:migrate:deploy && node apps/api/dist/main.js"]
+FROM node:20-alpine
+
+WORKDIR /app
+RUN corepack enable
+
+COPY package.json pnpm-workspace.yaml tsconfig.base.json ./
+COPY apps/api/package.json apps/api/package.json
+COPY apps/api/prisma apps/api/prisma
+COPY packages/core/package.json packages/core/package.json
+COPY packages/i18n/package.json packages/i18n/package.json
+
+RUN pnpm install --frozen-lockfile=false
+
+COPY apps/api apps/api
+COPY packages/core packages/core
+COPY packages/i18n packages/i18n
+COPY resources resources
+
+RUN pnpm --filter @forgeon/i18n build
+RUN pnpm --filter @forgeon/api prisma:generate
+RUN pnpm --filter @forgeon/api build
+
+EXPOSE 3000
+CMD ["sh", "-c", "pnpm --filter @forgeon/api prisma:migrate:deploy && node apps/api/dist/main.js"]

package/templates/base/apps/api/package.json

@@ -1,40 +1,40 @@
-{
-  "name": "@forgeon/api",
-  "version": "0.1.0",
-  "private": true,
-  "scripts": {
-    "predev": "pnpm --filter @forgeon/i18n build",
-    "build": "tsc -p tsconfig.build.json",
-    "dev": "ts-node --transpile-only src/main.ts",
-    "start": "node dist/main.js",
-    "prisma:generate": "prisma generate --schema prisma/schema.prisma",
-    "prisma:migrate:dev": "prisma migrate dev --schema prisma/schema.prisma",
-    "prisma:migrate:deploy": "prisma migrate deploy --schema prisma/schema.prisma",
-    "prisma:studio": "prisma studio --schema prisma/schema.prisma",
-    "prisma:seed": "ts-node --transpile-only prisma/seed.ts"
-  },
-  "dependencies": {
-    "@forgeon/i18n": "workspace:*",
-    "@nestjs/common": "^11.0.1",
-    "@nestjs/config": "^4.0.2",
-    "@nestjs/core": "^11.0.1",
-    "@nestjs/platform-express": "^11.0.1",
-    "@prisma/client": "^6.18.0",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.1",
-    "nestjs-i18n": "^10.5.1",
-    "reflect-metadata": "^0.2.2",
-    "rxjs": "^7.8.1"
-  },
-  "devDependencies": {
-    "@types/express": "^5.0.0",
-    "@types/node": "^22.10.7",
-    "prisma": "^6.18.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.7.3"
-  },
-  "prisma": {
-    "seed": "ts-node --transpile-only prisma/seed.ts"
-  }
-}
+{
+  "name": "@forgeon/api",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "predev": "pnpm --filter @forgeon/i18n build",
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "ts-node --transpile-only src/main.ts",
+    "start": "node dist/main.js",
+    "prisma:generate": "prisma generate --schema prisma/schema.prisma",
+    "prisma:migrate:dev": "prisma migrate dev --schema prisma/schema.prisma",
+    "prisma:migrate:deploy": "prisma migrate deploy --schema prisma/schema.prisma",
+    "prisma:studio": "prisma studio --schema prisma/schema.prisma",
+    "prisma:seed": "ts-node --transpile-only prisma/seed.ts"
+  },
+  "dependencies": {
+    "@forgeon/i18n": "workspace:*",
+    "@nestjs/common": "^11.0.1",
+    "@nestjs/config": "^4.0.2",
+    "@nestjs/core": "^11.0.1",
+    "@nestjs/platform-express": "^11.0.1",
+    "@prisma/client": "^6.18.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.1",
+    "nestjs-i18n": "^10.5.1",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.1"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.10.7",
+    "prisma": "^6.18.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.3"
+  },
+  "prisma": {
+    "seed": "ts-node --transpile-only prisma/seed.ts"
+  }
+}
 

package/templates/base/apps/api/prisma/migrations/0001_init/migration.sql

@@ -1,12 +1,12 @@
--- CreateTable
-CREATE TABLE "User" (
-    "id" TEXT NOT NULL,
-    "email" TEXT NOT NULL,
-    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
-    "updatedAt" TIMESTAMP(3) NOT NULL,
-
-    CONSTRAINT "User_pkey" PRIMARY KEY ("id")
-);
-
--- CreateIndex
+-- CreateTable
+CREATE TABLE "User" (
+    "id" TEXT NOT NULL,
+    "email" TEXT NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" TIMESTAMP(3) NOT NULL,
+
+    CONSTRAINT "User_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
 CREATE UNIQUE INDEX "User_email_key" ON "User"("email");

package/templates/base/apps/api/prisma/schema.prisma

@@ -1,15 +1,15 @@
-generator client {
-  provider = "prisma-client-js"
-}
-
-datasource db {
-  provider = "postgresql"
-  url      = env("DATABASE_URL")
-}
-
-model User {
-  id        String   @id @default(cuid())
-  email     String   @unique
-  createdAt DateTime @default(now())
-  updatedAt DateTime @updatedAt
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "postgresql"
+  url      = env("DATABASE_URL")
+}
+
+model User {
+  id        String   @id @default(cuid())
+  email     String   @unique
+  createdAt DateTime @default(now())
+  updatedAt DateTime @updatedAt
 }

package/templates/base/apps/api/prisma/seed.ts

@@ -1,20 +1,20 @@
-import { PrismaClient } from '@prisma/client';
-
-const prisma = new PrismaClient();
-
-async function main() {
-  await prisma.user.upsert({
-    where: { email: 'seed@example.com' },
-    update: {},
-    create: { email: 'seed@example.com' },
-  });
-}
-
-main()
-  .catch((error) => {
-    console.error(error);
-    process.exit(1);
-  })
-  .finally(async () => {
-    await prisma.$disconnect();
+import { PrismaClient } from '@prisma/client';
+
+const prisma = new PrismaClient();
+
+async function main() {
+  await prisma.user.upsert({
+    where: { email: 'seed@example.com' },
+    update: {},
+    create: { email: 'seed@example.com' },
+  });
+}
+
+main()
+  .catch((error) => {
+    console.error(error);
+    process.exit(1);
+  })
+  .finally(async () => {
+    await prisma.$disconnect();
   });

package/templates/base/apps/api/src/app.module.ts

@@ -1,34 +1,34 @@
-import { Module } from '@nestjs/common';
-import { ConfigModule } from '@nestjs/config';
-import { ForgeonI18nModule } from '@forgeon/i18n';
-import { join } from 'path';
-import appConfig from './config/app.config';
-import { HealthController } from './health/health.controller';
-import { PrismaModule } from './prisma/prisma.module';
-import { AppExceptionFilter } from './common/filters/app-exception.filter';
-
-const i18nEnabled = (process.env.I18N_ENABLED ?? 'true').toLowerCase() !== 'false';
-const i18nDefaultLang = process.env.I18N_DEFAULT_LANG ?? 'en';
-const i18nFallbackLang = process.env.I18N_FALLBACK_LANG ?? 'en';
-const i18nPath = join(__dirname, '..', '..', '..', 'resources', 'i18n');
-
-@Module({
-  imports: [
-    ConfigModule.forRoot({
-      isGlobal: true,
-      load: [appConfig],
-      envFilePath: '.env',
-    }),
-    ForgeonI18nModule.register({
-      enabled: i18nEnabled,
-      defaultLang: i18nDefaultLang,
-      fallbackLang: i18nFallbackLang,
-      path: i18nPath,
-    }),
-    PrismaModule,
-  ],
-  controllers: [HealthController],
-  providers: [AppExceptionFilter],
-})
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import { ForgeonI18nModule } from '@forgeon/i18n';
+import { join } from 'path';
+import appConfig from './config/app.config';
+import { HealthController } from './health/health.controller';
+import { PrismaModule } from './prisma/prisma.module';
+import { AppExceptionFilter } from './common/filters/app-exception.filter';
+
+const i18nEnabled = (process.env.I18N_ENABLED ?? 'true').toLowerCase() !== 'false';
+const i18nDefaultLang = process.env.I18N_DEFAULT_LANG ?? 'en';
+const i18nFallbackLang = process.env.I18N_FALLBACK_LANG ?? 'en';
+const i18nPath = join(__dirname, '..', '..', '..', 'resources', 'i18n');
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+      load: [appConfig],
+      envFilePath: '.env',
+    }),
+    ForgeonI18nModule.register({
+      enabled: i18nEnabled,
+      defaultLang: i18nDefaultLang,
+      fallbackLang: i18nFallbackLang,
+      path: i18nPath,
+    }),
+    PrismaModule,
+  ],
+  controllers: [HealthController],
+  providers: [AppExceptionFilter],
+})
 export class AppModule {}