create-forgeon 0.1.2 → 0.1.6

package/src/core/docs.mjs

@@ -1,128 +1,128 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { getDatabaseLabel } from '../databases/index.mjs';
-import { getFrontendLabel } from '../frameworks/index.mjs';
-import { getProxyConfigPath } from '../infrastructure/proxy.mjs';
-
-function renderTemplate(content, variables) {
-  return content.replace(/\{\{([A-Z0-9_]+)\}\}/g, (_, key) => String(variables[key] ?? ''));
-}
-
-function readFragment(fragmentsRoot, docKey, fragmentName, variables) {
-  const fragmentPath = path.join(fragmentsRoot, docKey, `${fragmentName}.md`);
-  if (!fs.existsSync(fragmentPath)) {
-    throw new Error(`Missing docs fragment: ${fragmentPath}`);
-  }
-
-  const raw = fs.readFileSync(fragmentPath, 'utf8').replace(/\r\n/g, '\n').trim();
-  return renderTemplate(raw, variables).trim();
-}
-
-function writeDocFromFragments({
-  targetRoot,
-  outputPath,
-  fragmentsRoot,
-  docKey,
-  fragmentNames,
-  variables,
-}) {
-  const fragments = fragmentNames
-    .map((fragmentName) => readFragment(fragmentsRoot, docKey, fragmentName, variables))
-    .filter((fragment) => fragment.length > 0);
-
-  const content = `${fragments
-    .join('\n\n')
-    .replace(/\n{2,}(?=- )/g, '\n')
-    .replace(/\n{3,}/g, '\n\n')
-    .trimEnd()}\n`;
-  const absoluteOutputPath = path.join(targetRoot, outputPath);
-  fs.mkdirSync(path.dirname(absoluteOutputPath), { recursive: true });
-  fs.writeFileSync(absoluteOutputPath, content, 'utf8');
-}
-
-export function generateDocs(targetRoot, options, packageRoot) {
-  const fragmentsRoot = path.resolve(packageRoot, 'templates', 'docs-fragments');
-  const variables = {
-    FRONTEND_LABEL: getFrontendLabel(options.frontend),
-    DB_LABEL: getDatabaseLabel(options.db),
-    I18N_STATUS: options.i18nEnabled ? 'enabled' : 'disabled',
-    DOCKER_STATUS: 'enabled',
-    PROXY_LABEL: options.proxy,
-    PROXY_CONFIG_PATH: getProxyConfigPath(options.proxy),
-  };
-
-  const readmeFragments = ['00_title', '10_stack', '20_quick_start_dev_intro'];
-  readmeFragments.push('21_quick_start_dev_db_docker');
-  readmeFragments.push('22_quick_start_dev_outro');
-  readmeFragments.push(
-    options.proxy === 'none' ? '30_quick_start_docker_none' : '30_quick_start_docker',
-  );
-  if (options.proxy === 'caddy') {
-    readmeFragments.push('31_proxy_preset_caddy');
-  } else if (options.proxy === 'nginx') {
-    readmeFragments.push('31_proxy_preset_nginx');
-  } else {
-    readmeFragments.push('31_proxy_preset_none');
-  }
-  readmeFragments.push('32_prisma_container_start');
-  if (options.i18nEnabled) {
-    readmeFragments.push('40_i18n');
-  }
-  readmeFragments.push('90_next_steps');
-
-  const aiProjectFragments = ['00_title', '10_what_is', '20_structure_base'];
-  if (options.i18nEnabled) {
-    aiProjectFragments.push('21_structure_i18n');
-  }
-  aiProjectFragments.push('22_structure_docker', '23_structure_docs', '30_run_dev', '31_run_docker');
-  if (options.proxy === 'none') {
-    aiProjectFragments.push('32_proxy_notes_none');
-  } else {
-    aiProjectFragments.push('32_proxy_notes');
-  }
-  if (options.i18nEnabled) {
-    aiProjectFragments.push('33_i18n_notes');
-  }
-  aiProjectFragments.push('40_change_boundaries_base');
-  if (options.proxy !== 'none') {
-    aiProjectFragments.push('41_change_boundaries_docker');
-  }
-
-  const aiArchitectureFragments = ['00_title', '10_layout_base', '11_layout_infra'];
-  if (options.i18nEnabled) {
-    aiArchitectureFragments.push('12_layout_i18n_resources');
-  }
-  aiArchitectureFragments.push('20_env_base');
-  if (options.i18nEnabled) {
-    aiArchitectureFragments.push('21_env_i18n');
-  }
-  aiArchitectureFragments.push('30_default_db', '31_docker_runtime', '32_scope_freeze');
-  aiArchitectureFragments.push('40_docs_generation', '50_extension_points');
-
-  writeDocFromFragments({
-    targetRoot,
-    outputPath: 'README.md',
-    fragmentsRoot,
-    docKey: 'README',
-    fragmentNames: readmeFragments,
-    variables,
-  });
-
-  writeDocFromFragments({
-    targetRoot,
-    outputPath: path.join('docs', 'AI', 'PROJECT.md'),
-    fragmentsRoot,
-    docKey: 'AI_PROJECT',
-    fragmentNames: aiProjectFragments,
-    variables,
-  });
-
-  writeDocFromFragments({
-    targetRoot,
-    outputPath: path.join('docs', 'AI', 'ARCHITECTURE.md'),
-    fragmentsRoot,
-    docKey: 'AI_ARCHITECTURE',
-    fragmentNames: aiArchitectureFragments,
-    variables,
-  });
-}
+import fs from 'node:fs';
+import path from 'node:path';
+import { getDatabaseLabel } from '../databases/index.mjs';
+import { getFrontendLabel } from '../frameworks/index.mjs';
+import { getProxyConfigPath } from '../infrastructure/proxy.mjs';
+
+function renderTemplate(content, variables) {
+  return content.replace(/\{\{([A-Z0-9_]+)\}\}/g, (_, key) => String(variables[key] ?? ''));
+}
+
+function readFragment(fragmentsRoot, docKey, fragmentName, variables) {
+  const fragmentPath = path.join(fragmentsRoot, docKey, `${fragmentName}.md`);
+  if (!fs.existsSync(fragmentPath)) {
+    throw new Error(`Missing docs fragment: ${fragmentPath}`);
+  }
+
+  const raw = fs.readFileSync(fragmentPath, 'utf8').replace(/\r\n/g, '\n').trim();
+  return renderTemplate(raw, variables).trim();
+}
+
+function writeDocFromFragments({
+  targetRoot,
+  outputPath,
+  fragmentsRoot,
+  docKey,
+  fragmentNames,
+  variables,
+}) {
+  const fragments = fragmentNames
+    .map((fragmentName) => readFragment(fragmentsRoot, docKey, fragmentName, variables))
+    .filter((fragment) => fragment.length > 0);
+
+  const content = `${fragments
+    .join('\n\n')
+    .replace(/\n{2,}(?=- )/g, '\n')
+    .replace(/\n{3,}/g, '\n\n')
+    .trimEnd()}\n`;
+  const absoluteOutputPath = path.join(targetRoot, outputPath);
+  fs.mkdirSync(path.dirname(absoluteOutputPath), { recursive: true });
+  fs.writeFileSync(absoluteOutputPath, content, 'utf8');
+}
+
+export function generateDocs(targetRoot, options, packageRoot) {
+  const fragmentsRoot = path.resolve(packageRoot, 'templates', 'docs-fragments');
+  const variables = {
+    FRONTEND_LABEL: getFrontendLabel(options.frontend),
+    DB_LABEL: getDatabaseLabel(options.db),
+    I18N_STATUS: options.i18nEnabled ? 'enabled' : 'disabled',
+    DOCKER_STATUS: 'enabled',
+    PROXY_LABEL: options.proxy,
+    PROXY_CONFIG_PATH: getProxyConfigPath(options.proxy),
+  };
+
+  const readmeFragments = ['00_title', '10_stack', '20_quick_start_dev_intro'];
+  readmeFragments.push('21_quick_start_dev_db_docker');
+  readmeFragments.push('22_quick_start_dev_outro');
+  readmeFragments.push(
+    options.proxy === 'none' ? '30_quick_start_docker_none' : '30_quick_start_docker',
+  );
+  if (options.proxy === 'caddy') {
+    readmeFragments.push('31_proxy_preset_caddy');
+  } else if (options.proxy === 'nginx') {
+    readmeFragments.push('31_proxy_preset_nginx');
+  } else {
+    readmeFragments.push('31_proxy_preset_none');
+  }
+  readmeFragments.push('32_prisma_container_start');
+  if (options.i18nEnabled) {
+    readmeFragments.push('40_i18n');
+  }
+  readmeFragments.push('90_next_steps');
+
+  const aiProjectFragments = ['00_title', '10_what_is', '20_structure_base'];
+  if (options.i18nEnabled) {
+    aiProjectFragments.push('21_structure_i18n');
+  }
+  aiProjectFragments.push('22_structure_docker', '23_structure_docs', '30_run_dev', '31_run_docker');
+  if (options.proxy === 'none') {
+    aiProjectFragments.push('32_proxy_notes_none');
+  } else {
+    aiProjectFragments.push('32_proxy_notes');
+  }
+  if (options.i18nEnabled) {
+    aiProjectFragments.push('33_i18n_notes');
+  }
+  aiProjectFragments.push('40_change_boundaries_base');
+  if (options.proxy !== 'none') {
+    aiProjectFragments.push('41_change_boundaries_docker');
+  }
+
+  const aiArchitectureFragments = ['00_title', '10_layout_base', '11_layout_infra'];
+  if (options.i18nEnabled) {
+    aiArchitectureFragments.push('12_layout_i18n_resources');
+  }
+  aiArchitectureFragments.push('20_env_base');
+  if (options.i18nEnabled) {
+    aiArchitectureFragments.push('21_env_i18n');
+  }
+  aiArchitectureFragments.push('30_default_db', '31_docker_runtime', '32_scope_freeze');
+  aiArchitectureFragments.push('40_docs_generation', '50_extension_points');
+
+  writeDocFromFragments({
+    targetRoot,
+    outputPath: 'README.md',
+    fragmentsRoot,
+    docKey: 'README',
+    fragmentNames: readmeFragments,
+    variables,
+  });
+
+  writeDocFromFragments({
+    targetRoot,
+    outputPath: path.join('docs', 'AI', 'PROJECT.md'),
+    fragmentsRoot,
+    docKey: 'AI_PROJECT',
+    fragmentNames: aiProjectFragments,
+    variables,
+  });
+
+  writeDocFromFragments({
+    targetRoot,
+    outputPath: path.join('docs', 'AI', 'ARCHITECTURE.md'),
+    fragmentsRoot,
+    docKey: 'AI_ARCHITECTURE',
+    fragmentNames: aiArchitectureFragments,
+    variables,
+  });
+}

package/src/core/docs.test.mjs

@@ -1,91 +1,91 @@
-import { describe, it } from 'node:test';
-import assert from 'node:assert/strict';
-import fs from 'node:fs';
-import os from 'node:os';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { generateDocs } from './docs.mjs';
-
-function makeTempDir(prefix) {
-  return fs.mkdtempSync(path.join(os.tmpdir(), prefix));
-}
-
-function readFile(filePath) {
-  return fs.readFileSync(filePath, 'utf8');
-}
-
-describe('generateDocs', () => {
-  const thisDir = path.dirname(fileURLToPath(import.meta.url));
-  const packageRoot = path.resolve(thisDir, '..', '..');
-
-  it('generates docs for proxy=none without i18n section', () => {
-    const targetRoot = makeTempDir('forgeon-docs-off-');
-
-    try {
-      generateDocs(
-        targetRoot,
-        {
-          frontend: 'react',
-          db: 'prisma',
-          dockerEnabled: true,
-          i18nEnabled: false,
-          proxy: 'none',
-        },
-        packageRoot,
-      );
-
-      const readme = readFile(path.join(targetRoot, 'README.md'));
-      const projectDoc = readFile(path.join(targetRoot, 'docs', 'AI', 'PROJECT.md'));
-      const architectureDoc = readFile(path.join(targetRoot, 'docs', 'AI', 'ARCHITECTURE.md'));
-
-      assert.match(readme, /Docker\/infra: `enabled`/);
-      assert.match(readme, /Quick Start \(Docker\)/);
-      assert.match(readme, /Proxy Preset: none/);
-      assert.doesNotMatch(readme, /i18n Configuration/);
-
-      assert.match(projectDoc, /### Docker mode/);
-      assert.match(projectDoc, /Active proxy preset: `none`/);
-      assert.doesNotMatch(projectDoc, /packages\/i18n/);
-
-      assert.match(architectureDoc, /infra\/\*/);
-      assert.doesNotMatch(architectureDoc, /I18N_ENABLED/);
-    } finally {
-      fs.rmSync(targetRoot, { recursive: true, force: true });
-    }
-  });
-
-  it('generates docker and caddy notes when enabled', () => {
-    const targetRoot = makeTempDir('forgeon-docs-on-');
-
-    try {
-      generateDocs(
-        targetRoot,
-        {
-          frontend: 'react',
-          db: 'prisma',
-          dockerEnabled: true,
-          i18nEnabled: true,
-          proxy: 'caddy',
-        },
-        packageRoot,
-      );
-
-      const readme = readFile(path.join(targetRoot, 'README.md'));
-      const projectDoc = readFile(path.join(targetRoot, 'docs', 'AI', 'PROJECT.md'));
-      const architectureDoc = readFile(path.join(targetRoot, 'docs', 'AI', 'ARCHITECTURE.md'));
-
-      assert.match(readme, /Quick Start \(Docker\)/);
-      assert.match(readme, /Proxy Preset: Caddy/);
-      assert.match(readme, /i18n Configuration/);
-
-      assert.match(projectDoc, /`infra` - Docker Compose \(always\) \+ proxy preset \(`caddy`\)/);
-      assert.match(projectDoc, /Main proxy config: `infra\/caddy\/Caddyfile`/);
-
-      assert.match(architectureDoc, /infra\/\*/);
-      assert.match(architectureDoc, /I18N_ENABLED/);
-      assert.match(architectureDoc, /Active reverse proxy preset: `caddy`/);
-    } finally {
-      fs.rmSync(targetRoot, { recursive: true, force: true });
-    }
-  });
-});
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { generateDocs } from './docs.mjs';
+
+function makeTempDir(prefix) {
+  return fs.mkdtempSync(path.join(os.tmpdir(), prefix));
+}
+
+function readFile(filePath) {
+  return fs.readFileSync(filePath, 'utf8');
+}
+
+describe('generateDocs', () => {
+  const thisDir = path.dirname(fileURLToPath(import.meta.url));
+  const packageRoot = path.resolve(thisDir, '..', '..');
+
+  it('generates docs for proxy=none without i18n section', () => {
+    const targetRoot = makeTempDir('forgeon-docs-off-');
+
+    try {
+      generateDocs(
+        targetRoot,
+        {
+          frontend: 'react',
+          db: 'prisma',
+          dockerEnabled: true,
+          i18nEnabled: false,
+          proxy: 'none',
+        },
+        packageRoot,
+      );
+
+      const readme = readFile(path.join(targetRoot, 'README.md'));
+      const projectDoc = readFile(path.join(targetRoot, 'docs', 'AI', 'PROJECT.md'));
+      const architectureDoc = readFile(path.join(targetRoot, 'docs', 'AI', 'ARCHITECTURE.md'));
+
+      assert.match(readme, /Docker\/infra: `enabled`/);
+      assert.match(readme, /Quick Start \(Docker\)/);
+      assert.match(readme, /Proxy Preset: none/);
+      assert.doesNotMatch(readme, /i18n Configuration/);
+
+      assert.match(projectDoc, /### Docker mode/);
+      assert.match(projectDoc, /Active proxy preset: `none`/);
+      assert.doesNotMatch(projectDoc, /packages\/i18n/);
+
+      assert.match(architectureDoc, /infra\/\*/);
+      assert.doesNotMatch(architectureDoc, /I18N_ENABLED/);
+    } finally {
+      fs.rmSync(targetRoot, { recursive: true, force: true });
+    }
+  });
+
+  it('generates docker and caddy notes when enabled', () => {
+    const targetRoot = makeTempDir('forgeon-docs-on-');
+
+    try {
+      generateDocs(
+        targetRoot,
+        {
+          frontend: 'react',
+          db: 'prisma',
+          dockerEnabled: true,
+          i18nEnabled: true,
+          proxy: 'caddy',
+        },
+        packageRoot,
+      );
+
+      const readme = readFile(path.join(targetRoot, 'README.md'));
+      const projectDoc = readFile(path.join(targetRoot, 'docs', 'AI', 'PROJECT.md'));
+      const architectureDoc = readFile(path.join(targetRoot, 'docs', 'AI', 'ARCHITECTURE.md'));
+
+      assert.match(readme, /Quick Start \(Docker\)/);
+      assert.match(readme, /Proxy Preset: Caddy/);
+      assert.match(readme, /i18n Configuration/);
+
+      assert.match(projectDoc, /`infra` - Docker Compose \(always\) \+ proxy preset \(`caddy`\)/);
+      assert.match(projectDoc, /Main proxy config: `infra\/caddy\/Caddyfile`/);
+
+      assert.match(architectureDoc, /infra\/\*/);
+      assert.match(architectureDoc, /I18N_ENABLED/);
+      assert.match(architectureDoc, /Active reverse proxy preset: `caddy`/);
+    } finally {
+      fs.rmSync(targetRoot, { recursive: true, force: true });
+    }
+  });
+});

package/src/core/install.mjs

@@ -1,14 +1,14 @@
-import { spawnSync } from 'node:child_process';
-
-export function runInstall(targetRoot) {
-  const pnpmCmd = process.platform === 'win32' ? 'pnpm.cmd' : 'pnpm';
-  const result = spawnSync(pnpmCmd, ['install'], {
-    cwd: targetRoot,
-    stdio: 'inherit',
-    shell: false,
-  });
-
-  if (result.status !== 0) {
-    process.exit(result.status ?? 1);
-  }
-}
+import { spawnSync } from 'node:child_process';
+
+export function runInstall(targetRoot) {
+  const pnpmCmd = process.platform === 'win32' ? 'pnpm.cmd' : 'pnpm';
+  const result = spawnSync(pnpmCmd, ['install'], {
+    cwd: targetRoot,
+    stdio: 'inherit',
+    shell: false,
+  });
+
+  if (result.status !== 0) {
+    process.exit(result.status ?? 1);
+  }
+}

package/src/core/scaffold.mjs

@@ -3,55 +3,58 @@ import path from 'node:path';
 import { copyRecursive, writeJson } from '../utils/fs.mjs';
 import { toKebabCase } from '../utils/values.mjs';
 import { applyI18nDisabled, applyProxyPreset, patchDockerEnvForI18n } from '../presets/index.mjs';
+import { applyModulePreset } from '../modules/executor.mjs';
 import { generateDocs } from './docs.mjs';
-
-function writeApiEnvExample(targetRoot, i18nEnabled) {
-  const apiEnvExamplePath = path.join(targetRoot, 'apps', 'api', '.env.example');
-  const apiEnvLines = [
-    'PORT=3000',
-    'DATABASE_URL=postgresql://postgres:postgres@localhost:5432/app?schema=public',
-  ];
-
-  if (i18nEnabled) {
-    apiEnvLines.push('I18N_ENABLED=true');
-    apiEnvLines.push('I18N_DEFAULT_LANG=en');
-    apiEnvLines.push('I18N_FALLBACK_LANG=en');
-  }
-
-  fs.writeFileSync(apiEnvExamplePath, `${apiEnvLines.join('\n')}\n`, 'utf8');
-}
-
-function patchRootPackageJson(targetRoot, projectName) {
-  const rootPackageJsonPath = path.join(targetRoot, 'package.json');
-  const rootPackageJson = JSON.parse(fs.readFileSync(rootPackageJsonPath, 'utf8'));
-  rootPackageJson.name = toKebabCase(projectName);
-
-  if (rootPackageJson.scripts) {
-    delete rootPackageJson.scripts['create:forgeon'];
-  }
-
-  writeJson(rootPackageJsonPath, rootPackageJson);
-}
-
-export function scaffoldProject({
-  templateRoot,
-  packageRoot,
-  targetRoot,
-  projectName,
-  frontend,
-  db,
-  i18nEnabled,
-  proxy,
-}) {
+
+function writeApiEnvExample(targetRoot, i18nEnabled) {
+  const apiEnvExamplePath = path.join(targetRoot, 'apps', 'api', '.env.example');
+  const apiEnvLines = [
+    'PORT=3000',
+    'DATABASE_URL=postgresql://postgres:postgres@localhost:5432/app?schema=public',
+  ];
+
+  if (i18nEnabled) {
+    apiEnvLines.push('I18N_ENABLED=true');
+    apiEnvLines.push('I18N_DEFAULT_LANG=en');
+    apiEnvLines.push('I18N_FALLBACK_LANG=en');
+  }
+
+  fs.writeFileSync(apiEnvExamplePath, `${apiEnvLines.join('\n')}\n`, 'utf8');
+}
+
+function patchRootPackageJson(targetRoot, projectName) {
+  const rootPackageJsonPath = path.join(targetRoot, 'package.json');
+  const rootPackageJson = JSON.parse(fs.readFileSync(rootPackageJsonPath, 'utf8'));
+  rootPackageJson.name = toKebabCase(projectName);
+
+  if (rootPackageJson.scripts) {
+    delete rootPackageJson.scripts['create:forgeon'];
+  }
+
+  writeJson(rootPackageJsonPath, rootPackageJson);
+}
+
+export function scaffoldProject({
+  templateRoot,
+  packageRoot,
+  targetRoot,
+  projectName,
+  frontend,
+  db,
+  i18nEnabled,
+  proxy,
+}) {
   copyRecursive(templateRoot, targetRoot);
   patchRootPackageJson(targetRoot, projectName);
   applyProxyPreset(targetRoot, proxy);
-  patchDockerEnvForI18n(targetRoot, i18nEnabled);
 
-  if (!i18nEnabled) {
+  if (i18nEnabled) {
+    applyModulePreset({ moduleId: 'i18n', targetRoot, packageRoot });
+  } else {
+    patchDockerEnvForI18n(targetRoot, i18nEnabled);
     applyI18nDisabled(targetRoot);
   }
-
-  writeApiEnvExample(targetRoot, i18nEnabled);
-  generateDocs(targetRoot, { frontend, db, dockerEnabled: true, i18nEnabled, proxy }, packageRoot);
-}
+
+  writeApiEnvExample(targetRoot, i18nEnabled);
+  generateDocs(targetRoot, { frontend, db, dockerEnabled: true, i18nEnabled, proxy }, packageRoot);
+}

package/src/core/validate.mjs

@@ -1,12 +1,12 @@
-import { ensureDatabaseSupported } from '../databases/index.mjs';
-import { ensureFrontendSupported } from '../frameworks/index.mjs';
-import { ensureProxySupported } from '../infrastructure/proxy.mjs';
-
-export function validatePresetSupport({ frontend, db, dockerEnabled, proxy }) {
-  ensureFrontendSupported(frontend);
-  ensureDatabaseSupported(db);
-
-  if (dockerEnabled) {
-    ensureProxySupported(proxy);
-  }
-}
+import { ensureDatabaseSupported } from '../databases/index.mjs';
+import { ensureFrontendSupported } from '../frameworks/index.mjs';
+import { ensureProxySupported } from '../infrastructure/proxy.mjs';
+
+export function validatePresetSupport({ frontend, db, dockerEnabled, proxy }) {
+  ensureFrontendSupported(frontend);
+  ensureDatabaseSupported(db);
+
+  if (dockerEnabled) {
+    ensureProxySupported(proxy);
+  }
+}