Add init command support to CLI and enhance tests

- Introduced the `init` command in the CLI, routing it to a new `runInitImpl` function for initializing project structure.
- Updated CLI usage messages to include the new `init` command for better user guidance.
- Added comprehensive tests for the `init` command, ensuring proper functionality and integration with the CLI.
- Created a new `init-command.ts` file to handle initialization logic, including file creation and package updates.

These changes improve the CLI's usability and extend its functionality, providing users with a streamlined way to set up their projects.

Author: nicnocquee

packages/dataqueue/src/cli.test.ts

@@ -22,6 +22,7 @@ function makeDeps() {
     exit: vi.fn(),
     spawnSyncImpl: vi.fn(() => makeSpawnSyncReturns(0)),
     migrationsDir: '/migrations',
+    runInitImpl: vi.fn(),
   } satisfies CliDeps;
 }
 
@@ -34,20 +35,30 @@ describe('runCli', () => {
 
   it('prints usage and exits with code 1 for no command', () => {
     runCli(['node', 'cli.js'], deps);
-    expect(deps.log).toHaveBeenCalledWith(
-      'Usage: dataqueue-cli migrate [--envPath <path>] [-s <schema> | --schema <schema>]',
-    );
+    expect(deps.log).toHaveBeenCalledWith('Usage:');
+    expect(deps.log).toHaveBeenCalledWith('  dataqueue-cli init');
     expect(deps.exit).toHaveBeenCalledWith(1);
   });
 
   it('prints usage and exits with code 1 for unknown command', () => {
     runCli(['node', 'cli.js', 'unknown'], deps);
-    expect(deps.log).toHaveBeenCalledWith(
-      'Usage: dataqueue-cli migrate [--envPath <path>] [-s <schema> | --schema <schema>]',
-    );
+    expect(deps.log).toHaveBeenCalledWith('Usage:');
+    expect(deps.log).toHaveBeenCalledWith('  dataqueue-cli init');
     expect(deps.exit).toHaveBeenCalledWith(1);
   });
 
+  it('routes init command to runInitImpl', () => {
+    runCli(['node', 'cli.js', 'init'], deps);
+    expect(deps.runInitImpl).toHaveBeenCalledWith(
+      expect.objectContaining({
+        log: deps.log,
+        error: deps.error,
+        exit: deps.exit,
+      }),
+    );
+    expect(deps.spawnSyncImpl).not.toHaveBeenCalled();
+  });
+
   it('calls spawnSyncImpl with correct args for migrate', () => {
     runCli(['node', 'cli.js', 'migrate'], deps);
     expect(deps.spawnSyncImpl).toHaveBeenCalledWith(

packages/dataqueue/src/cli.ts

@@ -2,6 +2,7 @@
 import { spawnSync, SpawnSyncReturns } from 'child_process';
 import path from 'path';
 import { fileURLToPath } from 'url';
+import { InitDeps, runInit } from './init-command.js';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -12,25 +13,35 @@ export interface CliDeps {
   exit?: (code: number) => void;
   spawnSyncImpl?: (...args: any[]) => SpawnSyncReturns<any>;
   migrationsDir?: string;
+  initDeps?: InitDeps;
+  runInitImpl?: (deps?: InitDeps) => void;
 }
 
 export function runCli(
   argv: string[],
   {
     log = console.log,
+    error = console.error,
     exit = (code: number) => process.exit(code),
     spawnSyncImpl = spawnSync,
     migrationsDir = path.join(__dirname, '../migrations'),
+    initDeps,
+    runInitImpl = runInit,
   }: CliDeps = {},
 ): void {
   const [, , command, ...restArgs] = argv;
 
+  /**
+   * Prints CLI usage and exits with non-zero code.
+   */
   function printUsage() {
+    log('Usage:');
     log(
-      'Usage: dataqueue-cli migrate [--envPath <path>] [-s <schema> | --schema <schema>]',
+      '  dataqueue-cli migrate [--envPath <path>] [-s <schema> | --schema <schema>]',
     );
+    log('  dataqueue-cli init');
     log('');
-    log('Options:');
+    log('Options for migrate:');
     log(
       '  --envPath <path>   Path to a .env file to load environment variables (passed to node-pg-migrate)',
     );
@@ -48,6 +59,14 @@ export function runCli(
     log(
       '    Example: PGSSLMODE=require NODE_EXTRA_CA_CERTS=/absolute/path/to/ca.crt PG_DATAQUEUE_DATABASE=... npx dataqueue-cli migrate',
     );
+    log('');
+    log('Notes for init:');
+    log(
+      '  - Supports both Next.js App Router and Pages Router (prefers App Router if both exist).',
+    );
+    log(
+      '  - Scaffolds endpoint, cron.sh, queue placeholder, and package.json entries.',
+    );
     exit(1);
   }
 
@@ -89,6 +108,13 @@ export function runCli(
       { stdio: 'inherit' },
     );
     exit(result.status ?? 1);
+  } else if (command === 'init') {
+    runInitImpl({
+      log,
+      error,
+      exit,
+      ...initDeps,
+    });
   } else {
     printUsage();
   }