create-express-mongo-ts 1.0.0 → 1.1.0

package/README.md

@@ -1,14 +1,14 @@
-# create-express-mongo
+# create-express-mongo-ts
 
 Create Express + MongoDB applications with TypeScript, authentication, and best practices out of the box.
 
-[![npm version](https://img.shields.io/npm/v/create-express-mongo.svg)](https://www.npmjs.com/package/create-express-mongo)
+[![npm version](https://img.shields.io/npm/v/create-express-mongo-ts.svg)](https://www.npmjs.com/package/create-express-mongo-ts)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## Quick Start
 
 ```bash
-npx create-express-mongo my-app
+npx create-express-mongo-ts my-app
 cd my-app
 npm install
 cp .env.example .env

package/bin/cli.js

@@ -1,104 +1,128 @@
-#!/usr/bin/env node
-
-const { execSync } = require('child_process');
-const path = require('path');
-const fs = require('fs');
-
-// Colors for console output
-const colors = {
-    reset: '\x1b[0m',
-    bright: '\x1b[1m',
-    green: '\x1b[32m',
-    cyan: '\x1b[36m',
-    yellow: '\x1b[33m',
-    red: '\x1b[31m',
-};
+import inquirer from 'inquirer';
+import path from 'path';
+import fs from 'fs';
+import chalk from 'chalk';
+import { execSync } from 'child_process';
+import { fileURLToPath } from 'url';
 
-const log = {
-    info: (msg) => console.log(`${colors.cyan}ℹ${colors.reset} ${msg}`),
-    success: (msg) => console.log(`${colors.green}✔${colors.reset} ${msg}`),
-    warn: (msg) => console.log(`${colors.yellow}⚠${colors.reset} ${msg}`),
-    error: (msg) => console.log(`${colors.red}✖${colors.reset} ${msg}`),
-};
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
-// Get project name from command line arguments
-const projectName = process.argv[2];
+const GITLAB_CI_FILE = '.gitlab-ci.yml';
+const GITHUB_CI_FOLDER = '.github';
+const PACKAGE_JSON = 'package.json';
 
-if (!projectName) {
-    log.error('Please specify the project directory:');
-    console.log(
-        `  ${colors.cyan}npx create-express-mongo${colors.reset} ${colors.green}<project-directory>${colors.reset}`,
-    );
-    console.log();
-    console.log('For example:');
+const styles = {
+    command: (cmd) => chalk.cyan.bold(cmd),
+    path: (p) => chalk.gray(p),
+    success: (msg) => chalk.green(msg),
+    warning: (msg) => chalk.yellow(msg),
+    error: (msg) => chalk.red(msg),
+    heading: (msg) => chalk.bold(msg),
+};
+
+async function createExpressMongo() {
     console.log(
-        `  ${colors.cyan}npx create-express-mongo${colors.reset} ${colors.green}my-app${colors.reset}`,
+        chalk.cyan.bold('\n🚀 Create Express MongoDB TypeScript App\n'),
     );
-    process.exit(1);
-}
 
-const currentPath = process.cwd();
-const projectPath = path.join(currentPath, projectName);
-const templatePath = path.join(__dirname, '..', 'template');
+    // Get project name from command line or prompt
+    let projectName = process.argv[2];
 
-// Check if directory already exists
-if (fs.existsSync(projectPath)) {
-    log.error(
-        `The directory ${colors.green}${projectName}${colors.reset} already exists.`,
-    );
-    log.info(
-        'Please choose a different project name or delete the existing directory.',
-    );
-    process.exit(1);
+    const answers = await inquirer.prompt([
+        {
+            type: 'input',
+            name: 'appName',
+            message: 'What is your app name?',
+            default: projectName || 'my-express-mongo-app',
+            validate(input) {
+                if (!input.trim()) return 'App name cannot be empty';
+                if (!/^[a-z0-9-_]+$/i.test(input))
+                    return 'App name can only contain letters, numbers, hyphens and underscores';
+                return true;
+            },
+        },
+        {
+            type: 'list',
+            name: 'gitProvider',
+            message: 'Which Git provider do you want to use?',
+            choices: [
+                { name: 'GitHub', value: 'github' },
+                { name: 'GitLab', value: 'gitlab' },
+                { name: 'None', value: 'none' },
+            ],
+            default: 'github',
+        },
+        {
+            type: 'confirm',
+            name: 'initGit',
+            message: 'Initialize a git repository?',
+            default: true,
+        },
+    ]);
+
+    createApp(answers);
 }
 
-console.log();
-console.log(
-    `${colors.bright}Creating a new Express + MongoDB app in ${colors.green}${projectPath}${colors.reset}`,
-);
-console.log();
+function createApp({ appName, gitProvider, initGit }) {
+    const targetDir = path.join(process.cwd(), appName);
+    const templateDir = path.join(__dirname, '../template');
 
-// Create project directory
-fs.mkdirSync(projectPath, { recursive: true });
+    // Check if directory exists
+    if (fs.existsSync(targetDir)) {
+        console.log(styles.error(`\n✖ Folder "${appName}" already exists.`));
+        process.exit(1);
+    }
 
-// Function to copy directory recursively
-function copyDir(src, dest) {
-    fs.mkdirSync(dest, { recursive: true });
-    const entries = fs.readdirSync(src, { withFileTypes: true });
+    console.log(
+        styles.heading(
+            `\nCreating a new Express + MongoDB app in ${styles.path(
+                targetDir,
+            )}\n`,
+        ),
+    );
 
-    for (const entry of entries) {
-        const srcPath = path.join(src, entry.name);
-        const destPath = path.join(dest, entry.name);
+    // Copy template files
+    console.log(chalk.cyan('ℹ') + ' Copying template files...');
+    copyDir(templateDir, targetDir);
+    console.log(styles.success('✔ Template files copied successfully.'));
 
-        if (entry.isDirectory()) {
-            copyDir(srcPath, destPath);
-        } else {
-            fs.copyFileSync(srcPath, destPath);
+    // Handle git provider - remove unused CI files
+    if (gitProvider === 'github') {
+        const gitlabPath = path.join(targetDir, GITLAB_CI_FILE);
+        if (fs.existsSync(gitlabPath)) {
+            fs.rmSync(gitlabPath, { recursive: true, force: true });
+        }
+    } else if (gitProvider === 'gitlab') {
+        const githubPath = path.join(targetDir, GITHUB_CI_FOLDER);
+        if (fs.existsSync(githubPath)) {
+            fs.rmSync(githubPath, { recursive: true, force: true });
         }
+    } else {
+        // Remove both if none selected
+        const gitlabPath = path.join(targetDir, GITLAB_CI_FILE);
+        const githubPath = path.join(targetDir, GITHUB_CI_FOLDER);
+        if (fs.existsSync(gitlabPath))
+            fs.rmSync(gitlabPath, { recursive: true, force: true });
+        if (fs.existsSync(githubPath))
+            fs.rmSync(githubPath, { recursive: true, force: true });
     }
-}
-
-try {
-    // Copy template files
-    log.info('Copying template files...');
-    copyDir(templatePath, projectPath);
-    log.success('Template files copied successfully.');
 
     // Update package.json with project name
-    const packageJsonPath = path.join(projectPath, 'package.json');
-    if (fs.existsSync(packageJsonPath)) {
-        const packageJson = JSON.parse(
-            fs.readFileSync(packageJsonPath, 'utf8'),
+    const pkgPath = path.join(targetDir, PACKAGE_JSON);
+    if (fs.existsSync(pkgPath)) {
+        const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+        pkg.name = appName;
+        pkg.version = '1.0.0';
+        pkg.description = `${appName} - Express + MongoDB TypeScript application`;
+        fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2));
+        console.log(
+            styles.success('✔ Updated package.json with project name.'),
         );
-        packageJson.name = projectName;
-        packageJson.version = '1.0.0';
-        packageJson.description = `${projectName} - Express + MongoDB application`;
-        fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
-        log.success('Updated package.json with project name.');
     }
 
     // Create .env.example file
-    const envExamplePath = path.join(projectPath, '.env.example');
+    const envExamplePath = path.join(targetDir, '.env.example');
     if (!fs.existsSync(envExamplePath)) {
         const envContent = `# Server Configuration
 PORT=3000
@@ -107,35 +131,38 @@ NODE_ENV=development
 # Database Configuration
 DB_HOST=localhost
 DB_PORT=27017
-DB_NAME=${projectName}
+DB_NAME=${appName}
 DB_USER=
-DB_PASSWORD=
+DB_USER_PASSWORD=
 DB_MIN_POOL_SIZE=2
 DB_MAX_POOL_SIZE=5
 
 # JWT Configuration
 ACCESS_TOKEN_VALIDITY_SEC=3600
 REFRESH_TOKEN_VALIDITY_SEC=86400
+TOKEN_ISSUER=${appName}
+TOKEN_AUDIENCE=${appName}
 
 # CORS Configuration
-CORS_URL=*
+ORIGIN_URL=*
 
 # Logging
-LOG_DIR=logs
+LOG_DIRECTORY=logs
 `;
         fs.writeFileSync(envExamplePath, envContent);
-        log.success('Created .env.example file.');
+        console.log(styles.success('✔ Created .env.example file.'));
     }
 
     // Initialize git repository
-    log.info('Initializing git repository...');
-    try {
-        execSync('git init', { cwd: projectPath, stdio: 'ignore' });
-
-        // Create .gitignore if it doesn't exist
-        const gitignorePath = path.join(projectPath, '.gitignore');
-        if (!fs.existsSync(gitignorePath)) {
-            const gitignoreContent = `# Dependencies
+    if (initGit) {
+        console.log(chalk.cyan('ℹ') + ' Initializing git repository...');
+        try {
+            execSync('git init', { cwd: targetDir, stdio: 'ignore' });
+
+            // Create .gitignore if it doesn't exist
+            const gitignorePath = path.join(targetDir, '.gitignore');
+            if (!fs.existsSync(gitignorePath)) {
+                const gitignoreContent = `# Dependencies
 node_modules/
 
 # Build output
@@ -169,49 +196,77 @@ keys/*.key
 # TypeScript cache
 *.tsbuildinfo
 `;
-            fs.writeFileSync(gitignorePath, gitignoreContent);
+                fs.writeFileSync(gitignorePath, gitignoreContent);
+            }
+            console.log(styles.success('✔ Initialized git repository.'));
+        } catch (error) {
+            console.log(
+                styles.warning('⚠ Could not initialize git repository.'),
+            );
         }
-        log.success('Initialized git repository.');
-    } catch (error) {
-        log.warn(
-            'Could not initialize git repository. Please initialize it manually.',
-        );
     }
 
     // Success message
-    console.log();
     console.log(
-        `${colors.green}${colors.bright}Success!${colors.reset} Created ${colors.cyan}${projectName}${colors.reset} at ${colors.green}${projectPath}${colors.reset}`,
+        styles.success(`\n✨ Success! Created ${appName} at ${targetDir}\n`),
+    );
+
+    console.log(styles.heading('Next Steps:\n'));
+    console.log(
+        `  👉 Go to project directory: ${styles.command(`cd ${appName}`)}`,
+    );
+    console.log(
+        `  👉 Install dependencies:    ${styles.command('npm install')}`,
+    );
+    console.log(
+        `  👉 Set up environment:      ${styles.command(
+            'cp .env.example .env',
+        )}`,
+    );
+    console.log(
+        `  👉 Run the application:     ${styles.command('npm run dev')}`,
     );
     console.log();
-    console.log('Inside that directory, you can run several commands:');
-    console.log();
-    console.log(`  ${colors.cyan}npm install${colors.reset}`);
-    console.log('    Installs all dependencies.');
-    console.log();
-    console.log(`  ${colors.cyan}npm run dev${colors.reset}`);
-    console.log('    Starts the development server with hot-reload.');
-    console.log();
-    console.log(`  ${colors.cyan}npm run build${colors.reset}`);
-    console.log('    Builds the app for production.');
-    console.log();
-    console.log(`  ${colors.cyan}npm start${colors.reset}`);
-    console.log('    Builds and runs the production server.');
-    console.log();
-    console.log(`  ${colors.cyan}npm test${colors.reset}`);
-    console.log('    Runs the test suite.');
-    console.log();
-    console.log('We suggest that you begin by typing:');
-    console.log();
-    console.log(`  ${colors.cyan}cd${colors.reset} ${projectName}`);
-    console.log(`  ${colors.cyan}npm install${colors.reset}`);
-    console.log(`  ${colors.cyan}cp .env.example .env${colors.reset}`);
-    console.log(`  ${colors.cyan}npm run dev${colors.reset}`);
-    console.log();
-    console.log(`${colors.bright}Happy coding!${colors.reset} 🚀`);
+    console.log(styles.heading('Available Commands:\n'));
+    console.log(
+        `  ${styles.command(
+            'npm run dev',
+        )}     - Start development server with hot-reload`,
+    );
+    console.log(
+        `  ${styles.command('npm run build')}   - Build for production`,
+    );
+    console.log(
+        `  ${styles.command(
+            'npm start',
+        )}       - Build and run production server`,
+    );
+    console.log(`  ${styles.command('npm test')}        - Run test suite`);
+    console.log(
+        `  ${styles.command('npm run lint')}    - Check for linting errors`,
+    );
     console.log();
-} catch (error) {
-    log.error('An error occurred while creating the project:');
-    console.error(error);
-    process.exit(1);
+    console.log(chalk.bold('Happy coding! 🚀\n'));
+}
+
+// Recursively copy all files and folders
+function copyDir(src, dest) {
+    fs.mkdirSync(dest, { recursive: true });
+
+    for (const file of fs.readdirSync(src)) {
+        const srcPath = path.join(src, file);
+        const destPath = path.join(dest, file);
+
+        if (fs.statSync(srcPath).isDirectory()) {
+            copyDir(srcPath, destPath);
+            continue;
+        }
+
+        fs.copyFileSync(srcPath, destPath);
+    }
 }
+
+createExpressMongo().catch((error) => {
+    console.error(styles.error('An error occurred:'), error);
+    process.exit(1);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "create-express-mongo-ts",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "Create Express + MongoDB applications with TypeScript, authentication, and best practices out of the box",
     "main": "bin/cli.js",
     "bin": {
@@ -36,8 +36,12 @@
         "url": "https://github.com/sofikulsk02/express-mongobd-template/issues"
     },
     "homepage": "https://github.com/sofikulsk02/express-mongobd-template#readme",
-    "type": "commonjs",
+    "type": "module",
     "engines": {
         "node": ">=18.0.0"
+    },
+    "dependencies": {
+        "chalk": "^5.3.0",
+        "inquirer": "^9.2.12"
     }
 }