@bayajidalam/apollo-cli 1.0.0

package/README.md

@@ -0,0 +1,97 @@
+# Apollo CLI
+
+A CLI tool for scaffolding and managing Apollo backend projects (Express + TypeScript + Prisma + PostgreSQL).
+
+## Installation
+
+### Global Installation
+
+To install the CLI globally:
+
+```bash
+npm install -g apollo-cli
+```
+
+### Local Development Setup
+
+If you are developing this tool locally and want to test it:
+
+1.  **Build the CLI**:
+    ```bash
+    npm run build
+    ```
+
+2.  **Link it globally**:
+    ```bash
+    npm link
+    ```
+    This makes the `apollo-cli` command available in your terminal.
+
+## Usage
+
+### 1. `generate` (alias: `g`)
+
+Generates a new module structure including controller, service, route, interface, validation, and constants.
+
+**Syntax:**
+```bash
+apollo-cli generate module <ModuleName>
+# OR
+apollo-cli g module <ModuleName>
+```
+
+**Example:**
+Generate a `User` module:
+```bash
+apollo-cli g module User
+```
+
+This will create the following files in `src/app/modules/User`:
+- `user.controller.ts`
+- `user.service.ts`
+- `user.route.ts`
+- `user.interface.ts`
+- `user.validation.ts`
+- `user.constant.ts`
+
+### 2. `build`
+
+Builds the application for production deployment.
+
+**Syntax:**
+```bash
+apollo-cli build
+```
+
+**What it does:**
+- Cleans the `dist` folder.
+- Compiles TypeScript files.
+- Copies `package.json`, `package-lock.json`, and `.env` to the `dist` folder.
+
+### 3. `prisma`
+
+Helper commands for Prisma ORM.
+
+**Generate Client:**
+```bash
+apollo-cli prisma generate
+```
+*(Runs `npx prisma generate`)*
+
+**Run Migrations:**
+```bash
+apollo-cli prisma migrate
+```
+*(Runs `npx prisma migrate dev`)*
+
+## Development
+
+To run the CLI directly from source without building:
+
+```bash
+npx ts-node src/bin/index.ts <command>
+```
+Example:
+```bash
+npx ts-node src/bin/index.ts generate module Product
+```

package/dist/bin/index.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const generate_1 = require("../commands/generate");
+const build_1 = require("../commands/build");
+const prisma_1 = require("../commands/prisma");
+const init_1 = require("../commands/init");
+const program = new commander_1.Command();
+program
+    .version('1.0.0')
+    .description('Apollo CLI Tool');
+program.addCommand(generate_1.generateCommand);
+program.addCommand(build_1.buildCommand);
+program.addCommand(prisma_1.prismaCommand);
+program.addCommand(init_1.initCommand);
+program.parse(process.argv);

package/dist/commands/build.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildCommand = void 0;
+const commander_1 = require("commander");
+const child_process_1 = require("child_process");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+exports.buildCommand = new commander_1.Command('build')
+    .description('Build the application for production')
+    .action(async () => {
+    console.log(chalk_1.default.blue('🚀 Starting build process...'));
+    try {
+        // 1. Clean dist folder
+        const distPath = path_1.default.join(process.cwd(), 'dist');
+        if (fs_extra_1.default.existsSync(distPath)) {
+            console.log(chalk_1.default.yellow('🧹 Cleaning dist folder...'));
+            await fs_extra_1.default.remove(distPath);
+        }
+        // 2. Run TypeScript Compiler
+        console.log(chalk_1.default.blue('🔨 Compiling TypeScript...'));
+        (0, child_process_1.execSync)('npx tsc', { stdio: 'inherit' });
+        // 3. Copy Key Files
+        console.log(chalk_1.default.blue('📂 Copying static files...'));
+        const filesToCopy = ['package.json', 'package-lock.json', '.env'];
+        for (const file of filesToCopy) {
+            const srcPath = path_1.default.join(process.cwd(), file);
+            if (fs_extra_1.default.existsSync(srcPath)) {
+                await fs_extra_1.default.copy(srcPath, path_1.default.join(distPath, file));
+            }
+        }
+        console.log(chalk_1.default.green('\n✅ Build completed successfully!'));
+        console.log(chalk_1.default.white('To deploy, upload the "dist" folder and run:'));
+        console.log(chalk_1.default.cyan('npm install --production'));
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('❌ Build failed:'), error);
+        process.exit(1);
+    }
+});

package/dist/commands/generate.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateCommand = void 0;
+const commander_1 = require("commander");
+const inquirer_1 = __importDefault(require("inquirer"));
+const path_1 = __importDefault(require("path"));
+const generator_1 = require("../utils/generator");
+exports.generateCommand = new commander_1.Command('generate')
+    .alias('g')
+    .description('Generate a new resource')
+    .argument('[type]', 'Type of resource to generate (e.g., module)')
+    .argument('[name]', 'Name of the resource')
+    .action(async (type, name) => {
+    // 1. Validate Input
+    if (!type) {
+        const answers = await inquirer_1.default.prompt([{
+                type: 'list',
+                name: 'type',
+                message: 'What would you like to generate?',
+                choices: ['module']
+            }]);
+        type = answers.type;
+    }
+    if (type !== 'module') {
+        console.error('Only "module" generation is currently supported.');
+        return;
+    }
+    if (!name) {
+        const answers = await inquirer_1.default.prompt([{
+                type: 'input',
+                name: 'name',
+                message: 'What is the name of the module?',
+                validate: (input) => input.trim() !== '' ? 'Module name is required' : true
+            }]);
+        name = answers.name;
+    }
+    const moduleNameRaw = name.trim();
+    // 2. Format Casing
+    const capitalize = (s) => s.charAt(0).toUpperCase() + s.slice(1);
+    const camelize = (s) => s.charAt(0).toLowerCase() + s.slice(1);
+    const moduleNamePascal = capitalize(moduleNameRaw);
+    const moduleNameCamel = camelize(moduleNameRaw);
+    console.log(`Generating module: ${moduleNamePascal}...`);
+    // 3. Define Output Paths
+    // Assume we are in the project root
+    const baseDir = path_1.default.join(process.cwd(), 'src/app/modules', moduleNamePascal);
+    // 4. Generate Files
+    const files = [
+        { template: 'module/controller.ejs', output: `${moduleNameCamel}.controller.ts` },
+        { template: 'module/service.ejs', output: `${moduleNameCamel}.service.ts` },
+        { template: 'module/route.ejs', output: `${moduleNameCamel}.route.ts` },
+        { template: 'module/interface.ejs', output: `${moduleNameCamel}.interface.ts` },
+        { template: 'module/validation.ejs', output: `${moduleNameCamel}.validation.ts` },
+        { template: 'module/constant.ejs', output: `${moduleNameCamel}.constant.ts` },
+    ];
+    for (const file of files) {
+        await (0, generator_1.renderTemplate)(file.template, path_1.default.join(baseDir, file.output), { moduleName: moduleNamePascal, camelModuleName: moduleNameCamel });
+    }
+    // 5. Success Message
+    console.log('\nModule generated successfully! 🚀');
+});

package/dist/commands/init.js

@@ -0,0 +1,181 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initCommand = void 0;
+const commander_1 = require("commander");
+const inquirer_1 = __importDefault(require("inquirer"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const child_process_1 = require("child_process");
+exports.initCommand = new commander_1.Command('init')
+    .description('Initialize a new Apollo Gears project')
+    .argument('[projectName]', 'Name of the project directory')
+    .action(async (projectName) => {
+    // 1. Prompt for Project Name if missing
+    if (!projectName) {
+        const answers = await inquirer_1.default.prompt([
+            {
+                type: 'input',
+                name: 'name',
+                message: 'What is the name of your project?',
+                default: 'my-apollo-app',
+                validate: (input) => input.trim() !== '' ? true : 'Project name is required'
+            }
+        ]);
+        projectName = answers.name;
+    }
+    const projectRoot = path_1.default.join(process.cwd(), projectName);
+    if (fs_extra_1.default.existsSync(projectRoot)) {
+        console.error(chalk_1.default.red(`Error: Directory "${projectName}" already exists.`));
+        process.exit(1);
+    }
+    console.log(chalk_1.default.blue(`\n🚀 Initializing project in ${projectRoot}...\n`));
+    try {
+        // 2. Create Directory
+        await fs_extra_1.default.ensureDir(projectRoot);
+        // 3. Create Package.json
+        const packageJson = {
+            name: projectName,
+            version: "1.0.0",
+            description: "Backend project generated by Apollo Gears CLI",
+            main: "dist/server.js",
+            scripts: {
+                "start": "node dist/server.js",
+                "dev": "ts-node-dev --respawn --transpile-only src/server.ts",
+                "build": "tsc",
+                "lint": "eslint src/**/*.ts",
+                "lint:fix": "eslint src/**/*.ts --fix",
+                "format": "prettier --write ."
+            },
+            keywords: ["express", "prisma", "typescript", "apollo-gears"],
+            author: "",
+            license: "ISC",
+            dependencies: {
+                "express": "^4.18.2",
+                "cors": "^2.8.5",
+                "dotenv": "^16.3.1",
+                "http-status": "^1.7.3",
+                "@prisma/client": "^5.7.1"
+            },
+            devDependencies: {
+                "typescript": "^5.3.3",
+                "ts-node-dev": "^2.0.0",
+                "@types/node": "^20.10.4",
+                "@types/express": "^4.17.21",
+                "@types/cors": "^2.8.17",
+                "prisma": "^5.7.1",
+                "eslint": "^8.55.0",
+                "prettier": "^3.1.1"
+            }
+        };
+        await fs_extra_1.default.writeJson(path_1.default.join(projectRoot, 'package.json'), packageJson, { spaces: 2 });
+        // 4. Create tsconfig.json
+        const tsconfig = {
+            "compilerOptions": {
+                "target": "ES2021",
+                "module": "commonjs",
+                "moduleResolution": "node",
+                "outDir": "./dist",
+                "rootDir": "./src",
+                "strict": true,
+                "esModuleInterop": true,
+                "skipLibCheck": true,
+                "forceConsistentCasingInFileNames": true
+            },
+            "include": ["src/**/*"],
+            "exclude": ["node_modules"]
+        };
+        await fs_extra_1.default.writeJson(path_1.default.join(projectRoot, 'tsconfig.json'), tsconfig, { spaces: 2 });
+        // 5. Create Scaffolding Folders
+        const folders = [
+            'src/app/modules',
+            'src/app/middlewares',
+            'src/app/routes',
+            'src/app/utils',
+            'src/app/errors',
+            'src/app/config'
+        ];
+        for (const folder of folders) {
+            await fs_extra_1.default.ensureDir(path_1.default.join(projectRoot, folder));
+        }
+        // 6. Create Essential Files
+        // src/server.ts
+        const serverContent = `import app from './app';
+import config from './app/config';
+
+async function main() {
+  try {
+    app.listen(config.port, () => {
+      console.log(\`Example app listening on port \${config.port}\`);
+    });
+  } catch (err) {
+    console.log(err);
+  }
+}
+
+main();`;
+        await fs_extra_1.default.writeFile(path_1.default.join(projectRoot, 'src/server.ts'), serverContent);
+        // src/app.ts
+        const appContent = `import express, { Application, Request, Response } from 'express';
+import cors from 'cors';
+
+const app: Application = express();
+
+// parsers
+app.use(express.json());
+app.use(cors());
+
+// application routes
+// app.use('/api/v1', router);
+
+app.get('/', (req: Request, res: Response) => {
+  res.send('Hello from Apollo Gears World!');
+});
+
+export default app;`;
+        await fs_extra_1.default.writeFile(path_1.default.join(projectRoot, 'src/app.ts'), appContent);
+        // src/app/config/index.ts
+        const configContent = `import dotenv from 'dotenv';
+import path from 'path';
+
+dotenv.config({ path: path.join(process.cwd(), '.env') });
+
+export default {
+  port: process.env.PORT,
+  database_url: process.env.DATABASE_URL,
+};`;
+        await fs_extra_1.default.writeFile(path_1.default.join(projectRoot, 'src/app/config/index.ts'), configContent);
+        // .env
+        const envContent = `PORT=5000
+DATABASE_URL="postgresql://johndoe:randompassword@localhost:5432/mydb?schema=public"`;
+        await fs_extra_1.default.writeFile(path_1.default.join(projectRoot, '.env'), envContent);
+        // .gitignore
+        const gitignoreContent = `node_modules
+dist
+.env`;
+        await fs_extra_1.default.writeFile(path_1.default.join(projectRoot, '.gitignore'), gitignoreContent);
+        console.log(chalk_1.default.green('\n✅ Project structure created successfully!'));
+        // 7. Install Dependencies Prompt
+        const { install } = await inquirer_1.default.prompt([
+            {
+                type: 'confirm',
+                name: 'install',
+                message: 'Would you like to install dependencies now?',
+                default: true
+            }
+        ]);
+        if (install) {
+            console.log(chalk_1.default.yellow('\n📦 Installing dependencies...'));
+            (0, child_process_1.execSync)('npm install', { cwd: projectRoot, stdio: 'inherit' });
+            console.log(chalk_1.default.green('\n✅ Dependencies installed!'));
+        }
+        console.log(chalk_1.default.cyan(`\nTo get started:\n  cd ${projectName}\n  ${install ? 'npm run dev' : 'npm install && npm run dev'}\n`));
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('❌ Initialization failed:'), error);
+        process.exit(1);
+    }
+});

package/dist/commands/prisma.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prismaCommand = void 0;
+const commander_1 = require("commander");
+const child_process_1 = require("child_process");
+const chalk_1 = __importDefault(require("chalk"));
+exports.prismaCommand = new commander_1.Command('prisma')
+    .description('Prisma utility commands')
+    .argument('<action>', 'Action to perform (generate, migrate)')
+    .action(async (action) => {
+    try {
+        if (action === 'generate') {
+            console.log(chalk_1.default.blue('🔄 Generating Prisma Client...'));
+            (0, child_process_1.execSync)('npx prisma generate', { stdio: 'inherit' });
+            console.log(chalk_1.default.green('✅ Prisma Client generated!'));
+        }
+        else if (action === 'migrate') {
+            console.log(chalk_1.default.blue('🔄 Running Migrations...'));
+            (0, child_process_1.execSync)('npx prisma migrate dev', { stdio: 'inherit' });
+            console.log(chalk_1.default.green('✅ Migrations applied!'));
+        }
+        else {
+            console.error(chalk_1.default.red(`Unknown action: ${action}`));
+            console.log('Available actions: generate, migrate');
+        }
+    }
+    catch (error) {
+        // Error is already logged by inherit stdio usually, but we catch to prevent crash dump
+        console.error(chalk_1.default.red('❌ Prisma command failed.'));
+        process.exit(1);
+    }
+});

package/dist/utils/generator.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderTemplate = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const ejs_1 = __importDefault(require("ejs"));
+const chalk_1 = __importDefault(require("chalk"));
+const renderTemplate = async (templateName, targetPath, data) => {
+    try {
+        // Resolve template path - assuming templates are in src/templates or dist/templates
+        // We look up from the current file location
+        const templateDir = path_1.default.resolve(__dirname, '../../src/templates');
+        const templatePath = path_1.default.join(templateDir, templateName);
+        // Fallback for dist structure if src not found (pseudo-logic for now, ideally strictly copy them)
+        // If running in ts-node, __dirname is src/utils, so ../templates works if we are at src
+        // Let's rely on standard path resolution relative to this file
+        // Check if template exists
+        if (!fs_extra_1.default.existsSync(templatePath)) {
+            // Try looking in dist if we are in dist
+            const distTemplatePath = path_1.default.join(__dirname, '../templates', templateName);
+            if (!fs_extra_1.default.existsSync(distTemplatePath)) {
+                console.error(chalk_1.default.red(`Template not found at: ${templatePath}`));
+                return;
+            }
+        }
+        const templateContent = await fs_extra_1.default.readFile(templatePath, 'utf-8');
+        const renderedContent = ejs_1.default.render(templateContent, data);
+        // Create directory if it doesn't exist
+        await fs_extra_1.default.ensureDir(path_1.default.dirname(targetPath));
+        // Write file
+        await fs_extra_1.default.writeFile(targetPath, renderedContent);
+        console.log(chalk_1.default.green(`✓ Created: ${path_1.default.relative(process.cwd(), targetPath)}`));
+    }
+    catch (error) {
+        console.error(chalk_1.default.red('Error generating file:'), error);
+        process.exit(1);
+    }
+};
+exports.renderTemplate = renderTemplate;

package/package.json

@@ -0,0 +1,47 @@
+{
+    "name": "@bayajidalam/apollo-cli",
+    "version": "1.0.0",
+    "description": "CLI tool for speed up backend projects",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "bin": {
+        "apollo-cli": "dist/bin/index.js"
+    },
+    "scripts": {
+        "start": "ts-node src/index.ts",
+        "build": "tsc",
+        "watch": "tsc -w",
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "cli": "ts-node src/bin/index.ts"
+    },
+    "keywords": [
+        "cli",
+        "express",
+        "prisma",
+        "postgres",
+        "typescript"
+    ],
+    "author": "Bayajid Alam Joyel",
+    "repository": {
+        "url": "https://github.com/BayajidAlam/apollo-cli"
+    },
+    "license": "ISC",
+    "publishConfig": {
+        "access": "public"
+    },
+    "dependencies": {
+        "chalk": "^4.1.2",
+        "commander": "^13.1.0",
+        "ejs": "^3.1.10",
+        "fs-extra": "^11.3.0",
+        "inquirer": "^8.2.6"
+    },
+    "devDependencies": {
+        "@types/ejs": "^3.1.5",
+        "@types/fs-extra": "^11.0.4",
+        "@types/inquirer": "^8.2.6",
+        "@types/node": "^22.13.1",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.7.3"
+    }
+}