create-wabck 1.0.0

package/README.md

@@ -0,0 +1,79 @@
+# wabck
+
+> **Scaffold production-ready Express.js backends in seconds.**
+
+```bash
+npx wabck my-api
+```
+
+or
+
+```bash
+npm create wabck@latest my-api
+```
+
+---
+
+## ✨ Features
+
+| Feature | Details |
+|---------|---------|
+| 🌐 Language | JavaScript (ESM) or TypeScript |
+| 🗄 Database | MongoDB, PostgreSQL (Prisma), MySQL, SQLite, None |
+| 🔐 Auth | JWT, Clerk, Firebase, None |
+| ✅ Validation | Zod, Joi, Express Validator |
+| 🔗 API Style | REST or GraphQL (Apollo Server 4) |
+| 📖 Docs | Swagger / OpenAPI 3 |
+| 🐳 Docker | Multi-stage Dockerfile + docker-compose |
+| ⚡ Package managers | npm, pnpm, yarn, bun |
+
+## 🎨 CLI Experience
+
+- **ASCII art banner** with gradient colors (figlet + gradient-string)
+- **Animated spinners** for every step (ora)
+- **Color-coded prompts** (chalk)
+- **Boxed success summary** with numbered next steps
+
+## 🏗 Generated Structure
+
+```
+my-api/
+├── src/
+│   ├── config/          db.js + env.js [+ swagger.js]
+│   ├── controllers/     user.controller.js
+│   ├── middlewares/     error, notFound, rateLimiter, auth
+│   ├── models/          user.model.js
+│   ├── routes/          index, health, user [+ auth]
+│   ├── services/        user.service.js
+│   ├── utils/           asyncHandler, ApiError, ApiResponse
+│   ├── validators/      user.validator.js
+│   ├── constants/       HTTP_STATUS, ROLES, PAGINATION
+│   ├── helpers/         token.helper.js (JWT)
+│   ├── types/           (TypeScript only)
+│   ├── graphql/         (GraphQL only)
+│   ├── app.js
+│   └── server.js
+├── .env.example
+├── .prettierrc
+├── eslint.config.js
+├── Dockerfile          (optional)
+└── docker-compose.yml  (optional)
+```
+
+## 🔗 Generated Endpoints
+
+| Method | Path | Description |
+|--------|------|-------------|
+| GET | `/api/v1/health` | Health + uptime |
+| GET | `/api/v1/users` | List users |
+| POST | `/api/v1/users` | Create user |
+| GET | `/api/v1/users/:id` | Get user |
+| PUT | `/api/v1/users/:id` | Update user |
+| DELETE | `/api/v1/users/:id` | Delete user |
+| POST | `/api/v1/auth/register` | Register (JWT) |
+| POST | `/api/v1/auth/login` | Login (JWT) |
+| GET | `/api/v1/auth/me` | Profile (JWT) |
+
+## 📜 License
+
+MIT

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "create-wabck",
+  "version": "1.0.0",
+  "description": "Scaffold production-ready Express.js backends in seconds",
+  "type": "module",
+  "bin": {
+    "wabck": "src/index.js",
+    "create-wabck": "src/index.js"
+  },
+  "files": [
+    "src"
+  ],
+  "scripts": {
+    "start": "node src/index.js",
+    "dev": "node src/index.js"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^7.1.0",
+    "boxen": "^8.0.1",
+    "chalk": "^5.3.0",
+    "execa": "^9.3.0",
+    "figlet": "^1.7.0",
+    "fs-extra": "^11.2.0",
+    "gradient-string": "^3.0.0",
+    "ora": "^8.1.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "express",
+    "backend",
+    "scaffold",
+    "boilerplate",
+    "cli",
+    "create-app",
+    "nodejs",
+    "typescript",
+    "rest",
+    "graphql"
+  ],
+  "author": "w4simz",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": ""
+  }
+}

package/src/generator.js

@@ -0,0 +1,201 @@
+import path from 'path';
+import { writeFile, createDir, pathExists, remove } from './utils/fs.js';
+import { log, spinner } from './utils/logger.js';
+import { buildPackageJson } from './utils/pkg.js';
+import * as T from './templates/index.js';
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Project Generator
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Orchestrates full project scaffolding:
+ *   1. Validate that the target directory doesn't exist
+ *   2. Create directory structure
+ *   3. Generate all files from templates
+ *
+ * On any failure, rolls back all created directories/files.
+ *
+ * @param {object} options - Resolved user options from prompts
+ * @returns {Promise<string>} - Absolute path to the created project
+ */
+export async function generate(options) {
+  const { projectName, language, database, auth, validation, apiStyle, docker } = options;
+  const isTS    = language === 'typescript';
+  const ext     = isTS ? 'ts' : 'js';
+  const hasDB   = database !== 'none';
+  const hasAuth = auth !== 'none';
+  const hasJwt  = auth === 'jwt';
+  const isGql   = apiStyle === 'graphql';
+  const hasValidation = validation && validation !== 'none';
+
+  const projectDir = path.resolve(process.cwd(), projectName);
+  const createdDirs = [];
+
+  // ── Pre-flight: check directory doesn't already exist ─────────────────────
+  if (await pathExists(projectDir)) {
+    throw new Error(
+      `Directory "${projectName}" already exists.\n` +
+      `  Please choose a different name or remove the existing directory.`
+    );
+  }
+
+  // ── Step 1: Create directory skeleton ─────────────────────────────────────
+  const dirSpin = spinner('Creating project structure…').start();
+
+  try {
+    const dirs = [
+      '',                    // root
+      'src',
+      'src/config',
+      'src/controllers',
+      'src/routes',
+      'src/middlewares',
+      'src/services',
+      'src/utils',
+      'src/constants',
+      'src/helpers',
+    ];
+
+    if (hasDB)          dirs.push('src/models');
+    if (isTS)           dirs.push('src/types');
+    if (isGql)          dirs.push('src/graphql');
+    if (hasValidation)  dirs.push('src/validators');
+    if (database === 'postgresql') dirs.push('prisma');
+
+    for (const d of dirs) {
+      const full = d ? path.join(projectDir, d) : projectDir;
+      await createDir(full);
+      createdDirs.push(full);
+    }
+
+    dirSpin.succeed('Project structure created');
+  } catch (err) {
+    dirSpin.fail('Failed to create directory structure');
+    await rollback(createdDirs);
+    throw err;
+  }
+
+  // ── Step 2: Write all files ────────────────────────────────────────────────
+  const fileSpin = spinner('Writing files…').start();
+
+  try {
+    const write = async (relPath, content) =>
+      writeFile(path.join(projectDir, relPath), content);
+
+    // ── package.json ──────────────────────────────────────────────────────
+    await write('package.json', JSON.stringify(buildPackageJson(options), null, 2));
+
+    // ── Root config files ─────────────────────────────────────────────────
+    await write('.env',              T.envFile(options));
+    await write('.env.example',      T.envExample(options));
+    await write('.gitignore',        T.gitignore());
+    await write('.prettierrc',       T.prettierrc());
+    await write('eslint.config.js',  T.eslintConfig(options));
+    await write('README.md',         T.readme(options));
+
+    // ── TypeScript extras ─────────────────────────────────────────────────
+    if (isTS) {
+      await write('tsconfig.json',    T.tsconfig());
+      await write(`src/types/index.ts`, T.tsTypes(options));
+    }
+
+    // ── Core application files ────────────────────────────────────────────
+    await write(`src/app.${ext}`,    T.app(options));
+    await write(`src/server.${ext}`, T.server(options));
+
+    // ── Config ────────────────────────────────────────────────────────────
+    await write(`src/config/db.${ext}`,  T.db(options));
+    await write(`src/config/env.${ext}`, T.envConfig(options));
+
+    // ── Routes ────────────────────────────────────────────────────────────
+    await write(`src/routes/index.${ext}`,        T.routesIndex(options));
+    await write(`src/routes/health.route.${ext}`, T.healthRoute(options));
+    await write(`src/routes/user.route.${ext}`,   T.userRoute(options));
+    if (hasJwt) {
+      await write(`src/routes/auth.route.${ext}`, T.authRoute(options));
+    }
+
+    // ── Controllers ───────────────────────────────────────────────────────
+    await write(`src/controllers/user.controller.${ext}`, T.userController(options));
+
+    // ── Models ────────────────────────────────────────────────────────────
+    if (hasDB) {
+      await write(`src/models/user.model.${ext}`, T.userModel(options));
+    }
+    if (database === 'postgresql') {
+      await write('prisma/schema.prisma', T.prismaSchema(options));
+    }
+
+    // ── Middlewares ───────────────────────────────────────────────────────
+    await write(`src/middlewares/error.middleware.${ext}`,       T.errorMiddleware(options));
+    await write(`src/middlewares/notFound.middleware.${ext}`,    T.notFoundMiddleware(options));
+    await write(`src/middlewares/rateLimiter.middleware.${ext}`, T.rateLimiterMiddleware(options));
+    if (hasAuth) {
+      await write(`src/middlewares/auth.middleware.${ext}`, T.authMiddleware(options));
+    }
+
+    // ── Services ──────────────────────────────────────────────────────────
+    await write(`src/services/user.service.${ext}`, T.userService(options));
+
+    // ── Utilities ─────────────────────────────────────────────────────────
+    await write(`src/utils/asyncHandler.${ext}`, T.asyncHandler(options));
+    await write(`src/utils/apiError.${ext}`,     T.apiError(options));
+    await write(`src/utils/apiResponse.${ext}`,  T.apiResponse(options));
+
+    // ── Validators ────────────────────────────────────────────────────────
+    if (hasValidation) {
+      await write(`src/validators/user.validator.${ext}`, T.userValidator(options));
+    }
+
+    // ── Constants ─────────────────────────────────────────────────────────
+    await write(`src/constants/index.${ext}`, T.constants(options));
+
+    // ── Helpers ───────────────────────────────────────────────────────────
+    if (hasJwt) {
+      await write(`src/helpers/token.helper.${ext}`, T.tokenHelper(options));
+    }
+
+    // ── GraphQL ───────────────────────────────────────────────────────────
+    if (isGql) {
+      await write(`src/graphql/schema.${ext}`,    T.graphqlSchema(options));
+      await write(`src/graphql/resolvers.${ext}`, T.graphqlResolvers(options));
+      await write(`src/graphql/server.${ext}`,    T.graphqlServer(options));
+    }
+
+    // ── Docker ────────────────────────────────────────────────────────────
+    if (docker) {
+      await write('Dockerfile',          T.dockerfile(options));
+      await write('docker-compose.yml',  T.dockerCompose(options));
+      await write('.dockerignore',       T.dockerignore());
+    }
+
+    fileSpin.succeed('Files written successfully');
+    return projectDir;
+  } catch (err) {
+    fileSpin.fail('Failed to write project files');
+    await rollback(createdDirs);
+    throw err;
+  }
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Rollback Helper
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Removes all created directories in reverse order (deepest first).
+ * Called when generation fails partway through.
+ * @param {string[]} dirs - Array of absolute directory paths to remove
+ */
+async function rollback(dirs) {
+  log.warn('Rolling back created files…');
+  for (const d of [...dirs].reverse()) {
+    try {
+      await remove(d);
+    } catch {
+      // Silently continue — best-effort cleanup
+    }
+  }
+  log.dim('  Cleanup complete.');
+}

package/src/index.js

@@ -0,0 +1,118 @@
+#!/usr/bin/env node
+
+import process from 'process';
+import path from 'path';
+import chalk from 'chalk';
+import { renderBanner, log, box } from './utils/logger.js';
+import { runPrompts } from './prompts.js';
+import { generate } from './generator.js';
+import { installDependencies, runPrismaGenerate } from './installer.js';
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Entry Point
+// ─────────────────────────────────────────────────────────────────────────────
+
+async function main() {
+  // ── 1. Banner ──────────────────────────────────────────────────────────────
+  await renderBanner();
+
+  // ── 2. Parse argv (optional pre-fill for project name) ────────────────────
+  const argName = process.argv[2];
+
+  // ── 3. Interactive prompts ─────────────────────────────────────────────────
+  let options;
+  try {
+    options = await runPrompts(argName);
+  } catch (err) {
+    // User pressed Ctrl+C or similar
+    if (err?.name === 'ExitPromptError' || err?.message?.includes('User force closed')) {
+      log.blank();
+      log.warn('Scaffold cancelled.');
+      process.exit(0);
+    }
+    throw err;
+  }
+
+  log.blank();
+
+  // ── 4. Generate project files ──────────────────────────────────────────────
+  let projectDir;
+  try {
+    projectDir = await generate(options);
+  } catch (err) {
+    log.blank();
+    log.error(`Generation failed: ${err.message}`);
+    process.exit(1);
+  }
+
+  // ── 5. Install dependencies ────────────────────────────────────────────────
+  if (options.installDeps) {
+    try {
+      await installDependencies(projectDir, options.packageManager);
+
+      // Run prisma generate after install for PostgreSQL projects
+      if (options.database === 'postgresql') {
+        await runPrismaGenerate(projectDir, options.packageManager);
+      }
+    } catch {
+      // Installation failure is non-fatal — project files are still valid
+      log.blank();
+      log.warn('Dependencies were not installed automatically. Install them manually:');
+      log.dim(`  cd ${options.projectName}`);
+      log.dim(`  ${options.packageManager} ${options.packageManager === 'yarn' ? '' : 'install'}`);
+    }
+  }
+
+  // ── 6. Success summary ─────────────────────────────────────────────────────
+  log.blank();
+  printSuccessSummary(options, projectDir);
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Success Summary
+// ─────────────────────────────────────────────────────────────────────────────
+
+function printSuccessSummary(options, projectDir) {
+  const { projectName, language, database, auth, validation, docker, packageManager, installDeps } = options;
+  const pm      = packageManager;
+  const relDir  = path.relative(process.cwd(), projectDir) || projectName;
+  const devCmd  = language === 'typescript' ? `${pm} run dev` : `${pm} run dev`;
+
+  // Progress recap
+  log.success('Project scaffolded successfully!');
+  log.blank();
+  log.label('  Language',   language === 'typescript' ? 'TypeScript' : 'JavaScript');
+  log.label('  Database',   database === 'none' ? 'None' : database);
+  log.label('  Auth',       auth === 'none' ? 'None' : auth);
+  if (validation && validation !== 'none') log.label('  Validation', validation);
+  if (docker)  log.label('  Docker',     'Dockerfile + docker-compose.yml');
+  log.blank();
+
+  // Next steps
+  const steps = [];
+  steps.push(`cd ${relDir}`);
+  if (!installDeps) steps.push(`${pm}${pm === 'yarn' ? '' : ' install'}`);
+  steps.push('cp .env.example .env');
+  if (database === 'postgresql') steps.push('npx prisma migrate dev --name init');
+  steps.push(devCmd);
+
+  const stepsStr = steps.map((s, i) => `  ${chalk.dim(`${i + 1}.`)} ${chalk.cyan(s)}`).join('\n');
+
+  console.log(
+    box(
+      chalk.bold.white('🚀 Next steps:\n\n') + stepsStr + '\n\n' +
+      chalk.dim('  API: ') + chalk.white('http://localhost:5000/api/v1/health'),
+      { borderColor: 'green', title: chalk.green('Ready!'), titleAlignment: 'center' }
+    )
+  );
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Run
+// ─────────────────────────────────────────────────────────────────────────────
+
+main().catch((err) => {
+  console.error(chalk.red('\n  Fatal error:'), err.message || err);
+  if (process.env.DEBUG) console.error(err.stack);
+  process.exit(1);
+});

package/src/installer.js

@@ -0,0 +1,62 @@
+import { execa } from 'execa';
+import { spinner, log } from './utils/logger.js';
+import { getInstallCmd } from './utils/pkg.js';
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Dependency Installer
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Installs project dependencies in the generated project directory.
+ * Uses the package manager chosen by the user.
+ *
+ * @param {string} projectDir   - Absolute path to the generated project
+ * @param {string} packageManager - 'npm' | 'pnpm' | 'yarn' | 'bun'
+ */
+export async function installDependencies(projectDir, packageManager) {
+  const { cmd, args } = getInstallCmd(packageManager);
+  const spin = spinner(`Installing dependencies with ${packageManager}…`).start();
+
+  try {
+    await execa(cmd, args, {
+      cwd: projectDir,
+      // Pipe output so the spinner stays clean; errors are captured
+      stdio: ['ignore', 'pipe', 'pipe'],
+    });
+
+    spin.succeed(`Dependencies installed with ${packageManager}`);
+  } catch (err) {
+    spin.fail(`Dependency installation failed`);
+    log.warn('You can install them manually:');
+    log.dim(`  cd ${projectDir}`);
+    log.dim(`  ${cmd} ${args.join(' ')}`);
+
+    // Re-throw so the caller can decide whether to abort or continue
+    throw new Error(`Installation failed: ${err.message}`);
+  }
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Prisma Post-Install Steps
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Runs `prisma generate` after installation for PostgreSQL projects.
+ * @param {string} projectDir
+ * @param {string} packageManager
+ */
+export async function runPrismaGenerate(projectDir, packageManager) {
+  const spin = spinner('Running prisma generate…').start();
+
+  try {
+    const runner = packageManager === 'npm' ? 'npx' : packageManager;
+    await execa(runner, ['prisma', 'generate'], {
+      cwd: projectDir,
+      stdio: ['ignore', 'pipe', 'pipe'],
+    });
+    spin.succeed('Prisma client generated');
+  } catch {
+    spin.warn('Could not auto-run prisma generate — run it manually:');
+    log.dim('  npx prisma generate');
+  }
+}

package/src/prompts.js

@@ -0,0 +1,113 @@
+import { input, select, confirm } from '@inquirer/prompts';
+import chalk from 'chalk';
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Interactive CLI Prompts
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Runs the full interactive questionnaire and returns a resolved options object.
+ * @param {string} [initialName] - Pre-filled project name from CLI argv
+ * @returns {Promise<object>} options
+ */
+export async function runPrompts(initialName) {
+  console.log(chalk.dim('  Answer a few questions to scaffold your project.\n'));
+
+  // 1. Project Name
+  const projectName = await input({
+    message: 'Project name:',
+    default: initialName || 'my-api',
+    validate: (v) => {
+      if (!v.trim()) return 'Project name cannot be empty.';
+      if (!/^[a-z0-9-_]+$/i.test(v)) return 'Use only letters, numbers, hyphens or underscores.';
+      return true;
+    },
+  });
+
+  // 2. Language
+  const language = await select({
+    message: 'Language:',
+    choices: [
+      { name: `${chalk.yellow('JavaScript')} (ES Modules)`, value: 'javascript' },
+      { name: `${chalk.blue('TypeScript')} (strict mode)`,  value: 'typescript' },
+    ],
+  });
+
+  // 3. Package Manager
+  const packageManager = await select({
+    message: 'Package manager:',
+    choices: [
+      { name: `${chalk.red('npm')}`,   value: 'npm' },
+      { name: `${chalk.yellow('pnpm')} (faster, disk-efficient)`, value: 'pnpm' },
+      { name: `${chalk.blue('yarn')}`,  value: 'yarn' },
+      { name: `${chalk.magenta('bun')} (fastest)`, value: 'bun' },
+    ],
+  });
+
+  // 4. Database
+  const database = await select({
+    message: 'Database:',
+    choices: [
+      { name: `${chalk.green('MongoDB')}    — Mongoose ODM`,    value: 'mongodb'    },
+      { name: `${chalk.blue('PostgreSQL')} — Prisma ORM`,       value: 'postgresql' },
+      { name: `${chalk.cyan('MySQL')}       — mysql2 driver`,   value: 'mysql'      },
+      { name: `${chalk.magenta('SQLite')}   — better-sqlite3`,  value: 'sqlite'     },
+      { name: `${chalk.dim('None')}         — no database`,     value: 'none'       },
+    ],
+  });
+
+  // 5. Authentication
+  const auth = await select({
+    message: 'Authentication:',
+    choices: [
+      { name: `${chalk.yellow('JWT')}      — jsonwebtoken + bcryptjs`, value: 'jwt'      },
+      { name: `${chalk.blue('Clerk')}     — @clerk/express`,           value: 'clerk'    },
+      { name: `${chalk.orange?.('Firebase') || chalk.red('Firebase')} — firebase-admin`, value: 'firebase' },
+      { name: `${chalk.dim('None')}       — no auth`,                   value: 'none'     },
+    ],
+  });
+
+  // 6. Validation
+  const validation = await select({
+    message: 'Validation library:',
+    choices: [
+      { name: `${chalk.blue('Zod')}               — TypeScript-first schema validation`, value: 'zod'              },
+      { name: `${chalk.cyan('Joi')}               — the classic schema validator`,       value: 'joi'              },
+      { name: `${chalk.green('Express Validator')} — middleware-based validation`,        value: 'express-validator' },
+      { name: `${chalk.dim('None')}               — no validation library`,              value: 'none'             },
+    ],
+  });
+
+  // 7. API Style
+  const apiStyle = await select({
+    message: 'API style:',
+    choices: [
+      { name: `${chalk.green('REST')}    — standard RESTful API`,   value: 'rest'    },
+      { name: `${chalk.magenta('GraphQL')} — Apollo Server 4`,      value: 'graphql' },
+    ],
+  });
+
+  // 8. Docker
+  const docker = await confirm({
+    message: 'Include Docker + docker-compose?',
+    default: true,
+  });
+
+  // 9. Install Dependencies
+  const installDeps = await confirm({
+    message: `Install dependencies now with ${chalk.cyan(packageManager)}?`,
+    default: true,
+  });
+
+  return {
+    projectName: projectName.trim(),
+    language,
+    packageManager,
+    database,
+    auth,
+    validation,
+    apiStyle,
+    docker,
+    installDeps,
+  };
+}