create-forgeon 0.3.5 → 0.3.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-forgeon",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "Forgeon project generator CLI",
   "license": "MIT",
   "author": "Forgeon",

package/src/cli/add-help.mjs

@@ -7,6 +7,7 @@ Usage:
 Options:
   --project <path>   Target project path (default: current directory)
   --with-required    Allow recursive installation of hard prerequisites
+  --with-recommended Auto-install recommended companion modules (non-TTY friendly)
   --provider <capability>=<module>
                      Explicit provider mapping for non-interactive dependency resolution
   --list             List available modules

package/src/cli/add-options.mjs

@@ -6,6 +6,7 @@ export function parseAddCliArgs(argv) {
     list: false,
     help: false,
     withRequired: false,
+    withRecommended: false,
     providers: {},
   };
   const positional = [];
@@ -29,6 +30,11 @@ export function parseAddCliArgs(argv) {
       continue;
     }
 
+    if (arg === '--with-recommended') {
+      options.withRecommended = true;
+      continue;
+    }
+
     if (arg.startsWith('--provider=')) {
       const raw = arg.slice('--provider='.length);
       const separatorIndex = raw.indexOf('=');

package/src/cli/add-options.test.mjs

@@ -26,12 +26,14 @@ describe('parseAddCliArgs', () => {
     const options = parseAddCliArgs([
       'files',
       '--with-required',
+      '--with-recommended',
       '--provider',
       'db-adapter=db-prisma',
       '--provider=queue-adapter=queue',
     ]);
     assert.equal(options.moduleId, 'files');
     assert.equal(options.withRequired, true);
+    assert.equal(options.withRecommended, true);
     assert.deepEqual(options.providers, {
       'db-adapter': 'db-prisma',
       'queue-adapter': 'queue',

package/src/modules/dependencies.mjs

@@ -266,3 +266,34 @@ export function getPendingOptionalIntegrations({
     })
     .filter(Boolean);
 }
+
+export function getPendingRecommendedCompanions({
+  moduleId,
+  targetRoot,
+  presets = listModulePresets(),
+}) {
+  const presetMap = getPresetMap(presets);
+  const preset = presetMap.get(moduleId);
+  if (!preset || !Array.isArray(preset.recommendedCompanions)) {
+    return [];
+  }
+
+  const installedModules = detectInstalledModules(targetRoot, presets);
+  return preset.recommendedCompanions
+    .map((item) => (typeof item === 'string' ? { id: item } : item))
+    .map((item) => {
+      const companion = presetMap.get(item.id);
+      if (!companion || companion.implemented === false) {
+        return null;
+      }
+      if (installedModules.has(item.id)) {
+        return null;
+      }
+      return {
+        id: item.id,
+        title: item.title ?? companion.label ?? item.id,
+        description: item.description ?? companion.description ?? '',
+      };
+    })
+    .filter(Boolean);
+}

package/src/modules/dependencies.test.mjs

@@ -7,6 +7,7 @@ import {
   collectProvidedCapabilities,
   detectInstalledModules,
   getPendingOptionalIntegrations,
+  getPendingRecommendedCompanions,
   resolveModuleInstallPlan,
 } from './dependencies.mjs';
 
@@ -27,10 +28,64 @@ const TEST_PRESETS = [
   {
     id: 'files',
     label: 'Files',
-    implemented: false,
+    implemented: true,
     detectionPaths: ['packages/files/package.json'],
     provides: ['files-runtime'],
-    requires: [{ type: 'capability', id: 'db-adapter' }],
+    requires: [
+      { type: 'capability', id: 'db-adapter' },
+      { type: 'capability', id: 'files-storage-adapter' },
+    ],
+    recommendedCompanions: [
+      {
+        id: 'files-image',
+        title: 'Files Image Hardening',
+      },
+    ],
+    optionalIntegrations: [],
+  },
+  {
+    id: 'files-local',
+    label: 'Files Local Adapter',
+    implemented: true,
+    detectionPaths: ['packages/files-local/package.json'],
+    provides: ['files-storage-adapter'],
+    requires: [],
+    optionalIntegrations: [],
+  },
+  {
+    id: 'files-s3',
+    label: 'Files S3 Adapter',
+    implemented: true,
+    detectionPaths: ['packages/files-s3/package.json'],
+    provides: ['files-storage-adapter'],
+    requires: [],
+    optionalIntegrations: [],
+  },
+  {
+    id: 'files-access',
+    label: 'Files Access',
+    implemented: true,
+    detectionPaths: ['packages/files-access/package.json'],
+    provides: ['files-access-runtime'],
+    requires: [{ type: 'capability', id: 'files-runtime' }],
+    optionalIntegrations: [],
+  },
+  {
+    id: 'files-quotas',
+    label: 'Files Quotas',
+    implemented: true,
+    detectionPaths: ['packages/files-quotas/package.json'],
+    provides: ['files-quotas-runtime'],
+    requires: [{ type: 'capability', id: 'files-runtime' }],
+    optionalIntegrations: [],
+  },
+  {
+    id: 'files-image',
+    label: 'Files Image',
+    implemented: true,
+    detectionPaths: ['packages/files-image/package.json'],
+    provides: ['files-image-runtime'],
+    requires: [{ type: 'capability', id: 'files-runtime' }],
     optionalIntegrations: [],
   },
   {
@@ -96,7 +151,27 @@ describe('module dependency helpers', () => {
     }
   });
 
-  it('builds a concrete install plan in non-interactive mode with --with-required', async () => {
+  it('fails in non-interactive mode with --with-required when capability provider mapping is ambiguous', async () => {
+    const targetRoot = mkTmp('forgeon-deps-provider-required-');
+
+    try {
+      await assert.rejects(
+        () =>
+          resolveModuleInstallPlan({
+            moduleId: 'files',
+            targetRoot,
+            presets: TEST_PRESETS,
+            withRequired: true,
+            isInteractive: false,
+          }),
+        /required capability "files-storage-adapter" is missing/,
+      );
+    } finally {
+      fs.rmSync(targetRoot, { recursive: true, force: true });
+    }
+  });
+
+  it('builds a concrete install plan in non-interactive mode with --with-required and --provider', async () => {
     const targetRoot = mkTmp('forgeon-deps-plan-');
 
     try {
@@ -105,12 +180,99 @@ describe('module dependency helpers', () => {
         targetRoot,
         presets: TEST_PRESETS,
         withRequired: true,
+        providerSelections: {
+          'files-storage-adapter': 'files-local',
+        },
         isInteractive: false,
       });
 
       assert.equal(result.cancelled, false);
-      assert.deepEqual(result.moduleSequence, ['db-prisma', 'files']);
-      assert.deepEqual(result.selectedProviders, { 'db-adapter': 'db-prisma' });
+      assert.deepEqual(result.moduleSequence, ['db-prisma', 'files-local', 'files']);
+      assert.deepEqual(result.selectedProviders, {
+        'db-adapter': 'db-prisma',
+        'files-storage-adapter': 'files-local',
+      });
+    } finally {
+      fs.rmSync(targetRoot, { recursive: true, force: true });
+    }
+  });
+
+  it('resolves files-access plan through files-runtime capability chain', async () => {
+    const targetRoot = mkTmp('forgeon-deps-files-access-plan-');
+
+    try {
+      const result = await resolveModuleInstallPlan({
+        moduleId: 'files-access',
+        targetRoot,
+        presets: TEST_PRESETS,
+        withRequired: true,
+        providerSelections: {
+          'files-storage-adapter': 'files-local',
+        },
+        isInteractive: false,
+      });
+
+      assert.equal(result.cancelled, false);
+      assert.deepEqual(result.moduleSequence, ['db-prisma', 'files-local', 'files', 'files-access']);
+      assert.deepEqual(result.selectedProviders, {
+        'db-adapter': 'db-prisma',
+        'files-storage-adapter': 'files-local',
+        'files-runtime': 'files',
+      });
+    } finally {
+      fs.rmSync(targetRoot, { recursive: true, force: true });
+    }
+  });
+
+  it('resolves files-quotas plan through files-runtime capability chain', async () => {
+    const targetRoot = mkTmp('forgeon-deps-files-quotas-plan-');
+
+    try {
+      const result = await resolveModuleInstallPlan({
+        moduleId: 'files-quotas',
+        targetRoot,
+        presets: TEST_PRESETS,
+        withRequired: true,
+        providerSelections: {
+          'files-storage-adapter': 'files-local',
+        },
+        isInteractive: false,
+      });
+
+      assert.equal(result.cancelled, false);
+      assert.deepEqual(result.moduleSequence, ['db-prisma', 'files-local', 'files', 'files-quotas']);
+      assert.deepEqual(result.selectedProviders, {
+        'db-adapter': 'db-prisma',
+        'files-storage-adapter': 'files-local',
+        'files-runtime': 'files',
+      });
+    } finally {
+      fs.rmSync(targetRoot, { recursive: true, force: true });
+    }
+  });
+
+  it('resolves files-image plan through files-runtime capability chain', async () => {
+    const targetRoot = mkTmp('forgeon-deps-files-image-plan-');
+
+    try {
+      const result = await resolveModuleInstallPlan({
+        moduleId: 'files-image',
+        targetRoot,
+        presets: TEST_PRESETS,
+        withRequired: true,
+        providerSelections: {
+          'files-storage-adapter': 'files-local',
+        },
+        isInteractive: false,
+      });
+
+      assert.equal(result.cancelled, false);
+      assert.deepEqual(result.moduleSequence, ['db-prisma', 'files-local', 'files', 'files-image']);
+      assert.deepEqual(result.selectedProviders, {
+        'db-adapter': 'db-prisma',
+        'files-storage-adapter': 'files-local',
+        'files-runtime': 'files',
+      });
     } finally {
       fs.rmSync(targetRoot, { recursive: true, force: true });
     }
@@ -155,4 +317,44 @@ describe('module dependency helpers', () => {
       fs.rmSync(targetRoot, { recursive: true, force: true });
     }
   });
+
+  it('reports pending recommended companions for installed module context', () => {
+    const targetRoot = mkTmp('forgeon-deps-recommended-');
+    try {
+      fs.mkdirSync(path.join(targetRoot, 'packages', 'files'), { recursive: true });
+      fs.writeFileSync(path.join(targetRoot, 'packages', 'files', 'package.json'), '{}\n', 'utf8');
+
+      const pending = getPendingRecommendedCompanions({
+        moduleId: 'files',
+        targetRoot,
+        presets: TEST_PRESETS,
+      });
+
+      assert.equal(pending.length, 1);
+      assert.equal(pending[0].id, 'files-image');
+      assert.match(pending[0].title, /Files Image Hardening/);
+    } finally {
+      fs.rmSync(targetRoot, { recursive: true, force: true });
+    }
+  });
+
+  it('does not report recommended companions that are already installed', () => {
+    const targetRoot = mkTmp('forgeon-deps-recommended-installed-');
+    try {
+      fs.mkdirSync(path.join(targetRoot, 'packages', 'files'), { recursive: true });
+      fs.mkdirSync(path.join(targetRoot, 'packages', 'files-image'), { recursive: true });
+      fs.writeFileSync(path.join(targetRoot, 'packages', 'files', 'package.json'), '{}\n', 'utf8');
+      fs.writeFileSync(path.join(targetRoot, 'packages', 'files-image', 'package.json'), '{}\n', 'utf8');
+
+      const pending = getPendingRecommendedCompanions({
+        moduleId: 'files',
+        targetRoot,
+        presets: TEST_PRESETS,
+      });
+
+      assert.equal(pending.length, 0);
+    } finally {
+      fs.rmSync(targetRoot, { recursive: true, force: true });
+    }
+  });
 });

package/src/modules/executor.mjs

@@ -3,11 +3,18 @@ import path from 'node:path';
 import { ensureModuleExists } from './registry.mjs';
 import { writeModuleDocs } from './docs.mjs';
 import { applyDbPrismaModule } from './db-prisma.mjs';
+import { applyFilesModule } from './files.mjs';
+import { applyFilesAccessModule } from './files-access.mjs';
+import { applyFilesImageModule } from './files-image.mjs';
+import { applyFilesQuotasModule } from './files-quotas.mjs';
+import { applyFilesLocalModule } from './files-local.mjs';
+import { applyFilesS3Module } from './files-s3.mjs';
 import { applyI18nModule } from './i18n.mjs';
 import { applyJwtAuthModule } from './jwt-auth.mjs';
 import { applyLoggerModule } from './logger.mjs';
 import { applyRateLimitModule } from './rate-limit.mjs';
 import { applyRbacModule } from './rbac.mjs';
+import { applyQueueModule } from './queue.mjs';
 import { applySwaggerModule } from './swagger.mjs';
 
 function ensureForgeonLikeProject(targetRoot) {
@@ -28,9 +35,16 @@ function ensureForgeonLikeProject(targetRoot) {
 
 const MODULE_APPLIERS = {
   'db-prisma': applyDbPrismaModule,
+  files: applyFilesModule,
+  'files-access': applyFilesAccessModule,
+  'files-image': applyFilesImageModule,
+  'files-quotas': applyFilesQuotasModule,
+  'files-local': applyFilesLocalModule,
+  'files-s3': applyFilesS3Module,
   i18n: applyI18nModule,
   'jwt-auth': applyJwtAuthModule,
   logger: applyLoggerModule,
+  queue: applyQueueModule,
   'rate-limit': applyRateLimitModule,
   rbac: applyRbacModule,
   swagger: applySwaggerModule,