create-efc-app 0.1.0

package/dist/index.js

@@ -0,0 +1,306 @@
+#!/usr/bin/env node
+
+// src/index.ts
+import * as p from "@clack/prompts";
+import chalk from "chalk";
+import { spawn } from "child_process";
+
+// src/scaffold.ts
+import fs from "fs-extra";
+import path from "path";
+import crypto from "crypto";
+async function scaffold(opts) {
+  const dest = path.resolve(process.cwd(), opts.projectName);
+  await fs.ensureDir(dest);
+  await writePackageJson(dest, opts);
+  await writeTsConfig(dest, opts);
+  await writeEfcConfig(dest, opts);
+  await writeEntryPoint(dest, opts);
+  await writeGitignore(dest);
+  await writeEnvFiles(dest);
+  await writeExampleRoute(dest, opts);
+  if (opts.tasks) await writeExampleTask(dest, opts);
+}
+async function writePackageJson(dest, opts) {
+  const deps = {
+    "express-file-cluster": "^0.1.0"
+  };
+  if (opts.database === "mongodb") deps["mongoose"] = "^8.0.0";
+  if (opts.database === "postgresql") {
+    deps["pg"] = "^8.0.0";
+    deps["drizzle-orm"] = "^0.33.0";
+  }
+  if (opts.tasks && opts.taskBackend === "bullmq") deps["bullmq"] = "^5.0.0";
+  if (opts.tasks && opts.taskBackend === "pg-boss") deps["pg-boss"] = "^10.0.0";
+  const devDeps = {
+    vitest: "^2.0.0"
+  };
+  if (opts.language === "typescript") {
+    devDeps["typescript"] = "^5.5.0";
+    devDeps["@types/node"] = "^22.0.0";
+    devDeps["@types/express"] = "^4.17.21";
+    devDeps["tsup"] = "^8.2.0";
+    devDeps["tsx"] = "^4.0.0";
+  }
+  const pkg = {
+    name: opts.projectName,
+    version: "0.1.0",
+    type: "module",
+    scripts: {
+      dev: "efc start dev",
+      build: "efc build prod",
+      start: "efc start prod",
+      test: "efc run tests"
+    },
+    dependencies: deps,
+    devDependencies: devDeps
+  };
+  await fs.writeJson(path.join(dest, "package.json"), pkg, { spaces: 2 });
+}
+async function writeTsConfig(dest, opts) {
+  if (opts.language !== "typescript") return;
+  const config = {
+    compilerOptions: {
+      target: "ES2022",
+      module: "NodeNext",
+      moduleResolution: "NodeNext",
+      strict: true,
+      esModuleInterop: true,
+      skipLibCheck: true,
+      outDir: "./dist",
+      rootDir: "./src"
+    },
+    include: ["src/**/*"],
+    exclude: ["node_modules", "dist"]
+  };
+  await fs.writeJson(path.join(dest, "tsconfig.json"), config, { spaces: 2 });
+}
+async function writeEfcConfig(dest, opts) {
+  const ext = opts.language === "typescript" ? "ts" : "js";
+  const tasks = opts.tasks ? `{
+    backend: '${opts.taskBackend ?? "bullmq"}',
+    redisUrl: process.env.REDIS_URL,
+    concurrency: 5,
+  }` : "false";
+  const content = `import type { EFCConfig } from 'express-file-cluster';
+
+const config: EFCConfig = {
+  port: Number(process.env.PORT) || 3000,
+  apiDir: './src/api',
+  tasksDir: './src/tasks',
+  database: '${opts.database}',
+  databaseUrl: process.env.DATABASE_URL!,
+  authStrategy: '${opts.authStrategy}',
+  jwtSecret: process.env.JWT_SECRET!,
+  cluster: process.env.NODE_ENV === 'production',
+  tasks: ${tasks},
+  globalMiddlewares: [],
+};
+
+export default config;
+`;
+  await fs.outputFile(path.join(dest, `efc.config.${ext}`), content);
+}
+async function writeEntryPoint(dest, opts) {
+  const ext = opts.language === "typescript" ? "ts" : "js";
+  const content = `import { ignite } from 'express-file-cluster';
+import { fileURLToPath } from 'url';
+import path from 'path';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+ignite({
+  port: Number(process.env.PORT) || 3000,
+  apiDir: path.join(__dirname, 'api'),
+  tasksDir: path.join(__dirname, 'tasks'),
+  database: '${opts.database}',
+  databaseUrl: process.env.DATABASE_URL,
+  authStrategy: '${opts.authStrategy}',
+  jwtSecret: process.env.JWT_SECRET,
+  cluster: process.env.NODE_ENV === 'production',
+}).catch(console.error);
+`;
+  await fs.outputFile(path.join(dest, "src", `index.${ext}`), content);
+}
+async function writeGitignore(dest) {
+  await fs.outputFile(
+    path.join(dest, ".gitignore"),
+    "node_modules/\ndist/\n.env\n.env.local\n*.log\n"
+  );
+}
+async function writeEnvFiles(dest) {
+  const secret = crypto.randomBytes(64).toString("hex");
+  const dotenv = `PORT=3000
+NODE_ENV=development
+DATABASE_URL=
+JWT_SECRET=${secret}
+REDIS_URL=redis://localhost:6379
+`;
+  const example = `PORT=3000
+NODE_ENV=development
+DATABASE_URL=
+JWT_SECRET=<generate with: openssl rand -hex 64>
+REDIS_URL=redis://localhost:6379
+`;
+  await fs.outputFile(path.join(dest, ".env"), dotenv);
+  await fs.outputFile(path.join(dest, ".env.example"), example);
+}
+async function writeExampleRoute(dest, opts) {
+  const ext = opts.language === "typescript" ? "ts" : "js";
+  const content = opts.language === "typescript" ? `import type { Request, Response } from 'express';
+
+export const GET = async (_req: Request, res: Response) => {
+  res.json({ status: 'OK', timestamp: new Date().toISOString() });
+};
+` : `export const GET = async (_req, res) => {
+  res.json({ status: 'OK', timestamp: new Date().toISOString() });
+};
+`;
+  await fs.outputFile(path.join(dest, "src", "api", `health.${ext}`), content);
+}
+async function writeExampleTask(dest, opts) {
+  const ext = opts.language === "typescript" ? "ts" : "js";
+  const content = opts.language === "typescript" ? `import { defineTask } from 'express-file-cluster/tasks';
+
+interface SendEmailPayload {
+  to: string;
+  subject: string;
+  body: string;
+}
+
+export default defineTask<SendEmailPayload>(async (payload) => {
+  // TODO: wire up your mailer
+  console.log('[SendEmail] Sending to', payload.to);
+});
+` : `import { defineTask } from 'express-file-cluster/tasks';
+
+export default defineTask(async (payload) => {
+  console.log('[SendEmail] Sending to', payload.to);
+});
+`;
+  await fs.outputFile(path.join(dest, "src", "tasks", `SendEmail.${ext}`), content);
+}
+
+// src/index.ts
+async function main() {
+  console.log();
+  p.intro(chalk.bgCyan(chalk.black(" create-efc-app ")));
+  const projectName = await p.text({
+    message: "Project name:",
+    placeholder: "my-api",
+    defaultValue: "my-api",
+    validate: (v) => !v.trim() ? "Project name is required" : void 0
+  });
+  if (p.isCancel(projectName)) {
+    p.cancel("Cancelled");
+    process.exit(0);
+  }
+  const language = await p.select({
+    message: "Language:",
+    options: [
+      { value: "typescript", label: "TypeScript", hint: "recommended" },
+      { value: "javascript", label: "JavaScript" }
+    ]
+  });
+  if (p.isCancel(language)) {
+    p.cancel("Cancelled");
+    process.exit(0);
+  }
+  const database = await p.select({
+    message: "Database:",
+    options: [
+      { value: "mongodb", label: "MongoDB", hint: "Mongoose" },
+      { value: "postgresql", label: "PostgreSQL", hint: "Drizzle ORM" }
+    ]
+  });
+  if (p.isCancel(database)) {
+    p.cancel("Cancelled");
+    process.exit(0);
+  }
+  const authStrategy = await p.select({
+    message: "Authentication strategy:",
+    options: [
+      { value: "http-only", label: "http-only", hint: "secure cookie \u2014 recommended for SSR" },
+      { value: "localStorage", label: "localStorage", hint: "bearer token \u2014 for SPAs" }
+    ]
+  });
+  if (p.isCancel(authStrategy)) {
+    p.cancel("Cancelled");
+    process.exit(0);
+  }
+  const cluster = await p.confirm({
+    message: "Enable multi-core clustering?",
+    initialValue: true
+  });
+  if (p.isCancel(cluster)) {
+    p.cancel("Cancelled");
+    process.exit(0);
+  }
+  const tasks = await p.confirm({
+    message: "Enable background tasks?",
+    initialValue: true
+  });
+  if (p.isCancel(tasks)) {
+    p.cancel("Cancelled");
+    process.exit(0);
+  }
+  let taskBackend;
+  if (tasks) {
+    const backend = await p.select({
+      message: "Task queue backend:",
+      options: [
+        { value: "bullmq", label: "BullMQ", hint: "Redis" },
+        { value: "pg-boss", label: "pg-boss", hint: "PostgreSQL" }
+      ]
+    });
+    if (p.isCancel(backend)) {
+      p.cancel("Cancelled");
+      process.exit(0);
+    }
+    taskBackend = backend;
+  }
+  const opts = {
+    projectName,
+    language,
+    database,
+    authStrategy,
+    cluster,
+    tasks,
+    ...taskBackend !== void 0 && { taskBackend }
+  };
+  const spinner2 = p.spinner();
+  spinner2.start("Scaffolding project\u2026");
+  try {
+    await scaffold(opts);
+    spinner2.stop("Project created");
+  } catch (err) {
+    spinner2.stop("Failed to scaffold project");
+    console.error(err);
+    process.exit(1);
+  }
+  spinner2.start("Installing dependencies\u2026");
+  await npmInstall(projectName);
+  spinner2.stop("Dependencies installed");
+  p.outro(
+    chalk.green(`
+Your project is ready!
+
+`) + chalk.dim(`  cd ${projectName}
+`) + chalk.dim(`  npm run dev
+`)
+  );
+}
+function npmInstall(projectDir) {
+  return new Promise((resolve, reject) => {
+    const child = spawn("npm", ["install"], {
+      cwd: projectDir,
+      stdio: "ignore"
+    });
+    child.on("exit", (code) => code === 0 ? resolve() : reject(new Error(`npm install failed`)));
+  });
+}
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/scaffold.ts"],"sourcesContent":["import * as p from '@clack/prompts';\nimport chalk from 'chalk';\nimport { spawn } from 'node:child_process';\nimport { scaffold, type ScaffoldOptions } from './scaffold.js';\n\nasync function main(): Promise<void> {\n  console.log();\n  p.intro(chalk.bgCyan(chalk.black(' create-efc-app ')));\n\n  const projectName = await p.text({\n    message: 'Project name:',\n    placeholder: 'my-api',\n    defaultValue: 'my-api',\n    validate: (v) => (!v.trim() ? 'Project name is required' : undefined),\n  });\n  if (p.isCancel(projectName)) { p.cancel('Cancelled'); process.exit(0); }\n\n  const language = await p.select({\n    message: 'Language:',\n    options: [\n      { value: 'typescript', label: 'TypeScript', hint: 'recommended' },\n      { value: 'javascript', label: 'JavaScript' },\n    ],\n  });\n  if (p.isCancel(language)) { p.cancel('Cancelled'); process.exit(0); }\n\n  const database = await p.select({\n    message: 'Database:',\n    options: [\n      { value: 'mongodb', label: 'MongoDB', hint: 'Mongoose' },\n      { value: 'postgresql', label: 'PostgreSQL', hint: 'Drizzle ORM' },\n    ],\n  });\n  if (p.isCancel(database)) { p.cancel('Cancelled'); process.exit(0); }\n\n  const authStrategy = await p.select({\n    message: 'Authentication strategy:',\n    options: [\n      { value: 'http-only', label: 'http-only', hint: 'secure cookie — recommended for SSR' },\n      { value: 'localStorage', label: 'localStorage', hint: 'bearer token — for SPAs' },\n    ],\n  });\n  if (p.isCancel(authStrategy)) { p.cancel('Cancelled'); process.exit(0); }\n\n  const cluster = await p.confirm({\n    message: 'Enable multi-core clustering?',\n    initialValue: true,\n  });\n  if (p.isCancel(cluster)) { p.cancel('Cancelled'); process.exit(0); }\n\n  const tasks = await p.confirm({\n    message: 'Enable background tasks?',\n    initialValue: true,\n  });\n  if (p.isCancel(tasks)) { p.cancel('Cancelled'); process.exit(0); }\n\n  let taskBackend: ScaffoldOptions['taskBackend'];\n  if (tasks) {\n    const backend = await p.select({\n      message: 'Task queue backend:',\n      options: [\n        { value: 'bullmq', label: 'BullMQ', hint: 'Redis' },\n        { value: 'pg-boss', label: 'pg-boss', hint: 'PostgreSQL' },\n      ],\n    });\n    if (p.isCancel(backend)) { p.cancel('Cancelled'); process.exit(0); }\n    taskBackend = backend as ScaffoldOptions['taskBackend'];\n  }\n\n  const opts: ScaffoldOptions = {\n    projectName: projectName as string,\n    language: language as ScaffoldOptions['language'],\n    database: database as ScaffoldOptions['database'],\n    authStrategy: authStrategy as ScaffoldOptions['authStrategy'],\n    cluster: cluster as boolean,\n    tasks: tasks as boolean,\n    ...(taskBackend !== undefined && { taskBackend }),\n  };\n\n  const spinner = p.spinner();\n  spinner.start('Scaffolding project…');\n\n  try {\n    await scaffold(opts);\n    spinner.stop('Project created');\n  } catch (err) {\n    spinner.stop('Failed to scaffold project');\n    console.error(err);\n    process.exit(1);\n  }\n\n  spinner.start('Installing dependencies…');\n  await npmInstall(projectName as string);\n  spinner.stop('Dependencies installed');\n\n  p.outro(\n    chalk.green(`\\nYour project is ready!\\n\\n`) +\n    chalk.dim(`  cd ${projectName as string}\\n`) +\n    chalk.dim(`  npm run dev\\n`),\n  );\n}\n\nfunction npmInstall(projectDir: string): Promise<void> {\n  return new Promise((resolve, reject) => {\n    const child = spawn('npm', ['install'], {\n      cwd: projectDir,\n      stdio: 'ignore',\n    });\n    child.on('exit', (code) => (code === 0 ? resolve() : reject(new Error(`npm install failed`))));\n  });\n}\n\nmain().catch((err) => {\n  console.error(err);\n  process.exit(1);\n});\n","import fs from 'fs-extra';\nimport path from 'node:path';\nimport crypto from 'node:crypto';\n\nexport interface ScaffoldOptions {\n  projectName: string;\n  language: 'typescript' | 'javascript';\n  database: 'mongodb' | 'postgresql';\n  authStrategy: 'http-only' | 'localStorage';\n  cluster: boolean;\n  tasks: boolean;\n  taskBackend?: 'bullmq' | 'pg-boss';\n}\n\nexport async function scaffold(opts: ScaffoldOptions): Promise<void> {\n  const dest = path.resolve(process.cwd(), opts.projectName);\n  await fs.ensureDir(dest);\n\n  await writePackageJson(dest, opts);\n  await writeTsConfig(dest, opts);\n  await writeEfcConfig(dest, opts);\n  await writeEntryPoint(dest, opts);\n  await writeGitignore(dest);\n  await writeEnvFiles(dest);\n  await writeExampleRoute(dest, opts);\n  if (opts.tasks) await writeExampleTask(dest, opts);\n}\n\nasync function writePackageJson(dest: string, opts: ScaffoldOptions): Promise<void> {\n  const deps: Record<string, string> = {\n    'express-file-cluster': '^0.1.0',\n  };\n  if (opts.database === 'mongodb') deps['mongoose'] = '^8.0.0';\n  if (opts.database === 'postgresql') {\n    deps['pg'] = '^8.0.0';\n    deps['drizzle-orm'] = '^0.33.0';\n  }\n  if (opts.tasks && opts.taskBackend === 'bullmq') deps['bullmq'] = '^5.0.0';\n  if (opts.tasks && opts.taskBackend === 'pg-boss') deps['pg-boss'] = '^10.0.0';\n\n  const devDeps: Record<string, string> = {\n    vitest: '^2.0.0',\n  };\n  if (opts.language === 'typescript') {\n    devDeps['typescript'] = '^5.5.0';\n    devDeps['@types/node'] = '^22.0.0';\n    devDeps['@types/express'] = '^4.17.21';\n    devDeps['tsup'] = '^8.2.0';\n    devDeps['tsx'] = '^4.0.0';\n  }\n\n  const pkg = {\n    name: opts.projectName,\n    version: '0.1.0',\n    type: 'module',\n    scripts: {\n      dev: 'efc start dev',\n      build: 'efc build prod',\n      start: 'efc start prod',\n      test: 'efc run tests',\n    },\n    dependencies: deps,\n    devDependencies: devDeps,\n  };\n\n  await fs.writeJson(path.join(dest, 'package.json'), pkg, { spaces: 2 });\n}\n\nasync function writeTsConfig(dest: string, opts: ScaffoldOptions): Promise<void> {\n  if (opts.language !== 'typescript') return;\n  const config = {\n    compilerOptions: {\n      target: 'ES2022',\n      module: 'NodeNext',\n      moduleResolution: 'NodeNext',\n      strict: true,\n      esModuleInterop: true,\n      skipLibCheck: true,\n      outDir: './dist',\n      rootDir: './src',\n    },\n    include: ['src/**/*'],\n    exclude: ['node_modules', 'dist'],\n  };\n  await fs.writeJson(path.join(dest, 'tsconfig.json'), config, { spaces: 2 });\n}\n\nasync function writeEfcConfig(dest: string, opts: ScaffoldOptions): Promise<void> {\n  const ext = opts.language === 'typescript' ? 'ts' : 'js';\n  const tasks = opts.tasks\n    ? `{\n    backend: '${opts.taskBackend ?? 'bullmq'}',\n    redisUrl: process.env.REDIS_URL,\n    concurrency: 5,\n  }`\n    : 'false';\n\n  const content = `import type { EFCConfig } from 'express-file-cluster';\n\nconst config: EFCConfig = {\n  port: Number(process.env.PORT) || 3000,\n  apiDir: './src/api',\n  tasksDir: './src/tasks',\n  database: '${opts.database}',\n  databaseUrl: process.env.DATABASE_URL!,\n  authStrategy: '${opts.authStrategy}',\n  jwtSecret: process.env.JWT_SECRET!,\n  cluster: process.env.NODE_ENV === 'production',\n  tasks: ${tasks},\n  globalMiddlewares: [],\n};\n\nexport default config;\n`;\n  await fs.outputFile(path.join(dest, `efc.config.${ext}`), content);\n}\n\nasync function writeEntryPoint(dest: string, opts: ScaffoldOptions): Promise<void> {\n  const ext = opts.language === 'typescript' ? 'ts' : 'js';\n  const content = `import { ignite } from 'express-file-cluster';\nimport { fileURLToPath } from 'url';\nimport path from 'path';\n\nconst __dirname = path.dirname(fileURLToPath(import.meta.url));\n\nignite({\n  port: Number(process.env.PORT) || 3000,\n  apiDir: path.join(__dirname, 'api'),\n  tasksDir: path.join(__dirname, 'tasks'),\n  database: '${opts.database}',\n  databaseUrl: process.env.DATABASE_URL,\n  authStrategy: '${opts.authStrategy}',\n  jwtSecret: process.env.JWT_SECRET,\n  cluster: process.env.NODE_ENV === 'production',\n}).catch(console.error);\n`;\n  await fs.outputFile(path.join(dest, 'src', `index.${ext}`), content);\n}\n\nasync function writeGitignore(dest: string): Promise<void> {\n  await fs.outputFile(\n    path.join(dest, '.gitignore'),\n    'node_modules/\\ndist/\\n.env\\n.env.local\\n*.log\\n',\n  );\n}\n\nasync function writeEnvFiles(dest: string): Promise<void> {\n  const secret = crypto.randomBytes(64).toString('hex');\n  const dotenv = `PORT=3000\\nNODE_ENV=development\\nDATABASE_URL=\\nJWT_SECRET=${secret}\\nREDIS_URL=redis://localhost:6379\\n`;\n  const example = `PORT=3000\\nNODE_ENV=development\\nDATABASE_URL=\\nJWT_SECRET=<generate with: openssl rand -hex 64>\\nREDIS_URL=redis://localhost:6379\\n`;\n  await fs.outputFile(path.join(dest, '.env'), dotenv);\n  await fs.outputFile(path.join(dest, '.env.example'), example);\n}\n\nasync function writeExampleRoute(dest: string, opts: ScaffoldOptions): Promise<void> {\n  const ext = opts.language === 'typescript' ? 'ts' : 'js';\n  const content =\n    opts.language === 'typescript'\n      ? `import type { Request, Response } from 'express';\n\nexport const GET = async (_req: Request, res: Response) => {\n  res.json({ status: 'OK', timestamp: new Date().toISOString() });\n};\n`\n      : `export const GET = async (_req, res) => {\n  res.json({ status: 'OK', timestamp: new Date().toISOString() });\n};\n`;\n  await fs.outputFile(path.join(dest, 'src', 'api', `health.${ext}`), content);\n}\n\nasync function writeExampleTask(dest: string, opts: ScaffoldOptions): Promise<void> {\n  const ext = opts.language === 'typescript' ? 'ts' : 'js';\n  const content =\n    opts.language === 'typescript'\n      ? `import { defineTask } from 'express-file-cluster/tasks';\n\ninterface SendEmailPayload {\n  to: string;\n  subject: string;\n  body: string;\n}\n\nexport default defineTask<SendEmailPayload>(async (payload) => {\n  // TODO: wire up your mailer\n  console.log('[SendEmail] Sending to', payload.to);\n});\n`\n      : `import { defineTask } from 'express-file-cluster/tasks';\n\nexport default defineTask(async (payload) => {\n  console.log('[SendEmail] Sending to', payload.to);\n});\n`;\n  await fs.outputFile(path.join(dest, 'src', 'tasks', `SendEmail.${ext}`), content);\n}\n"],"mappings":";;;AAAA,YAAY,OAAO;AACnB,OAAO,WAAW;AAClB,SAAS,aAAa;;;ACFtB,OAAO,QAAQ;AACf,OAAO,UAAU;AACjB,OAAO,YAAY;AAYnB,eAAsB,SAAS,MAAsC;AACnE,QAAM,OAAO,KAAK,QAAQ,QAAQ,IAAI,GAAG,KAAK,WAAW;AACzD,QAAM,GAAG,UAAU,IAAI;AAEvB,QAAM,iBAAiB,MAAM,IAAI;AACjC,QAAM,cAAc,MAAM,IAAI;AAC9B,QAAM,eAAe,MAAM,IAAI;AAC/B,QAAM,gBAAgB,MAAM,IAAI;AAChC,QAAM,eAAe,IAAI;AACzB,QAAM,cAAc,IAAI;AACxB,QAAM,kBAAkB,MAAM,IAAI;AAClC,MAAI,KAAK,MAAO,OAAM,iBAAiB,MAAM,IAAI;AACnD;AAEA,eAAe,iBAAiB,MAAc,MAAsC;AAClF,QAAM,OAA+B;AAAA,IACnC,wBAAwB;AAAA,EAC1B;AACA,MAAI,KAAK,aAAa,UAAW,MAAK,UAAU,IAAI;AACpD,MAAI,KAAK,aAAa,cAAc;AAClC,SAAK,IAAI,IAAI;AACb,SAAK,aAAa,IAAI;AAAA,EACxB;AACA,MAAI,KAAK,SAAS,KAAK,gBAAgB,SAAU,MAAK,QAAQ,IAAI;AAClE,MAAI,KAAK,SAAS,KAAK,gBAAgB,UAAW,MAAK,SAAS,IAAI;AAEpE,QAAM,UAAkC;AAAA,IACtC,QAAQ;AAAA,EACV;AACA,MAAI,KAAK,aAAa,cAAc;AAClC,YAAQ,YAAY,IAAI;AACxB,YAAQ,aAAa,IAAI;AACzB,YAAQ,gBAAgB,IAAI;AAC5B,YAAQ,MAAM,IAAI;AAClB,YAAQ,KAAK,IAAI;AAAA,EACnB;AAEA,QAAM,MAAM;AAAA,IACV,MAAM,KAAK;AAAA,IACX,SAAS;AAAA,IACT,MAAM;AAAA,IACN,SAAS;AAAA,MACP,KAAK;AAAA,MACL,OAAO;AAAA,MACP,OAAO;AAAA,MACP,MAAM;AAAA,IACR;AAAA,IACA,cAAc;AAAA,IACd,iBAAiB;AAAA,EACnB;AAEA,QAAM,GAAG,UAAU,KAAK,KAAK,MAAM,cAAc,GAAG,KAAK,EAAE,QAAQ,EAAE,CAAC;AACxE;AAEA,eAAe,cAAc,MAAc,MAAsC;AAC/E,MAAI,KAAK,aAAa,aAAc;AACpC,QAAM,SAAS;AAAA,IACb,iBAAiB;AAAA,MACf,QAAQ;AAAA,MACR,QAAQ;AAAA,MACR,kBAAkB;AAAA,MAClB,QAAQ;AAAA,MACR,iBAAiB;AAAA,MACjB,cAAc;AAAA,MACd,QAAQ;AAAA,MACR,SAAS;AAAA,IACX;AAAA,IACA,SAAS,CAAC,UAAU;AAAA,IACpB,SAAS,CAAC,gBAAgB,MAAM;AAAA,EAClC;AACA,QAAM,GAAG,UAAU,KAAK,KAAK,MAAM,eAAe,GAAG,QAAQ,EAAE,QAAQ,EAAE,CAAC;AAC5E;AAEA,eAAe,eAAe,MAAc,MAAsC;AAChF,QAAM,MAAM,KAAK,aAAa,eAAe,OAAO;AACpD,QAAM,QAAQ,KAAK,QACf;AAAA,gBACU,KAAK,eAAe,QAAQ;AAAA;AAAA;AAAA,OAItC;AAEJ,QAAM,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,eAMH,KAAK,QAAQ;AAAA;AAAA,mBAET,KAAK,YAAY;AAAA;AAAA;AAAA,WAGzB,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA;AAMd,QAAM,GAAG,WAAW,KAAK,KAAK,MAAM,cAAc,GAAG,EAAE,GAAG,OAAO;AACnE;AAEA,eAAe,gBAAgB,MAAc,MAAsC;AACjF,QAAM,MAAM,KAAK,aAAa,eAAe,OAAO;AACpD,QAAM,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,eAUH,KAAK,QAAQ;AAAA;AAAA,mBAET,KAAK,YAAY;AAAA;AAAA;AAAA;AAAA;AAKlC,QAAM,GAAG,WAAW,KAAK,KAAK,MAAM,OAAO,SAAS,GAAG,EAAE,GAAG,OAAO;AACrE;AAEA,eAAe,eAAe,MAA6B;AACzD,QAAM,GAAG;AAAA,IACP,KAAK,KAAK,MAAM,YAAY;AAAA,IAC5B;AAAA,EACF;AACF;AAEA,eAAe,cAAc,MAA6B;AACxD,QAAM,SAAS,OAAO,YAAY,EAAE,EAAE,SAAS,KAAK;AACpD,QAAM,SAAS;AAAA;AAAA;AAAA,aAA8D,MAAM;AAAA;AAAA;AACnF,QAAM,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA;AAChB,QAAM,GAAG,WAAW,KAAK,KAAK,MAAM,MAAM,GAAG,MAAM;AACnD,QAAM,GAAG,WAAW,KAAK,KAAK,MAAM,cAAc,GAAG,OAAO;AAC9D;AAEA,eAAe,kBAAkB,MAAc,MAAsC;AACnF,QAAM,MAAM,KAAK,aAAa,eAAe,OAAO;AACpD,QAAM,UACJ,KAAK,aAAa,eACd;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA;AAAA;AAAA;AAAA;AAIN,QAAM,GAAG,WAAW,KAAK,KAAK,MAAM,OAAO,OAAO,UAAU,GAAG,EAAE,GAAG,OAAO;AAC7E;AAEA,eAAe,iBAAiB,MAAc,MAAsC;AAClF,QAAM,MAAM,KAAK,aAAa,eAAe,OAAO;AACpD,QAAM,UACJ,KAAK,aAAa,eACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAaA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMN,QAAM,GAAG,WAAW,KAAK,KAAK,MAAM,OAAO,SAAS,aAAa,GAAG,EAAE,GAAG,OAAO;AAClF;;;AD9LA,eAAe,OAAsB;AACnC,UAAQ,IAAI;AACZ,EAAE,QAAM,MAAM,OAAO,MAAM,MAAM,kBAAkB,CAAC,CAAC;AAErD,QAAM,cAAc,MAAQ,OAAK;AAAA,IAC/B,SAAS;AAAA,IACT,aAAa;AAAA,IACb,cAAc;AAAA,IACd,UAAU,CAAC,MAAO,CAAC,EAAE,KAAK,IAAI,6BAA6B;AAAA,EAC7D,CAAC;AACD,MAAM,WAAS,WAAW,GAAG;AAAE,IAAE,SAAO,WAAW;AAAG,YAAQ,KAAK,CAAC;AAAA,EAAG;AAEvE,QAAM,WAAW,MAAQ,SAAO;AAAA,IAC9B,SAAS;AAAA,IACT,SAAS;AAAA,MACP,EAAE,OAAO,cAAc,OAAO,cAAc,MAAM,cAAc;AAAA,MAChE,EAAE,OAAO,cAAc,OAAO,aAAa;AAAA,IAC7C;AAAA,EACF,CAAC;AACD,MAAM,WAAS,QAAQ,GAAG;AAAE,IAAE,SAAO,WAAW;AAAG,YAAQ,KAAK,CAAC;AAAA,EAAG;AAEpE,QAAM,WAAW,MAAQ,SAAO;AAAA,IAC9B,SAAS;AAAA,IACT,SAAS;AAAA,MACP,EAAE,OAAO,WAAW,OAAO,WAAW,MAAM,WAAW;AAAA,MACvD,EAAE,OAAO,cAAc,OAAO,cAAc,MAAM,cAAc;AAAA,IAClE;AAAA,EACF,CAAC;AACD,MAAM,WAAS,QAAQ,GAAG;AAAE,IAAE,SAAO,WAAW;AAAG,YAAQ,KAAK,CAAC;AAAA,EAAG;AAEpE,QAAM,eAAe,MAAQ,SAAO;AAAA,IAClC,SAAS;AAAA,IACT,SAAS;AAAA,MACP,EAAE,OAAO,aAAa,OAAO,aAAa,MAAM,2CAAsC;AAAA,MACtF,EAAE,OAAO,gBAAgB,OAAO,gBAAgB,MAAM,+BAA0B;AAAA,IAClF;AAAA,EACF,CAAC;AACD,MAAM,WAAS,YAAY,GAAG;AAAE,IAAE,SAAO,WAAW;AAAG,YAAQ,KAAK,CAAC;AAAA,EAAG;AAExE,QAAM,UAAU,MAAQ,UAAQ;AAAA,IAC9B,SAAS;AAAA,IACT,cAAc;AAAA,EAChB,CAAC;AACD,MAAM,WAAS,OAAO,GAAG;AAAE,IAAE,SAAO,WAAW;AAAG,YAAQ,KAAK,CAAC;AAAA,EAAG;AAEnE,QAAM,QAAQ,MAAQ,UAAQ;AAAA,IAC5B,SAAS;AAAA,IACT,cAAc;AAAA,EAChB,CAAC;AACD,MAAM,WAAS,KAAK,GAAG;AAAE,IAAE,SAAO,WAAW;AAAG,YAAQ,KAAK,CAAC;AAAA,EAAG;AAEjE,MAAI;AACJ,MAAI,OAAO;AACT,UAAM,UAAU,MAAQ,SAAO;AAAA,MAC7B,SAAS;AAAA,MACT,SAAS;AAAA,QACP,EAAE,OAAO,UAAU,OAAO,UAAU,MAAM,QAAQ;AAAA,QAClD,EAAE,OAAO,WAAW,OAAO,WAAW,MAAM,aAAa;AAAA,MAC3D;AAAA,IACF,CAAC;AACD,QAAM,WAAS,OAAO,GAAG;AAAE,MAAE,SAAO,WAAW;AAAG,cAAQ,KAAK,CAAC;AAAA,IAAG;AACnE,kBAAc;AAAA,EAChB;AAEA,QAAM,OAAwB;AAAA,IAC5B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,GAAI,gBAAgB,UAAa,EAAE,YAAY;AAAA,EACjD;AAEA,QAAMA,WAAY,UAAQ;AAC1B,EAAAA,SAAQ,MAAM,2BAAsB;AAEpC,MAAI;AACF,UAAM,SAAS,IAAI;AACnB,IAAAA,SAAQ,KAAK,iBAAiB;AAAA,EAChC,SAAS,KAAK;AACZ,IAAAA,SAAQ,KAAK,4BAA4B;AACzC,YAAQ,MAAM,GAAG;AACjB,YAAQ,KAAK,CAAC;AAAA,EAChB;AAEA,EAAAA,SAAQ,MAAM,+BAA0B;AACxC,QAAM,WAAW,WAAqB;AACtC,EAAAA,SAAQ,KAAK,wBAAwB;AAErC,EAAE;AAAA,IACA,MAAM,MAAM;AAAA;AAAA;AAAA,CAA8B,IAC1C,MAAM,IAAI,QAAQ,WAAqB;AAAA,CAAI,IAC3C,MAAM,IAAI;AAAA,CAAiB;AAAA,EAC7B;AACF;AAEA,SAAS,WAAW,YAAmC;AACrD,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAM,QAAQ,MAAM,OAAO,CAAC,SAAS,GAAG;AAAA,MACtC,KAAK;AAAA,MACL,OAAO;AAAA,IACT,CAAC;AACD,UAAM,GAAG,QAAQ,CAAC,SAAU,SAAS,IAAI,QAAQ,IAAI,OAAO,IAAI,MAAM,oBAAoB,CAAC,CAAE;AAAA,EAC/F,CAAC;AACH;AAEA,KAAK,EAAE,MAAM,CAAC,QAAQ;AACpB,UAAQ,MAAM,GAAG;AACjB,UAAQ,KAAK,CAAC;AAChB,CAAC;","names":["spinner"]}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "create-efc-app",
+  "version": "0.1.0",
+  "description": "Interactive scaffolder for Express File Cluster projects",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "create-efc-app": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.7.0",
+    "chalk": "^5.3.0",
+    "fs-extra": "^11.2.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^22.0.0",
+    "tsup": "^8.2.0",
+    "typescript": "^5.5.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,116 @@
+import * as p from '@clack/prompts';
+import chalk from 'chalk';
+import { spawn } from 'node:child_process';
+import { scaffold, type ScaffoldOptions } from './scaffold.js';
+
+async function main(): Promise<void> {
+  console.log();
+  p.intro(chalk.bgCyan(chalk.black(' create-efc-app ')));
+
+  const projectName = await p.text({
+    message: 'Project name:',
+    placeholder: 'my-api',
+    defaultValue: 'my-api',
+    validate: (v) => (!v.trim() ? 'Project name is required' : undefined),
+  });
+  if (p.isCancel(projectName)) { p.cancel('Cancelled'); process.exit(0); }
+
+  const language = await p.select({
+    message: 'Language:',
+    options: [
+      { value: 'typescript', label: 'TypeScript', hint: 'recommended' },
+      { value: 'javascript', label: 'JavaScript' },
+    ],
+  });
+  if (p.isCancel(language)) { p.cancel('Cancelled'); process.exit(0); }
+
+  const database = await p.select({
+    message: 'Database:',
+    options: [
+      { value: 'mongodb', label: 'MongoDB', hint: 'Mongoose' },
+      { value: 'postgresql', label: 'PostgreSQL', hint: 'Drizzle ORM' },
+    ],
+  });
+  if (p.isCancel(database)) { p.cancel('Cancelled'); process.exit(0); }
+
+  const authStrategy = await p.select({
+    message: 'Authentication strategy:',
+    options: [
+      { value: 'http-only', label: 'http-only', hint: 'secure cookie — recommended for SSR' },
+      { value: 'localStorage', label: 'localStorage', hint: 'bearer token — for SPAs' },
+    ],
+  });
+  if (p.isCancel(authStrategy)) { p.cancel('Cancelled'); process.exit(0); }
+
+  const cluster = await p.confirm({
+    message: 'Enable multi-core clustering?',
+    initialValue: true,
+  });
+  if (p.isCancel(cluster)) { p.cancel('Cancelled'); process.exit(0); }
+
+  const tasks = await p.confirm({
+    message: 'Enable background tasks?',
+    initialValue: true,
+  });
+  if (p.isCancel(tasks)) { p.cancel('Cancelled'); process.exit(0); }
+
+  let taskBackend: ScaffoldOptions['taskBackend'];
+  if (tasks) {
+    const backend = await p.select({
+      message: 'Task queue backend:',
+      options: [
+        { value: 'bullmq', label: 'BullMQ', hint: 'Redis' },
+        { value: 'pg-boss', label: 'pg-boss', hint: 'PostgreSQL' },
+      ],
+    });
+    if (p.isCancel(backend)) { p.cancel('Cancelled'); process.exit(0); }
+    taskBackend = backend as ScaffoldOptions['taskBackend'];
+  }
+
+  const opts: ScaffoldOptions = {
+    projectName: projectName as string,
+    language: language as ScaffoldOptions['language'],
+    database: database as ScaffoldOptions['database'],
+    authStrategy: authStrategy as ScaffoldOptions['authStrategy'],
+    cluster: cluster as boolean,
+    tasks: tasks as boolean,
+    ...(taskBackend !== undefined && { taskBackend }),
+  };
+
+  const spinner = p.spinner();
+  spinner.start('Scaffolding project…');
+
+  try {
+    await scaffold(opts);
+    spinner.stop('Project created');
+  } catch (err) {
+    spinner.stop('Failed to scaffold project');
+    console.error(err);
+    process.exit(1);
+  }
+
+  spinner.start('Installing dependencies…');
+  await npmInstall(projectName as string);
+  spinner.stop('Dependencies installed');
+
+  p.outro(
+    chalk.green(`\nYour project is ready!\n\n`) +
+    chalk.dim(`  cd ${projectName as string}\n`) +
+    chalk.dim(`  npm run dev\n`),
+  );
+}
+
+function npmInstall(projectDir: string): Promise<void> {
+  return new Promise((resolve, reject) => {
+    const child = spawn('npm', ['install'], {
+      cwd: projectDir,
+      stdio: 'ignore',
+    });
+    child.on('exit', (code) => (code === 0 ? resolve() : reject(new Error(`npm install failed`))));
+  });
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/src/scaffold.ts

@@ -0,0 +1,196 @@
+import fs from 'fs-extra';
+import path from 'node:path';
+import crypto from 'node:crypto';
+
+export interface ScaffoldOptions {
+  projectName: string;
+  language: 'typescript' | 'javascript';
+  database: 'mongodb' | 'postgresql';
+  authStrategy: 'http-only' | 'localStorage';
+  cluster: boolean;
+  tasks: boolean;
+  taskBackend?: 'bullmq' | 'pg-boss';
+}
+
+export async function scaffold(opts: ScaffoldOptions): Promise<void> {
+  const dest = path.resolve(process.cwd(), opts.projectName);
+  await fs.ensureDir(dest);
+
+  await writePackageJson(dest, opts);
+  await writeTsConfig(dest, opts);
+  await writeEfcConfig(dest, opts);
+  await writeEntryPoint(dest, opts);
+  await writeGitignore(dest);
+  await writeEnvFiles(dest);
+  await writeExampleRoute(dest, opts);
+  if (opts.tasks) await writeExampleTask(dest, opts);
+}
+
+async function writePackageJson(dest: string, opts: ScaffoldOptions): Promise<void> {
+  const deps: Record<string, string> = {
+    'express-file-cluster': '^0.1.0',
+  };
+  if (opts.database === 'mongodb') deps['mongoose'] = '^8.0.0';
+  if (opts.database === 'postgresql') {
+    deps['pg'] = '^8.0.0';
+    deps['drizzle-orm'] = '^0.33.0';
+  }
+  if (opts.tasks && opts.taskBackend === 'bullmq') deps['bullmq'] = '^5.0.0';
+  if (opts.tasks && opts.taskBackend === 'pg-boss') deps['pg-boss'] = '^10.0.0';
+
+  const devDeps: Record<string, string> = {
+    vitest: '^2.0.0',
+  };
+  if (opts.language === 'typescript') {
+    devDeps['typescript'] = '^5.5.0';
+    devDeps['@types/node'] = '^22.0.0';
+    devDeps['@types/express'] = '^4.17.21';
+    devDeps['tsup'] = '^8.2.0';
+    devDeps['tsx'] = '^4.0.0';
+  }
+
+  const pkg = {
+    name: opts.projectName,
+    version: '0.1.0',
+    type: 'module',
+    scripts: {
+      dev: 'efc start dev',
+      build: 'efc build prod',
+      start: 'efc start prod',
+      test: 'efc run tests',
+    },
+    dependencies: deps,
+    devDependencies: devDeps,
+  };
+
+  await fs.writeJson(path.join(dest, 'package.json'), pkg, { spaces: 2 });
+}
+
+async function writeTsConfig(dest: string, opts: ScaffoldOptions): Promise<void> {
+  if (opts.language !== 'typescript') return;
+  const config = {
+    compilerOptions: {
+      target: 'ES2022',
+      module: 'NodeNext',
+      moduleResolution: 'NodeNext',
+      strict: true,
+      esModuleInterop: true,
+      skipLibCheck: true,
+      outDir: './dist',
+      rootDir: './src',
+    },
+    include: ['src/**/*'],
+    exclude: ['node_modules', 'dist'],
+  };
+  await fs.writeJson(path.join(dest, 'tsconfig.json'), config, { spaces: 2 });
+}
+
+async function writeEfcConfig(dest: string, opts: ScaffoldOptions): Promise<void> {
+  const ext = opts.language === 'typescript' ? 'ts' : 'js';
+  const tasks = opts.tasks
+    ? `{
+    backend: '${opts.taskBackend ?? 'bullmq'}',
+    redisUrl: process.env.REDIS_URL,
+    concurrency: 5,
+  }`
+    : 'false';
+
+  const content = `import type { EFCConfig } from 'express-file-cluster';
+
+const config: EFCConfig = {
+  port: Number(process.env.PORT) || 3000,
+  apiDir: './src/api',
+  tasksDir: './src/tasks',
+  database: '${opts.database}',
+  databaseUrl: process.env.DATABASE_URL!,
+  authStrategy: '${opts.authStrategy}',
+  jwtSecret: process.env.JWT_SECRET!,
+  cluster: process.env.NODE_ENV === 'production',
+  tasks: ${tasks},
+  globalMiddlewares: [],
+};
+
+export default config;
+`;
+  await fs.outputFile(path.join(dest, `efc.config.${ext}`), content);
+}
+
+async function writeEntryPoint(dest: string, opts: ScaffoldOptions): Promise<void> {
+  const ext = opts.language === 'typescript' ? 'ts' : 'js';
+  const content = `import { ignite } from 'express-file-cluster';
+import { fileURLToPath } from 'url';
+import path from 'path';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+ignite({
+  port: Number(process.env.PORT) || 3000,
+  apiDir: path.join(__dirname, 'api'),
+  tasksDir: path.join(__dirname, 'tasks'),
+  database: '${opts.database}',
+  databaseUrl: process.env.DATABASE_URL,
+  authStrategy: '${opts.authStrategy}',
+  jwtSecret: process.env.JWT_SECRET,
+  cluster: process.env.NODE_ENV === 'production',
+}).catch(console.error);
+`;
+  await fs.outputFile(path.join(dest, 'src', `index.${ext}`), content);
+}
+
+async function writeGitignore(dest: string): Promise<void> {
+  await fs.outputFile(
+    path.join(dest, '.gitignore'),
+    'node_modules/\ndist/\n.env\n.env.local\n*.log\n',
+  );
+}
+
+async function writeEnvFiles(dest: string): Promise<void> {
+  const secret = crypto.randomBytes(64).toString('hex');
+  const dotenv = `PORT=3000\nNODE_ENV=development\nDATABASE_URL=\nJWT_SECRET=${secret}\nREDIS_URL=redis://localhost:6379\n`;
+  const example = `PORT=3000\nNODE_ENV=development\nDATABASE_URL=\nJWT_SECRET=<generate with: openssl rand -hex 64>\nREDIS_URL=redis://localhost:6379\n`;
+  await fs.outputFile(path.join(dest, '.env'), dotenv);
+  await fs.outputFile(path.join(dest, '.env.example'), example);
+}
+
+async function writeExampleRoute(dest: string, opts: ScaffoldOptions): Promise<void> {
+  const ext = opts.language === 'typescript' ? 'ts' : 'js';
+  const content =
+    opts.language === 'typescript'
+      ? `import type { Request, Response } from 'express';
+
+export const GET = async (_req: Request, res: Response) => {
+  res.json({ status: 'OK', timestamp: new Date().toISOString() });
+};
+`
+      : `export const GET = async (_req, res) => {
+  res.json({ status: 'OK', timestamp: new Date().toISOString() });
+};
+`;
+  await fs.outputFile(path.join(dest, 'src', 'api', `health.${ext}`), content);
+}
+
+async function writeExampleTask(dest: string, opts: ScaffoldOptions): Promise<void> {
+  const ext = opts.language === 'typescript' ? 'ts' : 'js';
+  const content =
+    opts.language === 'typescript'
+      ? `import { defineTask } from 'express-file-cluster/tasks';
+
+interface SendEmailPayload {
+  to: string;
+  subject: string;
+  body: string;
+}
+
+export default defineTask<SendEmailPayload>(async (payload) => {
+  // TODO: wire up your mailer
+  console.log('[SendEmail] Sending to', payload.to);
+});
+`
+      : `import { defineTask } from 'express-file-cluster/tasks';
+
+export default defineTask(async (payload) => {
+  console.log('[SendEmail] Sending to', payload.to);
+});
+`;
+  await fs.outputFile(path.join(dest, 'src', 'tasks', `SendEmail.${ext}`), content);
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/tsup.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from 'tsup';
+
+export default defineConfig({
+  entry: { index: 'src/index.ts' },
+  format: ['esm'],
+  dts: false,
+  clean: true,
+  sourcemap: true,
+  target: 'node18',
+  banner: { js: '#!/usr/bin/env node' },
+});