create-wabck 1.0.0

package/src/templates/base.js

@@ -0,0 +1,387 @@
+import { randomBytes } from 'crypto';
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Base Templates — app.js/ts, server.js/ts, and all root config files
+// ─────────────────────────────────────────────────────────────────────────────
+
+const ext = (isTS) => (isTS ? 'js' : 'js'); // ESM always uses .js imports
+
+/** Generate src/app.js or src/app.ts */
+export function app(options) {
+  const { apiStyle, language } = options;
+  const isTS = language === 'typescript';
+
+  const typeImport = isTS ? `import { Application } from 'express';\n` : '';
+  const appType    = isTS ? ': Application' : '';
+
+  const graphqlBlock =
+    apiStyle === 'graphql'
+      ? `
+// ─────────────────────────────────────────────────────────────────────────────
+// GraphQL — Apollo Server 4 mounted on /graphql
+// ─────────────────────────────────────────────────────────────────────────────
+import { expressMiddleware } from '@as-integrations/express4';
+import { createApolloServer } from './graphql/server.js';
+
+const apolloServer = createApolloServer();
+await apolloServer.start();
+app.use('/graphql', expressMiddleware(apolloServer, {
+  context: async ({ req }) => ({ req }),
+}));
+`
+      : '';
+
+  return `${typeImport}import express${isTS ? ', { Application }' : ''} from 'express';
+import cors from 'cors';
+import helmet from 'helmet';
+import compression from 'compression';
+import morgan from 'morgan';
+import cookieParser from 'cookie-parser';
+import { rateLimiter } from './middlewares/rateLimiter.middleware.js';
+import { errorMiddleware } from './middlewares/error.middleware.js';
+import { notFoundMiddleware } from './middlewares/notFound.middleware.js';
+import routes from './routes/index.js';
+
+const app${appType} = express();
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Security Middleware
+// ─────────────────────────────────────────────────────────────────────────────
+app.use(helmet());
+app.use(
+  cors({
+    origin: process.env.CORS_ORIGIN || '*',
+    credentials: true,
+  })
+);
+app.use(rateLimiter);
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Body Parsing
+// ─────────────────────────────────────────────────────────────────────────────
+app.use(express.json({ limit: '16kb' }));
+app.use(express.urlencoded({ extended: true, limit: '16kb' }));
+app.use(cookieParser());
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Logging & Compression
+// ─────────────────────────────────────────────────────────────────────────────
+app.use(compression());
+app.use(morgan(process.env.NODE_ENV === 'production' ? 'combined' : 'dev'));
+${graphqlBlock}
+// ─────────────────────────────────────────────────────────────────────────────
+// API Routes — versioned under /api/v1
+// ─────────────────────────────────────────────────────────────────────────────
+app.use('/api/v1', routes);
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Error Handling — Order matters: 404 must come before the error handler
+// ─────────────────────────────────────────────────────────────────────────────
+app.use(notFoundMiddleware);
+app.use(errorMiddleware);
+
+export default app;
+`;
+}
+
+/** Generate src/server.js or src/server.ts */
+export function server(options) {
+  const { database, language, projectName } = options;
+  const isTS = language === 'typescript';
+  const hasDB = database !== 'none';
+
+  const dbImport = hasDB ? `import connectDB from './config/db.js';\n` : '';
+  const dbConnect = hasDB ? `  await connectDB();\n` : '';
+
+  return `import 'dotenv/config';
+import app from './app.js';
+${dbImport}
+const PORT = process.env.PORT || 5000;
+const HOST = process.env.HOST || '0.0.0.0';
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Bootstrap — Connect to DB then start HTTP server
+// ─────────────────────────────────────────────────────────────────────────────
+const startServer = async ()${isTS ? ': Promise<void>' : ''} => {
+  try {
+${dbConnect}    const server = app.listen(PORT, HOST, () => {
+      console.log(\`\`);
+      console.log(\`  🚀 ${projectName} is running!\`);
+      console.log(\`  ➜  Local:   http://localhost:\${PORT}\`);
+      console.log(\`  ➜  Health:  http://localhost:\${PORT}/api/v1/health\`);
+      console.log(\`\`);
+
+    });
+
+    // ── Graceful Shutdown ──────────────────────────────────────────────────
+    const shutdown = (signal${isTS ? ': string' : ''}) => {
+      console.log(\`\\n  Received \${signal}. Gracefully shutting down…\`);
+      server.close(() => {
+        console.log('  HTTP server closed.');
+        process.exit(0);
+      });
+    };
+
+    process.on('SIGTERM', () => shutdown('SIGTERM'));
+    process.on('SIGINT',  () => shutdown('SIGINT'));
+
+  } catch (error) {
+    console.error('Failed to start server:', error);
+    process.exit(1);
+  }
+};
+
+startServer();
+`;
+}
+
+/** Generate .env */
+export function envFile(options) {
+  const { database, auth, projectName } = options;
+
+  // Auto-generate a cryptographically secure JWT secret at scaffold time
+  const jwtSecret = randomBytes(32).toString('hex');
+
+  const dbVars = {
+    mongodb:    'MONGODB_URI=mongodb://localhost:27017/${projectName}',
+    postgresql: 'DATABASE_URL=postgresql://postgres:password@localhost:5432/${projectName}',
+    mysql:      `DB_HOST=localhost\nDB_PORT=3306\nDB_USER=root\nDB_PASSWORD=password\nDB_NAME=${projectName}`,
+    sqlite:     `SQLITE_PATH=./database.sqlite`,
+    none:       '',
+  };
+
+  const authVars = {
+    jwt:      `\nJWT_SECRET=${jwtSecret}\nJWT_EXPIRES_IN=7d\nJWT_REFRESH_EXPIRES_IN=30d`,
+    clerk:    `\nCLERK_SECRET_KEY=sk_test_your-clerk-secret-key`,
+    firebase: `\nFIREBASE_PROJECT_ID=your-firebase-project-id\nFIREBASE_PRIVATE_KEY=your-firebase-private-key\nFIREBASE_CLIENT_EMAIL=your-firebase-client-email`,
+    none:     '',
+  };
+
+  return `# ─────────────────────────────────────────────
+# ${projectName} — Environment Variables
+# ─────────────────────────────────────────────
+# Copy this file to .env and fill in the values.
+# JWT_SECRET below was auto-generated at scaffold time — keep it secret!
+
+NODE_ENV=development
+PORT=5000
+HOST=0.0.0.0
+CORS_ORIGIN=*
+
+# Database
+${(dbVars[database] || '').replace('${projectName}', projectName)}
+${authVars[auth] || ''}
+`;
+}
+
+/** Generate .env.example — safe to commit; uses a placeholder instead of the real secret */
+export function envExample(options) {
+  const { database, auth, projectName } = options;
+
+  const dbVars = {
+    mongodb:    `MONGODB_URI=mongodb://localhost:27017/${projectName}`,
+    postgresql: `DATABASE_URL=postgresql://postgres:password@localhost:5432/${projectName}`,
+    mysql:      `DB_HOST=localhost\nDB_PORT=3306\nDB_USER=root\nDB_PASSWORD=password\nDB_NAME=${projectName}`,
+    sqlite:     `SQLITE_PATH=./database.sqlite`,
+    none:       '',
+  };
+
+  const authVars = {
+    jwt:      `\nJWT_SECRET=change-me-generate-with-openssl-rand-hex-32\nJWT_EXPIRES_IN=7d\nJWT_REFRESH_EXPIRES_IN=30d`,
+    clerk:    `\nCLERK_SECRET_KEY=sk_test_your-clerk-secret-key`,
+    firebase: `\nFIREBASE_PROJECT_ID=your-firebase-project-id\nFIREBASE_PRIVATE_KEY=your-firebase-private-key\nFIREBASE_CLIENT_EMAIL=your-firebase-client-email`,
+    none:     '',
+  };
+
+  return `# ─────────────────────────────────────────────
+# ${projectName} — Environment Variables (EXAMPLE)
+# ─────────────────────────────────────────────
+# This file is safe to commit. Copy to .env and replace placeholder values.
+# Your actual .env already has a generated JWT_SECRET.
+
+NODE_ENV=development
+PORT=5000
+HOST=0.0.0.0
+CORS_ORIGIN=*
+
+# Database
+${(dbVars[database] || '').replace('${projectName}', projectName)}
+${authVars[auth] || ''}
+`;
+}
+
+/** Generate .gitignore for the generated project */
+export function gitignore() {
+  return `# ─── Dependencies ──────────────────────────────
+node_modules/
+.pnp
+.pnp.js
+
+# ─── Build Outputs ──────────────────────────────
+dist/
+build/
+*.tsbuildinfo
+
+# ─── Environment Variables ──────────────────────
+.env
+.env.local
+.env.*.local
+# .env.example is safe to commit
+
+# ─── Logs ───────────────────────────────────────
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# ─── OS / Editor ────────────────────────────────
+.DS_Store
+Thumbs.db
+.idea/
+.vscode/
+
+# ─── Database ───────────────────────────────────
+*.sqlite
+*.sqlite3
+database.sqlite
+
+# ─── Testing ────────────────────────────────────
+coverage/
+`;
+}
+
+/** Generate .prettierrc */
+export function prettierrc() {
+  return JSON.stringify(
+    {
+      semi: true,
+      singleQuote: true,
+      trailingComma: 'es5',
+      printWidth: 100,
+      tabWidth: 2,
+      useTabs: false,
+      bracketSpacing: true,
+      arrowParens: 'always',
+    },
+    null,
+    2
+  );
+}
+
+/** Generate eslint.config.js */
+export function eslintConfig(options) {
+  const isTS = options.language === 'typescript';
+  return `import js from '@eslint/js';
+import prettier from 'eslint-plugin-prettier';
+import eslintConfigPrettier from 'eslint-config-prettier';
+
+export default [
+  js.configs.recommended,
+  eslintConfigPrettier,
+  {
+    plugins: { prettier },
+    rules: {
+      'prettier/prettier': 'error',
+      'no-console': 'warn',
+      'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+      'no-duplicate-imports': 'error',
+      'prefer-const': 'error',
+      'no-var': 'error',
+    },
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+      globals: {
+        process: 'readonly',
+        console: 'readonly',
+        Buffer: 'readonly',
+        URL: 'readonly',
+        setTimeout: 'readonly',
+        clearTimeout: 'readonly',
+        setInterval: 'readonly',
+        clearInterval: 'readonly',
+      },
+    },
+  },
+];
+`;
+}
+
+/** Generate README.md */
+export function readme(options) {
+  const { projectName, language, database, auth, validation, apiStyle, docker, packageManager } = options;
+  const isTS = language === 'typescript';
+  const pm = packageManager;
+
+  return `# ${projectName}
+
+> Production-ready Express.js API — scaffolded by [wabck](https://github.com/wabck/wabck)
+
+## 🚀 Quick Start
+
+\`\`\`bash
+# Install dependencies
+${pm} ${pm === 'yarn' ? '' : 'install'}
+
+# Copy environment variables
+cp .env.example .env
+
+# Start development server
+${pm} run dev
+\`\`\`
+
+The API will be available at **http://localhost:5000**
+
+## 📁 Project Structure
+
+\`\`\`
+${projectName}/
+├── src/
+│   ├── config/          # DB connection, env validation
+│   ├── controllers/     # Request handlers
+│   ├── middlewares/     # Error, auth, rate-limiter
+│   ├── models/          # Data models
+│   ├── routes/          # Route definitions
+│   ├── services/        # Business logic
+│   ├── utils/           # asyncHandler, ApiError, ApiResponse
+${validation !== 'none' ? `│   ├── validators/      # Input validation\n` : ''}│   ├── helpers/         # Token, etc.
+│   ├── constants/       # App-wide constants
+│   ├── app.${isTS ? 'ts' : 'js'}           # Express app
+│   └── server.${isTS ? 'ts' : 'js'}        # Entry point
+├── .env.example
+├── .prettierrc
+└── eslint.config.js
+\`\`\`
+
+## 🛠 Stack
+
+| Feature       | Choice                    |
+|---------------|---------------------------|
+| Language      | ${isTS ? 'TypeScript' : 'JavaScript (ES Modules)'} |
+| Database      | ${database === 'none' ? '—' : database}             |
+| Auth          | ${auth === 'none' ? '—' : auth}                     |
+${validation !== 'none' ? `| Validation    | ${validation}                                        |\n` : ''}| API Style     | ${apiStyle === 'graphql' ? 'GraphQL (Apollo Server 4)' : 'REST'} |
+| Docker        | ${docker ? '✔ Dockerfile + docker-compose' : '—'}   |
+
+## 🔗 Endpoints
+
+| Method | Path               | Description        |
+|--------|--------------------|--------------------|
+| GET    | \`/\`              | Root health ping   |
+| GET    | \`/api/v1/health\` | Detailed health    |
+| GET    | \`/api/v1/users\`  | List users         |
+| POST   | \`/api/v1/users\`  | Create user        |
+| GET    | \`/api/v1/users/:id\` | Get user by ID  |
+| PUT    | \`/api/v1/users/:id\` | Update user     |
+| DELETE | \`/api/v1/users/:id\` | Delete user     |
+${auth === 'jwt' ? `| POST   | \`/api/v1/auth/register\` | Register    |\n| POST   | \`/api/v1/auth/login\` | Login           |` : ''}
+
+${docker ? `## 🐳 Docker\n\n\`\`\`bash\ndocker compose up --build\n\`\`\`\n` : ''}
+${isTS ? `## 🏗 Build\n\n\`\`\`bash\n${pm} run build\n${pm} start\n\`\`\`\n` : ''}
+## 📜 License
+
+MIT
+`;
+}

package/src/templates/config.js

@@ -0,0 +1,271 @@
+// ─────────────────────────────────────────────────────────────────────────────
+// Config Templates — db.js, env.js, swagger.js
+// ─────────────────────────────────────────────────────────────────────────────
+
+/** Generate src/config/db.js or db.ts */
+export function db(options) {
+  const { database, language } = options;
+  const isTS = language === 'typescript';
+
+  switch (database) {
+    // ── MongoDB / Mongoose ──────────────────────────────────────────────────
+    case 'mongodb':
+      return `import mongoose from 'mongoose';
+
+/**
+ * Establishes a connection to MongoDB using Mongoose.
+ * Uses DATABASE_URL (or MONGODB_URI) from environment variables.
+ * Exits the process if the connection fails.
+ */
+const connectDB = async ()${isTS ? ': Promise<void>' : ''} => {
+  try {
+    const uri = process.env.MONGODB_URI || process.env.DATABASE_URL;
+    if (!uri) throw new Error('MONGODB_URI is not defined in .env');
+
+    const conn = await mongoose.connect(uri, {
+      // Mongoose 7+ uses the new connection engine by default
+    });
+
+    console.log(\`✔ MongoDB connected: \${conn.connection.host}\`);
+
+    // ── Mongoose connection events ────────────────────────────────────────
+    mongoose.connection.on('error', (err) => {
+      console.error('MongoDB connection error:', err);
+    });
+
+    mongoose.connection.on('disconnected', () => {
+      console.warn('MongoDB disconnected');
+    });
+  } catch (error) {
+    console.error('MongoDB connection failed:', error${isTS ? ' as Error' : ''}.message || error);
+    process.exit(1);
+  }
+};
+
+export default connectDB;
+`;
+
+    // ── PostgreSQL / Prisma ─────────────────────────────────────────────────
+    case 'postgresql':
+      return `import { PrismaClient } from '@prisma/client';
+
+const globalForPrisma = globalThis${isTS ? ' as unknown as { prisma: PrismaClient }' : ''};
+
+/**
+ * PrismaClient singleton — prevents multiple instances in development
+ * due to hot-reloading (Next.js pattern, works for Node as well).
+ */
+export const prisma =
+  globalForPrisma.prisma ??
+  new PrismaClient({
+    log: process.env.NODE_ENV === 'development'
+      ? ['query', 'info', 'warn', 'error']
+      : ['error'],
+  });
+
+if (process.env.NODE_ENV !== 'production') {
+  globalForPrisma.prisma = prisma;
+}
+
+/**
+ * Establishes a connection to PostgreSQL via Prisma.
+ * Exits the process if the connection fails.
+ */
+const connectDB = async ()${isTS ? ': Promise<void>' : ''} => {
+  try {
+    await prisma.$connect();
+    console.log('✔ PostgreSQL connected via Prisma');
+  } catch (error) {
+    console.error('PostgreSQL connection failed:', error${isTS ? ' as Error' : ''}.message || error);
+    process.exit(1);
+  }
+};
+
+export default connectDB;
+`;
+
+    // ── MySQL / mysql2 ──────────────────────────────────────────────────────
+    case 'mysql':
+      return `import mysql from 'mysql2/promise';
+
+let pool${isTS ? ': mysql.Pool' : ''};
+
+/**
+ * Creates a mysql2 connection pool and verifies connectivity.
+ * Pool is exported for use across the application.
+ */
+const connectDB = async ()${isTS ? ': Promise<void>' : ''} => {
+  try {
+    pool = mysql.createPool({
+      host:             process.env.DB_HOST     || 'localhost',
+      port:             Number(process.env.DB_PORT) || 3306,
+      user:             process.env.DB_USER     || 'root',
+      password:         process.env.DB_PASSWORD || '',
+      database:         process.env.DB_NAME     || 'mydb',
+      waitForConnections: true,
+      connectionLimit:  10,
+      queueLimit:       0,
+    });
+
+    // Verify the connection
+    await pool.query('SELECT 1');
+    console.log(\`✔ MySQL connected — db: \${process.env.DB_NAME || 'mydb'}\`);
+  } catch (error) {
+    console.error('MySQL connection failed:', error${isTS ? ' as Error' : ''}.message || error);
+    process.exit(1);
+  }
+};
+
+export { pool };
+export default connectDB;
+`;
+
+    // ── SQLite / better-sqlite3 ─────────────────────────────────────────────
+    case 'sqlite':
+      return `import Database from 'better-sqlite3';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname  = path.dirname(__filename);
+
+let db${isTS ? ': Database.Database' : ''};
+
+/**
+ * Opens the SQLite database file and runs a quick smoke test.
+ * better-sqlite3 is synchronous — no await needed for queries.
+ */
+const connectDB = async ()${isTS ? ': Promise<void>' : ''} => {
+  try {
+    const dbPath = process.env.SQLITE_PATH
+      ? path.resolve(process.env.SQLITE_PATH)
+      : path.join(__dirname, '..', '..', 'database.sqlite');
+
+    db = new Database(dbPath);
+
+    // Enable WAL mode for better concurrent read performance
+    db.pragma('journal_mode = WAL');
+
+    // Smoke-test the connection
+    db.prepare('SELECT 1').get();
+    console.log(\`✔ SQLite connected — \${dbPath}\`);
+  } catch (error) {
+    console.error('SQLite connection failed:', error${isTS ? ' as Error' : ''}.message || error);
+    process.exit(1);
+  }
+};
+
+export { db };
+export default connectDB;
+`;
+
+    default:
+      return `// No database selected — this file is intentionally empty.\n`;
+  }
+}
+
+/** Generate src/config/env.js — validates required environment variables */
+export function envConfig(options) {
+  const { database, auth, language } = options;
+  const isTS = language === 'typescript';
+
+  const requiredVars = [`'PORT'`, `'NODE_ENV'`];
+  if (database === 'mongodb')    requiredVars.push(`'MONGODB_URI'`);
+  if (database === 'postgresql') requiredVars.push(`'DATABASE_URL'`);
+  if (database === 'mysql') {
+    requiredVars.push(`'DB_HOST'`, `'DB_USER'`, `'DB_NAME'`);
+  }
+  if (auth === 'jwt')      requiredVars.push(`'JWT_SECRET'`);
+  if (auth === 'clerk')    requiredVars.push(`'CLERK_SECRET_KEY'`);
+  if (auth === 'firebase') requiredVars.push(`'FIREBASE_PROJECT_ID'`, `'FIREBASE_PRIVATE_KEY'`, `'FIREBASE_CLIENT_EMAIL'`);
+
+  return `/**
+ * Environment Configuration & Validation
+ *
+ * Validates that all required environment variables are present at startup.
+ * Import this module early (before any DB or server init).
+ */
+
+const REQUIRED_VARS = [${requiredVars.join(', ')}];
+
+/**
+ * Validates environment variables and exits if any are missing.
+ */
+export function validateEnv()${isTS ? ': void' : ''} {
+  const missing = REQUIRED_VARS.filter((key) => !process.env[key]);
+
+  if (missing.length > 0) {
+    console.error('\\n  Missing required environment variables:');
+    missing.forEach((key) => console.error(\`  ✖ \${key}\`));
+    console.error('\\n  Check your .env file.\\n');
+    process.exit(1);
+  }
+}
+
+/**
+ * Typed environment config object for convenient access.
+ */
+export const config = {
+  port:     Number(process.env.PORT) || 5000,
+  host:     process.env.HOST || '0.0.0.0',
+  nodeEnv:  process.env.NODE_ENV || 'development',
+  isProd:   process.env.NODE_ENV === 'production',
+  corsOrigin: process.env.CORS_ORIGIN || '*',
+${database === 'mongodb'    ? "  mongoUri: process.env.MONGODB_URI || '',\n" : ''}${database === 'postgresql' ? "  databaseUrl: process.env.DATABASE_URL || '',\n" : ''}${auth === 'jwt' ? "  jwtSecret: process.env.JWT_SECRET || '',\n  jwtExpiresIn: process.env.JWT_EXPIRES_IN || '7d',\n" : ''}};
+`;
+}
+
+/** Generate src/config/swagger.js */
+export function swagger(options) {
+  const { projectName, language } = options;
+  const isTS = language === 'typescript';
+
+  return `import swaggerJsdoc from 'swagger-jsdoc';
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import path from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname  = path.dirname(__filename);
+
+// Read version from package.json
+let version = '1.0.0';
+try {
+  const pkg = JSON.parse(readFileSync(path.join(__dirname, '..', '..', 'package.json'), 'utf-8'));
+  version = pkg.version;
+} catch { /* use default */ }
+
+const options = {
+  definition: {
+    openapi: '3.0.0',
+    info: {
+      title:       '${projectName} API',
+      version,
+      description: 'Auto-generated API documentation for ${projectName}',
+      license: { name: 'MIT' },
+      contact:     { name: '${projectName} Support' },
+    },
+    servers: [
+      { url: \`http://localhost:\${process.env.PORT || 5000}/api/v1\`, description: 'Development' },
+    ],
+    components: {
+      securitySchemes: {
+        bearerAuth: {
+          type:   'http',
+          scheme: 'bearer',
+          bearerFormat: 'JWT',
+        },
+      },
+    },
+    security: [{ bearerAuth: [] }],
+  },
+  // Pick up JSDoc @swagger annotations from all route files
+  apis: [
+    path.join(__dirname, '../routes/*.js'),
+    path.join(__dirname, '../routes/*.ts'),
+  ],
+};
+
+export const swaggerSpec = swaggerJsdoc(options);
+`;
+}