create-forgeon 0.3.14 → 0.3.16

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "create-forgeon",
-  "version": "0.3.14",
+  "version": "0.3.16",
   "description": "Forgeon project generator CLI",
   "license": "MIT",
   "author": "Forgeon",
   "type": "module",
   "scripts": {
-    "test": "node --test src/cli/options.test.mjs src/cli/add-options.test.mjs src/cli/prompt-select.test.mjs src/core/docs.test.mjs src/core/validate.test.mjs src/modules/executor.test.mjs"
+    "test": "node --test --test-concurrency=1 src/cli/options.test.mjs src/cli/add-options.test.mjs src/cli/prompt-select.test.mjs src/core/docs.test.mjs src/core/validate.test.mjs src/core/scaffold.test.mjs src/modules/dependencies.test.mjs src/modules/executor.test.mjs src/modules/probes.test.mjs src/modules/idempotency.test.mjs src/modules/sync-integrations.test.mjs src/run-add-module.test.mjs",
+    "smoke:generated-project": "node scripts/generated-project-smoke.mjs",
+    "smoke:generated-project:full": "node scripts/generated-project-full-smoke.mjs"
   },
   "bin": {
     "create-forgeon": "bin/create-forgeon.mjs"

package/src/core/docs.test.mjs

@@ -1,29 +1,30 @@
-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, '..', '..');
-
+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';
+import { scaffoldProject } from './scaffold.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,
+    const targetRoot = makeTempDir('forgeon-docs-off-');
+
+    try {
+      generateDocs(
+        targetRoot,
         {
           frontend: 'react',
           db: 'prisma',
@@ -31,9 +32,9 @@ describe('generateDocs', () => {
           dockerEnabled: true,
           i18nEnabled: false,
           proxy: 'none',
-        },
-        packageRoot,
-      );
+        },
+        packageRoot,
+      );
 
       const readme = readFile(path.join(targetRoot, 'README.md'));
 
@@ -45,18 +46,20 @@ describe('generateDocs', () => {
       assert.match(readme, /Module notes index: `modules\/README\.md`/);
       assert.doesNotMatch(readme, /i18n Configuration/);
       assert.doesNotMatch(readme, /Prisma In Container Start/);
+      assert.doesNotMatch(readme, /docs\/README\.md/);
+      assert.doesNotMatch(readme, /docs\/Agents\.md/);
       assert.equal(fs.existsSync(path.join(targetRoot, 'docs')), false);
     } 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,
+  });
+
+  it('generates docker and caddy notes when enabled', () => {
+    const targetRoot = makeTempDir('forgeon-docs-on-');
+
+    try {
+      generateDocs(
+        targetRoot,
         {
           frontend: 'react',
           db: 'prisma',
@@ -64,9 +67,9 @@ describe('generateDocs', () => {
           dockerEnabled: true,
           i18nEnabled: true,
           proxy: 'caddy',
-        },
-        packageRoot,
-      );
+        },
+        packageRoot,
+      );
 
       const readme = readFile(path.join(targetRoot, 'README.md'));
 
@@ -77,9 +80,45 @@ describe('generateDocs', () => {
       assert.match(readme, /Prisma In Container Start/);
       assert.match(readme, /Error Handling \(`core-errors`\)/);
       assert.match(readme, /Module-specific notes: `modules\/<module-id>\/README\.md`/);
+      assert.doesNotMatch(readme, /docs\/README\.md/);
+      assert.doesNotMatch(readme, /docs\/Agents\.md/);
       assert.equal(fs.existsSync(path.join(targetRoot, 'docs')), false);
     } finally {
       fs.rmSync(targetRoot, { recursive: true, force: true });
     }
-  });
+  });
+
+  it('scaffolds a generated project without copying internal docs payload', () => {
+    const tempRoot = makeTempDir('forgeon-scaffold-doc-boundary-');
+    const targetRoot = path.join(tempRoot, 'demo-doc-boundary');
+    const templateRoot = path.join(packageRoot, 'templates', 'base');
+
+    try {
+      scaffoldProject({
+        templateRoot,
+        packageRoot,
+        targetRoot,
+        projectName: 'demo-doc-boundary',
+        frontend: 'react',
+        db: 'prisma',
+        dbPrismaEnabled: true,
+        i18nEnabled: true,
+        proxy: 'caddy',
+      });
+
+      const readme = readFile(path.join(targetRoot, 'README.md'));
+      const packageJson = readFile(path.join(targetRoot, 'package.json'));
+
+      assert.equal(fs.existsSync(path.join(targetRoot, 'docs')), false);
+      assert.match(readme, /Module notes index: `modules\/README\.md`/);
+      assert.doesNotMatch(readme, /temporary template placeholder/i);
+      assert.doesNotMatch(readme, /built-in docs/i);
+      assert.doesNotMatch(readme, /docs\/README\.md/);
+      assert.doesNotMatch(readme, /docs\/Agents\.md/);
+      assert.doesNotMatch(packageJson, /"create:forgeon"/);
+      assert.match(packageJson, /"forgeon:sync-integrations"/);
+    } finally {
+      fs.rmSync(tempRoot, { recursive: true, force: true });
+    }
+  });
 });

package/src/core/scaffold.test.mjs

@@ -0,0 +1,99 @@
+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 { scaffoldProject } from './scaffold.mjs';
+
+function makeTempDir(prefix) {
+  return fs.mkdtempSync(path.join(os.tmpdir(), prefix));
+}
+
+function readFile(filePath) {
+  return fs.readFileSync(filePath, 'utf8');
+}
+
+function assertProxyPreset(targetRoot, proxy) {
+  const dockerDir = path.join(targetRoot, 'infra', 'docker');
+  const compose = readFile(path.join(dockerDir, 'compose.yml'));
+  const packageJson = readFile(path.join(targetRoot, 'package.json'));
+  const appTsx = readFile(path.join(targetRoot, 'apps', 'web', 'src', 'App.tsx'));
+  const probesTs = readFile(path.join(targetRoot, 'apps', 'web', 'src', 'probes.ts'));
+
+  assert.equal(fs.existsSync(path.join(targetRoot, 'docs')), false);
+  assert.equal(fs.existsSync(path.join(dockerDir, 'compose.caddy.yml')), false);
+  assert.equal(fs.existsSync(path.join(dockerDir, 'compose.nginx.yml')), false);
+  assert.equal(fs.existsSync(path.join(dockerDir, 'compose.none.yml')), false);
+  assert.match(packageJson, /"forgeon:sync-integrations"/);
+  assert.doesNotMatch(packageJson, /"create:forgeon"/);
+  assert.match(compose, /^services:\s*$/m);
+  assert.match(compose, /^\s{2}api:\s*$/m);
+
+  if (proxy === 'caddy') {
+    assert.match(compose, /^\s{2}caddy:\s*$/m);
+    assert.doesNotMatch(compose, /^\s{2}nginx:\s*$/m);
+    assert.equal(fs.existsSync(path.join(dockerDir, 'caddy.Dockerfile')), true);
+    assert.equal(fs.existsSync(path.join(dockerDir, 'nginx.Dockerfile')), false);
+    assert.equal(fs.existsSync(path.join(targetRoot, 'infra', 'caddy')), true);
+    assert.equal(fs.existsSync(path.join(targetRoot, 'infra', 'nginx')), false);
+    return;
+  }
+
+  if (proxy === 'nginx') {
+    assert.match(compose, /^\s{2}nginx:\s*$/m);
+    assert.doesNotMatch(compose, /^\s{2}caddy:\s*$/m);
+    assert.equal(fs.existsSync(path.join(dockerDir, 'nginx.Dockerfile')), true);
+    assert.equal(fs.existsSync(path.join(dockerDir, 'caddy.Dockerfile')), false);
+    assert.equal(fs.existsSync(path.join(targetRoot, 'infra', 'nginx')), true);
+    assert.equal(fs.existsSync(path.join(targetRoot, 'infra', 'caddy')), false);
+    return;
+  }
+
+  assert.doesNotMatch(compose, /^\s{2}caddy:\s*$/m);
+  assert.doesNotMatch(compose, /^\s{2}nginx:\s*$/m);
+  assert.match(compose, /- "3000:3000"/);
+  assert.equal(fs.existsSync(path.join(dockerDir, 'nginx.Dockerfile')), false);
+  assert.equal(fs.existsSync(path.join(dockerDir, 'caddy.Dockerfile')), false);
+  assert.equal(fs.existsSync(path.join(targetRoot, 'infra', 'nginx')), false);
+  assert.equal(fs.existsSync(path.join(targetRoot, 'infra', 'caddy')), false);
+}
+
+describe('scaffoldProject', () => {
+  const thisDir = path.dirname(fileURLToPath(import.meta.url));
+  const packageRoot = path.resolve(thisDir, '..', '..');
+  const templateRoot = path.join(packageRoot, 'templates', 'base');
+  const cases = [
+    { proxy: 'caddy', readmePattern: /Proxy Preset: Caddy/ },
+    { proxy: 'nginx', readmePattern: /Proxy Preset: Nginx/ },
+    { proxy: 'none', readmePattern: /Proxy Preset: none/ },
+  ];
+
+  it('applies proxy presets without leftover reverse-proxy assets', () => {
+    for (const testCase of cases) {
+      const tempRoot = makeTempDir(`forgeon-scaffold-proxy-${testCase.proxy}-`);
+      const targetRoot = path.join(tempRoot, `demo-${testCase.proxy}`);
+
+      try {
+        scaffoldProject({
+          templateRoot,
+          packageRoot,
+          targetRoot,
+          projectName: `demo-${testCase.proxy}`,
+          frontend: 'react',
+          db: 'prisma',
+          dbPrismaEnabled: false,
+          i18nEnabled: false,
+          proxy: testCase.proxy,
+        });
+
+        const readme = readFile(path.join(targetRoot, 'README.md'));
+        assert.match(readme, testCase.readmePattern);
+        assert.match(readme, /Module notes index: `modules\/README\.md`/);
+        assertProxyPreset(targetRoot, testCase.proxy);
+      } finally {
+        fs.rmSync(tempRoot, { recursive: true, force: true });
+      }
+    }
+  });
+});

package/src/modules/db-prisma.mjs

@@ -15,6 +15,7 @@ import {
   ensureValidatorSchema,
   upsertEnvLines,
 } from './shared/patch-utils.mjs';
+import { ensureWebProbeDefinition, resolveProbeTargets } from './shared/probes.mjs';
 
 function copyFromPreset(packageRoot, targetRoot, relativePath) {
   const source = path.join(packageRoot, 'templates', 'module-presets', 'db-prisma', relativePath);
@@ -110,7 +111,11 @@ function patchAppModule(targetRoot) {
   fs.writeFileSync(filePath, `${content.trimEnd()}\n`, 'utf8');
 }
 
-function patchHealthController(targetRoot) {
+function patchHealthController(targetRoot, probeTargets) {
+  if (!probeTargets.allowApi) {
+    return;
+  }
+
   const filePath = path.join(targetRoot, 'apps', 'api', 'src', 'health', 'health.controller.ts');
   if (!fs.existsSync(filePath)) {
     return;
@@ -171,58 +176,19 @@ function patchHealthController(targetRoot) {
   fs.writeFileSync(filePath, `${content.trimEnd()}\n`, 'utf8');
 }
 
-function patchWebApp(targetRoot) {
-  const filePath = path.join(targetRoot, 'apps', 'web', 'src', 'App.tsx');
-  if (!fs.existsSync(filePath)) {
-    return;
-  }
-
-  let content = fs.readFileSync(filePath, 'utf8').replace(/\r\n/g, '\n');
-  content = content
-    .replace(/^\s*\{\/\* forgeon:probes:actions:start \*\/\}\r?\n?/gm, '')
-    .replace(/^\s*\{\/\* forgeon:probes:actions:end \*\/\}\r?\n?/gm, '')
-    .replace(/^\s*\{\/\* forgeon:probes:results:start \*\/\}\r?\n?/gm, '')
-    .replace(/^\s*\{\/\* forgeon:probes:results:end \*\/\}\r?\n?/gm, '');
-
-  if (!content.includes('dbProbeResult')) {
-    const stateAnchor = '  const [validationProbeResult, setValidationProbeResult] = useState<ProbeResult | null>(null);';
-    if (content.includes(stateAnchor)) {
-      content = ensureLineAfter(
-        content,
-        stateAnchor,
-        '  const [dbProbeResult, setDbProbeResult] = useState<ProbeResult | null>(null);',
-      );
-    }
-  }
-
-  if (!content.includes('Check database (create user)')) {
-    const dbButton = content.includes("runProbe(setHealthResult, '/health')")
-      ? "        <button onClick={() => runProbe(setDbProbeResult, '/health/db', { method: 'POST' })}>\n          Check database (create user)\n        </button>"
-      : "        <button onClick={() => runProbe(setDbProbeResult, '/api/health/db', { method: 'POST' })}>\n          Check database (create user)\n        </button>";
-
-    const actionsStart = content.indexOf('<div className="actions">');
-    if (actionsStart >= 0) {
-      const actionsEnd = content.indexOf('\n      </div>', actionsStart);
-      if (actionsEnd >= 0) {
-        content = `${content.slice(0, actionsEnd)}\n${dbButton}${content.slice(actionsEnd)}`;
-      }
-    }
-  }
-
-  if (!content.includes("{renderResult('DB probe response', dbProbeResult)}")) {
-    const dbResultLine = "      {renderResult('DB probe response', dbProbeResult)}";
-    const networkLine = '      {networkError ? <p className="error">{networkError}</p> : null}';
-    if (content.includes(networkLine)) {
-      content = content.replace(networkLine, `${dbResultLine}\n${networkLine}`);
-    } else {
-      const resultAnchor = "{renderResult('Validation probe response', validationProbeResult)}";
-      if (content.includes(resultAnchor)) {
-        content = ensureLineAfter(content, resultAnchor, dbResultLine);
-      }
-    }
-  }
-
-  fs.writeFileSync(filePath, `${content.trimEnd()}\n`, 'utf8');
+function registerWebProbe(targetRoot, probeTargets) {
+  ensureWebProbeDefinition({
+    targetRoot,
+    probeTargets,
+    definition: {
+      id: 'db',
+      title: 'Database',
+      buttonLabel: 'Check database (create user)',
+      resultTitle: 'DB probe response',
+      path: '/health/db',
+      request: { method: 'POST' },
+    },
+  });
 }
 
 function patchApiDockerfile(targetRoot) {
@@ -349,11 +315,13 @@ export function applyDbPrismaModule({ packageRoot, targetRoot }) {
   copyFromPreset(packageRoot, targetRoot, path.join('packages', 'db-prisma'));
   copyFromPreset(packageRoot, targetRoot, path.join('apps', 'api', 'prisma'));
 
+  const probeTargets = resolveProbeTargets({ targetRoot, moduleId: 'db-prisma' });
+
   patchApiPackage(targetRoot);
   patchRootPackage(targetRoot);
   patchAppModule(targetRoot);
-  patchHealthController(targetRoot);
-  patchWebApp(targetRoot);
+  patchHealthController(targetRoot, probeTargets);
+  registerWebProbe(targetRoot, probeTargets);
   patchApiDockerfile(targetRoot);
   patchCompose(targetRoot);
   patchReadme(targetRoot);