@imksh/create 1.0.0

package/README.md

@@ -0,0 +1,88 @@
+# @imksh/create
+
+A production-ready Node.js CLI tool to scaffold modern applications quickly. Built with ES Modules, Commander, Inquirer, Chalk, and Ora.
+
+## Installation
+
+You can use the CLI directly without installing via `npx` (or `pnpm dlx` / `yarn create`):
+
+```bash
+npx @imksh/create create my-app
+```
+
+Or you can install it globally:
+
+```bash
+npm install -g @imksh/create
+```
+
+## Usage
+
+Create a new project using the interactive prompt:
+
+```bash
+imksh create my-app
+```
+
+### Options
+
+- `--template <template-name>`: Bypass the interactive prompt and specify the template directly.
+- `--skip-install`: Skip the automatic installation of dependencies.
+- `--no-git`: Skip initializing a git repository.
+- `--yes`: Use default options for everything without prompting.
+
+### Examples
+
+```bash
+# Interactive mode
+imksh create my-app
+
+# Specify template directly
+imksh create my-app --template react-ts
+
+# Skip installing dependencies
+imksh create my-app --template next --skip-install
+```
+
+## Available Templates
+
+- `react`: Vite, React, React Router, Axios, TailwindCSS, Lucide.
+- `react-ts`: Same as `react`, but with TypeScript.
+- `node`: Express, security middlewares, separated `app.js`/`index.js` architecture, custom colorized logger, JWT, Rate Limiter, Socket.io scaffolding, web-push subscriptions, SMTP OTP mailer, and Cloudinary uploads.
+- `node-ts`: Same as `node`, but with TypeScript, global request type extensions (`src/types/express.d.ts`), and powered by `tsx` (TypeScript Execute) runtime.
+- `node-prisma`: Node.js template with Prisma ORM setup, mapping relational models for Users, OTPs, and push subscriptions.
+- `node-prisma-ts`: Same as `node-prisma`, but with TypeScript and `tsx` configuration.
+- `mern`: Full-stack React client + Express/Node server incorporating the new modular structure.
+- `mern-ts`: Full-stack React client (TS) + Express/Node server (TS) incorporating the new modular structure.
+- `next`: Next.js App Router boilerplate.
+- `next-ts`: Next.js App Router boilerplate with TypeScript.
+
+## Adding Templates
+
+To add a new template, simply create a new folder under `templates/` with your template name and populate it with the complete boilerplate. The CLI automatically copies it when selected.
+
+## Folder Structure
+
+```
+@imksh/create/
+├── bin/          # Executable entry
+├── src/          # Core CLI logic
+│   ├── commands/ # CLI Commands (create, etc.)
+│   └── utils/    # Helper functions
+└── templates/    # Project boilerplate templates
+```
+
+## Publishing to npm
+
+To publish this package to npm:
+
+1. Create an npm account and log in via terminal:
+   ```bash
+   npm login
+   ```
+2. Make sure you are a member of the `@imksh` organization or it's your username.
+3. Run the publish command:
+   ```bash
+   npm publish --access public
+   ```
+4. To update future versions, update the version in `package.json` (or use `npm version patch/minor/major`) and run `npm publish --access public` again.

package/bin/index.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../src/index.js';

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@imksh/create",
+  "version": "1.0.0",
+  "description": "A production-ready create for scaffolding modern applications.",
+  "type": "module",
+  "bin": {
+    "imksh": "./bin/index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "files": [
+    "bin",
+    "src",
+    "templates"
+  ],
+  "keywords": [
+    "create",
+    "create-app",
+    "scaffold",
+    "react",
+    "next",
+    "node",
+    "prisma",
+    "mern",
+    "imksh"
+  ],
+  "author": "imksh",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/imksh/create.git"
+  },
+  "homepage": "https://github.com/imksh/create#readme",
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^12.0.0",
+    "execa": "^8.0.1",
+    "fs-extra": "^11.2.0",
+    "inquirer": "^9.2.16",
+    "ora": "^8.0.1"
+  }
+}

package/src/commands/create.js

@@ -0,0 +1,90 @@
+import fs from 'fs-extra';
+import path from 'path';
+import { info, success, error } from '../utils/logger.js';
+import { askTemplate } from '../utils/askTemplate.js';
+import { copyTemplate } from '../utils/copyTemplate.js';
+import { installPackages } from '../utils/installPackages.js';
+import { runGit } from '../utils/runGit.js';
+import ora from 'ora';
+
+export default async function createCommand(projectName, options) {
+  const targetDir = path.resolve(process.cwd(), projectName);
+
+  if (fs.existsSync(targetDir)) {
+    throw new Error(`Folder ${projectName} already exists. Please choose a different name or delete the folder.`);
+  }
+
+  let template = options.template;
+
+  if (!template) {
+    if (options.yes) {
+      template = 'react';
+    } else {
+      template = await askTemplate();
+    }
+  }
+
+  const validTemplates = [
+    'react',
+    'react-ts',
+    'node',
+    'node-ts',
+    'node-prisma',
+    'node-prisma-ts',
+    'mern',
+    'mern-ts',
+    'next',
+    'next-ts'
+  ];
+  if (!validTemplates.includes(template)) {
+    throw new Error(`Invalid template "${template}". Valid templates are: ${validTemplates.join(', ')}`);
+  }
+
+  info(`\nCreating project in ${targetDir}...`);
+  const copySpinner = ora('Copying template...').start();
+  try {
+    await copyTemplate(template, targetDir, projectName);
+    copySpinner.succeed('Template copied successfully.');
+  } catch (err) {
+    copySpinner.fail('Failed to copy template.');
+    throw err;
+  }
+
+  if (!options.skipInstall) {
+    const installSpinner = ora('Installing dependencies...').start();
+    try {
+      await installPackages(targetDir);
+      installSpinner.succeed('Dependencies installed successfully.');
+    } catch (err) {
+      installSpinner.fail('Failed to install dependencies.');
+      error(err.message);
+    }
+  } else {
+    info('Skipping dependency installation.');
+  }
+
+  if (options.git !== false) {
+    const gitSpinner = ora('Initializing git...').start();
+    try {
+      await runGit(targetDir);
+      gitSpinner.succeed('Git initialized successfully.');
+    } catch (err) {
+      gitSpinner.warn('Failed to initialize git (is git installed?)');
+    }
+  } else {
+    info('Skipping git initialization.');
+  }
+
+  success(`\nProject ${projectName} created successfully!`);
+  info(`\nTo get started:\n`);
+  info(`  cd ${projectName}`);
+  if (options.skipInstall) {
+    info(`  npm install`);
+  }
+  
+  if (template === 'mern') {
+    info(`  npm run dev (or follow README in the generated project)\n`);
+  } else {
+    info(`  npm run dev\n`);
+  }
+}

package/src/index.js

@@ -0,0 +1,41 @@
+import { Command } from "commander";
+import fs from "fs-extra";
+import path from "path";
+import { fileURLToPath } from "url";
+import createCommand from "./commands/create.js";
+import { error } from "./utils/logger.js";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const packageJsonPath = path.join(__dirname, "../package.json");
+const packageJson = fs.readJsonSync(packageJsonPath);
+
+const program = new Command();
+
+program
+  .name("imksh")
+  .description("A production-ready CLI for scaffolding modern applications.")
+  .version(packageJson.version);
+
+program
+  .command("create")
+  .description("Create a new project")
+  .argument("<project-name>", "Name of the project")
+  .option(
+    "-t, --template <template>",
+    "Template to use (react, react-ts, node, node-ts, node-prisma, node-prisma-ts, mern, mern-ts, next, next-ts)",
+  )
+  .option("--skip-install", "Skip installing dependencies")
+  .option("--no-git", "Skip initializing a git repository")
+  .option("-y, --yes", "Use default options")
+  .action(async (projectName, options) => {
+    try {
+      await createCommand(projectName, options);
+    } catch (err) {
+      error(`Error: ${err.message}`);
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);

package/src/utils/askTemplate.js

@@ -0,0 +1,25 @@
+import inquirer from 'inquirer';
+
+export async function askTemplate() {
+  const { template } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'template',
+      message: 'Which template would you like to use?',
+      choices: [
+        { name: 'React (JS)', value: 'react' },
+        { name: 'React (TS)', value: 'react-ts' },
+        { name: 'Node (JS)', value: 'node' },
+        { name: 'Node (TS)', value: 'node-ts' },
+        { name: 'Node + Prisma (JS)', value: 'node-prisma' },
+        { name: 'Node + Prisma (TS)', value: 'node-prisma-ts' },
+        { name: 'MERN (JS)', value: 'mern' },
+        { name: 'MERN (TS)', value: 'mern-ts' },
+        { name: 'Next.js (JS)', value: 'next' },
+        { name: 'Next.js (TS)', value: 'next-ts' },
+      ],
+    },
+  ]);
+  
+  return template;
+}

package/src/utils/copyTemplate.js

@@ -0,0 +1,36 @@
+import fs from 'fs-extra';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export async function copyTemplate(templateName, targetDir, projectName) {
+  const templateDir = path.resolve(__dirname, '../../templates', templateName);
+
+  if (!fs.existsSync(templateDir)) {
+    throw new Error(`Template directory not found: ${templateDir}`);
+  }
+
+  // Copy template files
+  await fs.copy(templateDir, targetDir, {
+    filter: (src) => {
+      // Exclude node_modules if they accidentally exist in template
+      return !src.includes('node_modules');
+    }
+  });
+
+  // Rename package.json project name
+  const packageJsonPath = path.join(targetDir, 'package.json');
+  if (fs.existsSync(packageJsonPath)) {
+    const pkg = await fs.readJson(packageJsonPath);
+    pkg.name = projectName;
+    await fs.writeJson(packageJsonPath, pkg, { spaces: 2 });
+  }
+
+  // Rename _gitignore to .gitignore
+  const gitignorePath = path.join(targetDir, '_gitignore');
+  if (fs.existsSync(gitignorePath)) {
+    await fs.rename(gitignorePath, path.join(targetDir, '.gitignore'));
+  }
+}

package/src/utils/installPackages.js

@@ -0,0 +1,25 @@
+import { execa } from 'execa';
+
+export async function installPackages(targetDir) {
+  // Detect package manager based on process.env.npm_config_user_agent
+  let pm = 'npm';
+  const userAgent = process.env.npm_config_user_agent;
+
+  if (userAgent) {
+    if (userAgent.startsWith('yarn')) {
+      pm = 'yarn';
+    } else if (userAgent.startsWith('pnpm')) {
+      pm = 'pnpm';
+    }
+  }
+
+  // Handle mern template differently (it might need install in root, or client/server separately)
+  // Our mern template will be designed such that 'npm install' at root installs everything
+  // using workspaces or postinstall scripts.
+  
+  await execa(`${pm} install`, {
+    cwd: targetDir,
+    stdio: 'ignore',
+    shell: true
+  });
+}

package/src/utils/logger.js

@@ -0,0 +1,17 @@
+import chalk from 'chalk';
+
+export function info(message) {
+  console.log(chalk.blue(message));
+}
+
+export function success(message) {
+  console.log(chalk.green(message));
+}
+
+export function warning(message) {
+  console.log(chalk.yellow(message));
+}
+
+export function error(message) {
+  console.error(chalk.red(message));
+}

package/src/utils/runGit.js

@@ -0,0 +1,11 @@
+import { execa } from 'execa';
+
+export async function runGit(targetDir) {
+  try {
+    await execa('git init', { cwd: targetDir, stdio: 'ignore', shell: true });
+    await execa('git add .', { cwd: targetDir, stdio: 'ignore', shell: true });
+    await execa('git commit -m "Initial commit from @imksh/cli"', { cwd: targetDir, stdio: 'ignore', shell: true });
+  } catch (err) {
+    throw new Error('Git initialization failed');
+  }
+}

package/templates/mern/_gitignore

@@ -0,0 +1,2 @@
+node_modules
+.DS_Store

package/templates/mern/client/_gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

package/templates/mern/client/index.html

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" href="/favicon.svg" type="image/svg+xml" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <link rel="manifest" href="/manifest.json" />
+    <title>React App</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>

package/templates/mern/client/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "react-template",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "lint": "eslint . --ext js,jsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@tailwindcss/vite": "^4.3.2",
+    "axios": "^1.6.0",
+    "flyonui": "^2.4.1",
+    "framer-motion": "^11.0.0",
+    "lenis": "^1.1.3",
+    "lottie-react": "^2.4.0",
+    "lucide-react": "^0.292.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-hot-toast": "^2.4.1",
+    "react-icons": "^4.11.0",
+    "react-router-dom": "^6.18.0",
+    "tailwindcss": "^4.3.2",
+    "zustand": "^4.5.2"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.37",
+    "@types/react-dom": "^18.2.15",
+    "@vitejs/plugin-react": "^4.2.0",
+    "autoprefixer": "^10.4.19",
+    "eslint": "^8.53.0",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.4",
+    "vite": "^5.0.0"
+  }
+}

package/templates/mern/client/public/_redirects

@@ -0,0 +1 @@
+/*    /index.html   200