create-jerry 1.0.0 → 2.0.0

package/index.js

@@ -1,116 +1,125 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import chalk from 'chalk';
 import chalkAnimation from 'chalk-animation';
 import inquirer from 'inquirer';
-import { installer } from './installer.js';
-import { 
-    writeDbFiles, 
-    writeServerFiles, 
-    writeEnvFile 
+
+import {
+  writeCoreFiles,
+  writeUserModule,
+  writeEnvFile,
+  injectRoutes
 } from './fileCreator.js';
-import { createFolders, createProjectDir } from './folderCreater.js';
+
+import { createProjectDir } from './folderCreator.js';
 import { createPackageJson } from './packageJsonCreator.js';
 
-// global responses
+import { mongodbPlugin } from './plugins/mongodb.plugin.js';
+import { mysqlPlugin } from './plugins/mysql.plugin.js';
+import { aiPlugin } from './plugins/ai.plugin.js';
+import { applyPlugins } from './plugins/pluginManager.js';
+
+// globals
 let rawProjectName;
 let dbchoice;
 let langchoice;
 
-// timeout
-export const sleep = (ms = 1000) => new Promise((r) => setTimeout(r, ms));
+// utils
+const sleep = (ms = 1000) => new Promise((r) => setTimeout(r, ms));
 
-// welcome function 
 async function welcome() {
-    const rainbowTitle = chalkAnimation.rainbow("\n Welcome to JERRIT \n");
-    await sleep();
-    rainbowTitle.stop();
+  const rainbowTitle = chalkAnimation.rainbow("\n Welcome to JERRIT \n");
+  await sleep();
+  rainbowTitle.stop();
 }
 
-// project name
 async function askName() {
-    const res = await inquirer.prompt({
-        name: 'admin_name',
-        type: 'input',
-        message: `${chalk.magentaBright('Project name ?')}`,
-        default() {
-            return 'my-app';
-        },
-    });
-    
-    return res.admin_name;
+  const res = await inquirer.prompt({
+    name: 'name',
+    type: 'input',
+    message: 'Project name?',
+    default: 'my-app'
+  });
+  return res.name;
 }
 
-// database selection
 async function askDb() {
-    const res = await inquirer.prompt({
-        name: 'db_name',
-        type: 'list',
-        message: `${chalk.yellowBright('Select your Database ...')}`,
-        choices: [
-            { name: chalk.greenBright('MongoDB'), value: 'MongoDB' },
-            { name: chalk.whiteBright('MySQL'), value: 'MySQL' },
-        ],
-    });
-
-    dbchoice = res.db_name;
+  const res = await inquirer.prompt({
+    name: 'db',
+    type: 'list',
+    message: 'Select Database',
+    choices: ['MongoDB', 'MySQL']
+  });
+  dbchoice = res.db;
 }
 
-// language selection
 async function askLang() {
-    const res = await inquirer.prompt({
-        name: 'lang_name',
-        type: 'list',
-        message: `${chalk.green('Select your Language...')}`,
-        choices: [
-            `${chalk.cyanBright('Typescript')}`,
-            `${chalk.yellowBright('Javascript')}`,
-        ],
-    });
-
-    langchoice = res.lang_name;
+  const res = await inquirer.prompt({
+    name: 'lang',
+    type: 'list',
+    message: 'Select Language',
+    choices: ['Typescript', 'Javascript']
+  });
+  langchoice = res.lang;
 }
 
-// exit function 
-export async function exit(str) {
-    const rainbowTitle = chalkAnimation.rainbow(str);
-    await sleep();
-    rainbowTitle.stop();
+async function askAI() {
+  const res = await inquirer.prompt({
+    name: 'ai',
+    type: 'confirm',
+    message: 'Add AI module?',
+    default: false
+  });
+  return res.ai;
 }
 
-// Main execution
+// MAIN
 await welcome();
 
 rawProjectName = await askName();
-
-// Creating root directory
 createProjectDir(rawProjectName);
 
 await askDb();
 await askLang();
 
-console.log("\n");
+const aiEnabled = await askAI();
 
-// Project setup execution calls
-console.log(chalk.whiteBright("Setting up your Project ... "));
+console.log(chalk.whiteBright("\nSetting up project...\n"));
 
-// 1. Create folder structure
-const backendFolders = [
-  'src/config',
-  'src/controllers',
-  'src/middlewares',
-  'src/models',
-  'src/routes',
-];
-createFolders(backendFolders);
+// core
+await writeCoreFiles(langchoice);
 
-// 2. Create configuration and code files
+// base module
+await writeUserModule(langchoice);
+
+// env
 await writeEnvFile();
-await writeServerFiles();
-await writeDbFiles(dbchoice);
 
-// 3. Generate package.json
-await createPackageJson(rawProjectName, dbchoice, langchoice);
+// plugins
+const plugins = [];
+
+if (dbchoice === 'MongoDB') {
+  plugins.push(mongodbPlugin(langchoice));
+}
+
+if (dbchoice === 'MySQL') {
+  plugins.push(mysqlPlugin(langchoice));
+}
+
+if (aiEnabled) {
+  plugins.push(aiPlugin(langchoice));
+}
+
+await applyPlugins(plugins, { langchoice });
+
+// route injection
+const injections = plugins
+  .map((p) => p.inject)
+  .filter(Boolean);
+
+await injectRoutes(langchoice, injections);
+
+// package.json
+await createPackageJson(rawProjectName, dbchoice, langchoice, plugins);
 
-// 4. Install dependencies
-installer();
+// installer(); // optional

package/installer.js

@@ -1,32 +1,30 @@
 import { createSpinner } from 'nanospinner';
 import { execSync } from 'child_process';
 import chalk from 'chalk';
-import { exit } from './index.js';
 
-/**
- * Installs dependencies using npm install
- * Assumes package.json already exists in the current directory
- */
 export function installer() {
-  const spinner = createSpinner(chalk.whiteBright('Installing Dependencies...')).start();
+  const spinner = createSpinner(
+    chalk.whiteBright('Installing Dependencies...')
+  ).start();
 
   try {
-    // Simple npm install command - reads from package.json
     execSync('npm install', { stdio: 'inherit' });
 
     console.log('\n');
 
-    spinner.success({ 
-      text: `${chalk.greenBright('Dependencies Installed Successfully!\n')}` 
+    spinner.success({
+      text: chalk.greenBright('Dependencies Installed Successfully!\n')
     });
 
-    exit("Get Started !!!\n");
+    console.log(chalk.cyanBright('🚀 Get Started !!!\n'));
 
+    return true;
   } catch (err) {
-    spinner.error({ 
-      text: `${chalk.redBright('Failed to Install Dependencies')}` 
+    spinner.error({
+      text: chalk.redBright('Failed to Install Dependencies')
     });
+
     console.error(err);
-    exit("Try Again !!!");
+    return false;
   }
 }

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "create-jerry",
-  "version": "1.0.0",
-  "description": "A CLI tool to scaffold Express backend projects with MongoDB or MySQL",
+  "version": "2.0.0",
+  "description": "A CLI to scaffold Express backend projects with MongoDB or MySQL, plugin-based AI modules, and support for JavaScript and TypeScript.",
   "main": "index.js",
   "type": "module",
   "bin": {
     "create-jerry": "./index.js"
   },
+  "preferGlobal": true,
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
@@ -44,8 +45,9 @@
     "index.js",
     "installer.js",
     "fileCreator.js",
-    "folderCreater.js",
+    "folderCreator.js",
     "packageJsonCreator.js",
+    "plugins/",
     "Templates/",
     "README.md"
   ]

package/packageJsonCreator.js

@@ -1,92 +1,65 @@
-import * as fs from 'node:fs/promises';
+import fs from 'fs/promises';
 import path from 'path';
 
-/**
- * Generates package.json file based on project configuration
- * @param {string} projectName - Name of the project
- * @param {string} dbchoice - Database choice ('MongoDB' or 'MySQL')
- * @param {string} langchoice - Language choice ('Typescript' or 'Javascript')
- */
-export const createPackageJson = async (projectName, dbchoice, langchoice) => {
-  // Base dependencies that every project needs
-  const baseDependencies = {
+export const createPackageJson = async (
+  name,
+  db,
+  lang,
+  plugins = []
+) => {
+  const isTS = lang.includes('Typescript');
+
+  const dependencies = {
     express: '^4.18.2',
-    dotenv: '^16.3.1',
-    cors: '^2.8.5'
+    cors: '^2.8.5',
+    dotenv: '^16.3.1'
   };
 
-  // Database-specific dependencies
-  const dbDependencies = {
-    MongoDB: {
-      mongoose: '^8.0.3'
-    },
-    MySQL: {
-      mysql2: '^3.6.5'
+  // safe plugin merge
+  for (const plugin of plugins) {
+    if (plugin.dependencies) {
+      for (const key in plugin.dependencies) {
+        if (!dependencies[key]) {
+          dependencies[key] = plugin.dependencies[key];
+        }
+      }
     }
-  };
-
-  // Merge base dependencies with database-specific ones
-  const dependencies = {
-    ...baseDependencies,
-    ...dbDependencies[dbchoice]
-  };
+  }
 
-  // Development dependencies (common for both JS and TS)
   const devDependencies = {
-    nodemon: '^3.0.2'
+    nodemon: '^3.0.0'
   };
 
-  // Add TypeScript-specific dev dependencies if needed
-  if (langchoice.includes('Typescript')) {
-    devDependencies['typescript'] = '^5.3.3';
-    devDependencies['@types/node'] = '^20.10.6';
-    devDependencies['@types/express'] = '^4.17.21';
-    devDependencies['@types/cors'] = '^2.8.17';
-    devDependencies['ts-node'] = '^10.9.2';
+  if (isTS) {
+    devDependencies.typescript = '^5.0.0';
+    devDependencies.tsx = '^4.0.0';
+    devDependencies['@types/node'] = '^20.0.0';
+    devDependencies['@types/express'] = '^4.0.0';
   }
 
-  // Scripts configuration
-  const scripts = {
-    start: 'node app.js',
-    dev: 'nodemon app.js',
-    test: 'echo "Error: no test specified" && exit 1'
-  };
-
-  // Modify scripts for TypeScript
-  if (langchoice.includes('Typescript')) {
-    scripts.start = 'node dist/app.js';
-    scripts.dev = 'nodemon --exec ts-node app.ts';
-    scripts.build = 'tsc';
-  }
+  const scripts = isTS
+    ? {
+        dev: 'tsx watch src/server.ts',
+        build: 'tsc',
+        start: 'node dist/server.js'
+      }
+    : {
+        dev: 'nodemon src/server.js',
+        start: 'node src/server.js',
+        build: 'echo "No build step for JS"'
+      };
 
-  // Complete package.json object
-  const packageJson = {
-    name: projectName.toLowerCase().replace(/\s+/g, '-'),
+  const pkg = {
+    name,
     version: '1.0.0',
-    description: `A ${dbchoice} backend project scaffolded with JerrIt`,
-    main: langchoice.includes('Typescript') ? 'dist/app.js' : 'app.js',
     type: 'module',
     scripts,
-    keywords: ['express', 'backend', dbchoice.toLowerCase()],
-    author: '',
-    license: 'ISC',
     dependencies,
     devDependencies
   };
 
-  // Write package.json to the project root
-  const packageJsonPath = path.join(process.cwd(), 'package.json');
-
-  try {
-    await fs.writeFile(
-      packageJsonPath,
-      JSON.stringify(packageJson, null, 2),
-      'utf-8'
-    );
-    console.log('✅ package.json created successfully');
-    return true;
-  } catch (error) {
-    console.error('❌ Failed to create package.json:', error);
-    return false;
-  }
-};
+  await fs.writeFile(
+    path.join(process.cwd(), 'package.json'),
+    JSON.stringify(pkg, null, 2)
+  );
+};

package/plugins/ai.plugin.js

@@ -0,0 +1,25 @@
+import { writeAIModule } from '../fileCreator.js';
+
+export const aiPlugin = (langchoice) => {
+  const isTS = langchoice.includes('Typescript');
+
+  return {
+    name: 'ai',
+
+    async setup() {
+      await writeAIModule(langchoice);
+    },
+
+    inject: {
+      import: isTS
+        ? "import aiRoutes from '../modules/ai/ai.routes';"
+        : "import aiRoutes from '../modules/ai/ai.routes.js';",
+
+      use: "router.use('/ai', aiRoutes);"
+    },
+
+    dependencies: {
+      openai: '^4.0.0'
+    }
+  };
+};

package/plugins/mongodb.plugin.js

@@ -0,0 +1,15 @@
+import { writeDbFiles } from '../fileCreator.js';
+
+export const mongodbPlugin = (langchoice) => {
+  return {
+    name: 'mongodb',
+
+    async setup() {
+      await writeDbFiles('MongoDB', langchoice);
+    },
+
+    dependencies: {
+      mongoose: '^8.0.0'
+    }
+  };
+};

package/plugins/mysql.plugin.js

@@ -0,0 +1,15 @@
+import { writeDbFiles } from '../fileCreator.js';
+
+export const mysqlPlugin = (langchoice) => {
+  return {
+    name: 'mysql',
+
+    async setup() {
+      await writeDbFiles('MySQL', langchoice);
+    },
+
+    dependencies: {
+      mysql2: '^3.0.0'
+    }
+  };
+};

package/plugins/pluginManager.js

@@ -0,0 +1,18 @@
+export const applyPlugins = async (plugins = [], context = {}) => {
+  for (const plugin of plugins) {
+    if (!plugin) continue;
+
+    try {
+      console.log(`⚙️ Applying plugin: ${plugin.name}`);
+
+      if (plugin.setup) {
+        await plugin.setup(context);
+      }
+
+    } catch (err) {
+      console.error(`❌ Plugin failed: ${plugin.name}`);
+      console.error(err);
+      process.exit(1);
+    }
+  }
+};

package/Templates/db-mongo.js

@@ -1,20 +0,0 @@
-import mongoose from 'mongoose';
-
-const userSchema = new mongoose.Schema({
-    username: {
-        type: String,
-        required: true,
-        unique: true,
-    },
-    email: {
-        type: String,
-        required: true,
-        unique: true,
-    },
-    password: {
-        type: String,
-        required: true,
-    },
-}, { timestamps: true });
-
-export const User = mongoose.model('User', userSchema);

package/Templates/db-sql.js

@@ -1,35 +0,0 @@
-import mysql from 'mysql2'
-import dotenv from 'dotenv'
-dotenv.config()
-    
-const pool = mysql.createPool({
-    host: process.env.MYSQL_HOST ,
-    user: process.env.MYSQL_USER ,
-    password: process.env.MYSQL_PASSWORD ,
-    database: process.env.MYSQL_DATABASE
-    }).promise()
-        
-export async function getData() {
-    const [rows] = await pool.query("SELECT * FROM Db")
-    return rows
-}
-            
-export async function getDataById(id) {
-    const [rows] = await pool.query(`
-    SELECT * FROM Db
-    WHERE id = ${id};
-    `)
-    return rows[0]
-    }
-                
-export async function createData(title, contents) {
-        const [result] = await pool.query(`
-        INSERT INTO Db (title, contents)
-        VALUES(?, ?);
-        `, [title, contents])
-        const id = result.insertId 
-        return getData(id)
-}
-                    
-const result = await createData('test', 'test')
-console.log(result)

package/Templates/express.js

@@ -1,35 +0,0 @@
-import express from 'express'
-import cors from 'cors'
-const app = express()
-
-app.use(cors())
-app.use(json)
-
-
-//get the details
-app.get('/view', async (req, res) => {
-    res.send('hello')
-})
-
-//add new details
-app.post('/add', (req, res) => {
-    
-})
-
-//make changes in the database
-app.put('/edit', (req, res) => {
-    
-})
-
-//delete in the database
-app.delete('/delete', (req, res) => {
-    
-})
-
-app.listen(3000, () => {
-    try {
-        console.log(`The server is running on port: ${process.env.PORT}`)
-    } catch(err) {
-        console.log(err) 
-    }
-})

package/folderCreater.js

@@ -1,34 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-
-/**
- * Creates multiple nested folders inside the project.
- * @param {string[]} paths - Relative paths from project root (e.g., ['src/config', 'src/models'])
- */
-
-
-export const createProjectDir = (rawProjectName) => {
-  const projectDir = path.join(process.cwd(), rawProjectName);
-
-  // Create the project folder
-  if (!fs.existsSync(projectDir)) {
-    fs.mkdirSync(projectDir);
-    console.log(`📁 Project root created: ${rawProjectName}`);
-  }
-
-  // Switch working directory
-  process.chdir(projectDir);
-}
-
-
-export const createFolders = (paths) => {
-  paths.forEach((folderPath) => {
-    const fullPath = path.join(process.cwd(), folderPath);
-    if (!fs.existsSync(fullPath)) {
-      fs.mkdirSync(fullPath, { recursive: true });
-      console.log(`📁 Folder created: ${folderPath}`);
-    } else {
-      console.log(`📂 Folder already exists: ${folderPath}`);
-    }
-  });
-};