@nishant0121/set-it-up 0.0.9 → 0.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nishant0121/set-it-up",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "A high-performance CLI tool to bootstrap and forge new projects with pre-configured templates, prerequisite checking, and interactive setup.",
   "license": "ISC",
   "author": "Nishant Patil",

package/src/engines/express.js

@@ -0,0 +1,86 @@
+import { execa } from 'execa';
+import ora from 'ora';
+import chalk from 'chalk';
+import fs from 'fs-extra';
+import path from 'path';
+
+import { 
+  getPackageJson, 
+  getTsConfig, 
+  getIndex, 
+  getRouteIndex, 
+  getController 
+} from '../templates/express/main.js';
+
+export async function setupExpress(answers, expressAnswers) {
+  const spinner = ora('Initializing Express project...').start();
+  try {
+    const { projectName, packageManager } = answers;
+    const isTypescript = expressAnswers.language === 'TypeScript';
+    const projectPath = path.join(process.cwd(), projectName);
+
+    // 1. Create Project Directory
+    await fs.ensureDir(projectPath);
+
+    // 2. Create package.json
+    spinner.text = 'Creating package.json...';
+    const packageJsonContent = getPackageJson(projectName, isTypescript);
+    await fs.writeFile(path.join(projectPath, 'package.json'), packageJsonContent);
+
+    // 3. Create tsconfig.json (if TypeScript)
+    if (isTypescript) {
+      spinner.text = 'Creating tsconfig.json...';
+      const tsConfigContent = getTsConfig();
+      await fs.writeFile(path.join(projectPath, 'tsconfig.json'), tsConfigContent);
+    }
+
+    // 4. Create Source Directories and Files
+    spinner.text = 'Generating project structure...';
+    const srcDir = path.join(projectPath, 'src');
+    const routesDir = path.join(srcDir, 'routes');
+    const controllersDir = path.join(srcDir, 'controllers');
+
+    await fs.ensureDir(srcDir);
+    await fs.ensureDir(routesDir);
+    await fs.ensureDir(controllersDir);
+
+    const ext = isTypescript ? 'ts' : 'js';
+
+    // src/index.ts or src/index.js
+    await fs.writeFile(path.join(srcDir, `index.${ext}`), getIndex(isTypescript));
+
+    // src/routes/index.ts or src/routes/index.js
+    await fs.writeFile(path.join(routesDir, `index.${ext}`), getRouteIndex(isTypescript));
+
+    // src/controllers/exampleController.ts or src/controllers/exampleController.js
+    await fs.writeFile(path.join(controllersDir, `exampleController.${ext}`), getController(isTypescript));
+
+    // Create .env file
+    await fs.writeFile(path.join(projectPath, '.env'), 'PORT=3000\n');
+
+    // Create .gitignore
+    const gitignoreContent = `node_modules
+.env
+dist
+.DS_Store
+coverage
+`;
+    await fs.writeFile(path.join(projectPath, '.gitignore'), gitignoreContent);
+
+
+    // 5. Install Dependencies
+    spinner.text = 'Installing dependencies...';
+    const installCmd = packageManager === 'npm' ? 'install' : 'add';
+    await execa(packageManager, [installCmd], { cwd: projectPath });
+
+    spinner.succeed(chalk.green(`Express project ${projectName} created successfully! 🚀`));
+    console.log(chalk.cyan(`
+To get started:
+  cd ${projectName}
+  ${packageManager} run dev`));
+
+  } catch (error) {
+    spinner.fail('Setup failed.');
+    console.error(error);
+  }
+}

package/src/templates/express/configuration.js

@@ -0,0 +1,63 @@
+export const getPackageJson = (projectName, isTypescript) => {
+  const commonScripts = {
+    "start": "node src/index.js",
+    "dev": "nodemon src/index.js"
+  };
+
+  const tsScripts = {
+    "start": "tsx src/index.ts",
+    "dev": "tsx watch src/index.ts",
+    "build": "tsc"
+  };
+
+  const dependencies = {
+    "express": "^4.18.2",
+    "cors": "^2.8.5",
+    "dotenv": "^16.3.1",
+    "helmet": "^7.1.0",
+    "morgan": "^1.10.0"
+  };
+
+  const devDependencies = isTypescript ? {
+    "typescript": "^5.3.3",
+    "tsx": "^4.7.0",
+    "@types/node": "^20.10.6",
+    "@types/express": "^4.17.21",
+    "@types/cors": "^2.8.17",
+    "@types/morgan": "^1.9.9"
+  } : {
+    "nodemon": "^3.0.2"
+  };
+
+  return JSON.stringify({
+    name: projectName,
+    version: "1.0.0",
+    description: "Express.js application generated by set-it-up",
+    main: isTypescript ? "src/index.ts" : "src/index.js",
+    type: "module",
+    scripts: isTypescript ? tsScripts : commonScripts,
+    dependencies,
+    devDependencies,
+    keywords: [],
+    author: "",
+    license: "ISC"
+  }, null, 2);
+};
+
+export const getTsConfig = () => {
+  return JSON.stringify({
+    "compilerOptions": {
+      "target": "es2020",
+      "module": "esnext",
+      "moduleResolution": "node",
+      "outDir": "./dist",
+      "rootDir": "./src",
+      "strict": true,
+      "esModuleInterop": true,
+      "skipLibCheck": true,
+      "forceConsistentCasingInFileNames": true
+    },
+    "include": ["src/**/*"],
+    "exclude": ["node_modules"]
+  }, null, 2);
+};

package/src/templates/express/controllers.js

@@ -0,0 +1,9 @@
+export const getController = (isTypescript) => {
+  const importStatement = isTypescript ? "import { Request, Response } from 'express';\n" : "";
+  return `${importStatement}
+export const getExample = (req${isTypescript ? ': Request' : ''}, res${isTypescript ? ': Response' : ''}) => {
+  res.json({ message: 'This is an example controller response' });
+};
+`;
+};
+

package/src/templates/express/entry.js

@@ -0,0 +1,42 @@
+export const getIndex = (isTypescript) => {
+  const portVar = isTypescript ? 'const PORT: number | string = process.env.PORT || 3000;' : 'const PORT = process.env.PORT || 3000;';
+
+  return `import express${isTypescript ? ', { Express, Request, Response }' : ''} from 'express';
+import cors from 'cors';
+import helmet from 'helmet';
+import morgan from 'morgan';
+import dotenv from 'dotenv';
+import router from './routes/index.js';
+
+dotenv.config();
+
+const app${isTypescript ? ': Express' : ''} = express();
+${portVar}
+
+// Middleware
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+app.use(cors());
+app.use(helmet());
+app.use(morgan('dev'));
+
+// Routes
+app.use('/api', router);
+
+app.get('/', (req${isTypescript ? ': Request' : ''}, res${isTypescript ? ': Response' : ''}) => {
+  res.send('Welcome to your Express.js API!');
+});
+
+// Error handling middleware
+app.use((err${isTypescript ? ': any' : ''}, req${isTypescript ? ': Request' : ''}, res${isTypescript ? ': Response' : ''}, next${isTypescript ? ': Function' : ''}) => {
+  console.error(err.stack);
+  res.status(500).send('Something broke!');
+});
+
+app.listen(PORT, () => {
+  console.log(\`Server is running on port \${PORT}\`);
+  console.log('Visit http://localhost:' + PORT);
+  console.log('Press CTRL+C to stop the server');
+});
+`
+};

package/src/templates/express/main.js

@@ -0,0 +1,4 @@
+export * from './configuration.js';
+export * from './entry.js';
+export * from './routes.js';
+export * from './controllers.js';

package/src/templates/express/routes.js

@@ -0,0 +1,11 @@
+export const getRouteIndex = (isTypescript) => {
+  return `import { Router } from 'express';
+import { getExample } from '../controllers/exampleController.js';
+
+const router = Router();
+
+router.get('/example', getExample);
+
+export default router;
+`;
+};

package/src/wizard.js

@@ -5,6 +5,7 @@ import boxen from 'boxen';
 import { checkPrerequisites } from './utils/checkEnv.js';
 import { setupReactNative } from './engines/reactNative.js';
 import { setupReact } from './engines/react.js';
+import { setupExpress } from './engines/express.js';
 
 export async function mainWizard() {
   // Clear the console for a fresh start
@@ -39,7 +40,7 @@ export async function mainWizard() {
       type: 'rawlist',
       name: 'projectType',
       message: 'What do you want to build today?',
-      choices: ['React', 'React Native', 'Next.js (Coming Soon)', 'Custom GitHub Template'],
+      choices: ['React', 'React Native', 'Express.js', 'Next.js (Coming Soon)', 'Custom GitHub Template'],
     },
     {
       type: 'input',
@@ -118,6 +119,18 @@ export async function mainWizard() {
 
     await setupReact(answers, reactAnswers);
 
+  } else if (answers.projectType === 'Express.js') {
+    const expressAnswers = await inquirer.prompt([
+      {
+        type: 'rawlist',
+        name: 'language',
+        message: 'Which language do you want to use?',
+        choices: ['TypeScript', 'JavaScript'],
+      }
+    ]);
+
+    await setupExpress(answers, expressAnswers);
+
   } else {
     console.log(chalk.yellow('\n🚧 This feature is coming soon! Stay tuned.\n'));
   }