scaffy-tool 0.1.1

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "scaffy-tool",
+  "type": "commonjs",
+  "version": "0.1.1",
+  "description": "One command. Any framework. Ready to code.",
+  "author": "Md Tanvir Hossen <tanvirhossen112@gmail.com>",
+  "license": "MIT",
+  "main": "cli.js",
+  "bin": {
+    "scaffy": "cli.js"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "scaffolding",
+    "cli",
+    "laravel",
+    "nestjs",
+    "vuejs",
+    "django",
+    "framework",
+    "generator",
+    "boilerplate",
+    "project-setup"
+  ],
+  "files": [
+    "cli.js",
+    "core/",
+    "registry/",
+    "!core/tests/",
+    "!registry/**/tests/"
+  ],
+  "homepage": "https://github.com/TanvirHossen112/scaffy",
+  "bugs": {
+    "url": "https://github.com/TanvirHossen112/scaffy/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TanvirHossen112/scaffy.git"
+  },
+  "scripts": {
+    "start": "node cli.js",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "test:ci": "jest --coverage --ci --runInBand",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "prepare": "husky install"
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "commander": "^11.1.0",
+    "figlet": "^1.10.0",
+    "inquirer": "^8.2.6",
+    "ora": "^5.4.1",
+    "semver": "^7.7.4"
+  },
+  "devDependencies": {
+    "@jest/globals": "^30.2.0",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-node": "^11.1.0",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.5.2",
+    "prettier": "^3.8.1"
+  },
+  "lint-staged": {
+    "!(jest.config).js": [
+      "eslint --fix",
+      "prettier --write",
+      "jest --bail --findRelatedTests"
+    ],
+    "*.json": [
+      "prettier --write"
+    ]
+  }
+}

package/registry/index.json

@@ -0,0 +1,85 @@
+{
+    "version": "1.0.0",
+    "frameworks": [
+      {
+        "name": "Laravel",
+        "alias": ["laravel"],
+        "language": "php",
+        "latest": "v11",
+        "versions": ["v11", "v10"],
+        "path": "php/laravel"
+      },
+      {
+        "name": "Symfony",
+        "alias": ["symfony"],
+        "language": "php",
+        "latest": "v7",
+        "versions": ["v7"],
+        "path": "php/symfony"
+      },
+      {
+        "name": "NestJS",
+        "alias": ["nestjs", "nest"],
+        "language": "javascript",
+        "latest": "v10",
+        "versions": ["v10"],
+        "path": "javascript/nestjs"
+      },
+      {
+        "name": "VueJS",
+        "alias": ["vue", "vuejs"],
+        "language": "javascript",
+        "latest": "v3",
+        "versions": ["v3"],
+        "path": "javascript/vuejs"
+      },
+      {
+        "name": "NextJS",
+        "alias": ["next", "nextjs"],
+        "language": "javascript",
+        "latest": "v14",
+        "versions": ["v14"],
+        "path": "javascript/nextjs"
+      },
+      {
+        "name": "ExpressJS",
+        "alias": ["express", "expressjs"],
+        "language": "javascript",
+        "latest": "v4",
+        "versions": ["v4"],
+        "path": "javascript/expressjs"
+      },
+      {
+        "name": "Django",
+        "alias": ["django"],
+        "language": "python",
+        "latest": "v5",
+        "versions": ["v5"],
+        "path": "python/django"
+      },
+      {
+        "name": "FastAPI",
+        "alias": ["fastapi"],
+        "language": "python",
+        "latest": "v0",
+        "versions": ["v0"],
+        "path": "python/fastapi"
+      },
+      {
+        "name": "Flask",
+        "alias": ["flask"],
+        "language": "python",
+        "latest": "v3",
+        "versions": ["v3"],
+        "path": "python/flask"
+      },
+      {
+        "name": "Gin",
+        "alias": ["gin"],
+        "language": "go",
+        "latest": "v1",
+        "versions": ["v1"],
+        "path": "go/gin"
+      }
+    ]
+  }

package/registry/javascript/nestjs/plugin.json

@@ -0,0 +1,44 @@
+{
+    "name": "NestJS",
+    "alias": ["nestjs", "nest"],
+    "language": "javascript",
+    "latest": "v10",
+    "versions": ["v10"],
+    "description": "A progressive Node.js framework for building efficient and scalable server-side applications",
+    "requires": [
+      {
+        "tool": "node",
+        "checkCommand": "node --version",
+        "parseVersion": "v([0-9.]+)",
+        "minVersion": "16.0.0",
+        "installGuide": {
+          "mac": "brew install node",
+          "linux": "sudo apt install nodejs npm",
+          "windows": "https://nodejs.org/en/download",
+          "docs": "https://nodejs.org"
+        }
+      }
+    ],
+    "packageManagerQuestion": {
+      "tool": "packageManager",
+      "message": "Package manager:",
+      "choices": [
+        {
+          "name": "npm",
+          "value": "npm",
+          "checkCommand": "npm --version"
+        },
+        {
+          "name": "yarn",
+          "value": "yarn",
+          "checkCommand": "yarn --version"
+        },
+        {
+          "name": "pnpm",
+          "value": "pnpm",
+          "checkCommand": "pnpm --version"
+        }
+      ]
+    },
+    "maintainer": "community"
+  }

package/registry/javascript/nestjs/v10/questions.js

@@ -0,0 +1,59 @@
+const { detectAvailableChoices } = require('../../../../core/detector');
+const pluginMeta = require('../plugin.json');
+
+module.exports = async () => {
+  const availableManagers = await detectAvailableChoices(
+    pluginMeta.packageManagerQuestion.choices
+  );
+
+  return [
+    {
+      type: 'input',
+      name: 'projectName',
+      message: 'Project name:',
+      default: 'my-nest-app',
+      validate: input => {
+        if (!input.trim()) return 'Project name is required';
+        if (!/^[a-z0-9-_]+$/.test(input)) {
+          return 'Only lowercase letters, numbers, hyphens and underscores';
+        }
+        return true;
+      },
+    },
+    {
+      type: 'list',
+      name: 'packageManager',
+      message: pluginMeta.packageManagerQuestion.message,
+      choices: availableManagers.map(m => ({
+        name: m.name,
+        value: m.value,
+      })),
+      default: availableManagers[0].value,
+    },
+    {
+      type: 'list',
+      name: 'database',
+      message: 'Database:',
+      choices: [
+        { name: 'None', value: 'none' },
+        { name: 'PostgreSQL (TypeORM)', value: 'postgres' },
+        { name: 'MySQL (TypeORM)', value: 'mysql' },
+        { name: 'MongoDB (Mongoose)', value: 'mongodb' },
+        { name: 'SQLite (TypeORM)', value: 'sqlite' },
+      ],
+      default: 'none',
+    },
+    {
+      type: 'confirm',
+      name: 'auth',
+      message: 'Add JWT authentication (Passport)?',
+      default: false,
+    },
+    {
+      type: 'confirm',
+      name: 'docker',
+      message: 'Add Dockerfile?',
+      default: false,
+    },
+  ];
+};

package/registry/javascript/nestjs/v10/scaffold.js

@@ -0,0 +1,94 @@
+module.exports = async (answers, utils) => {
+  const { projectName, packageManager, database, auth, docker } = answers;
+
+  // ─── Step 1 — Install NestJS CLI + Create Project ──
+  utils.title('Creating NestJS v10 Project');
+  utils.step(1, `Scaffolding ${projectName}...`);
+
+  await utils.run(
+    `npx @nestjs/cli@10 new ${projectName} --package-manager ${packageManager} --skip-git`
+  );
+
+  // ─── Step 2 — Database ────────────────────────────
+  if (database !== 'none') {
+    utils.step(2, `Installing ${database} database packages...`);
+
+    if (database === 'mongodb') {
+      await utils.runInProject(
+        projectName,
+        `${packageManager} ${packageManager === 'yarn' ? 'add' : 'install'} @nestjs/mongoose mongoose`
+      );
+    } else {
+      // TypeORM based (postgres, mysql, sqlite)
+      const dbDriver = {
+        postgres: 'pg',
+        mysql: 'mysql2',
+        sqlite: 'sqlite3',
+      };
+
+      await utils.runInProject(
+        projectName,
+        `${packageManager} ${packageManager === 'yarn' ? 'add' : 'install'} @nestjs/typeorm typeorm ${dbDriver[database]}`
+      );
+    }
+  }
+
+  // ─── Step 3 — Auth ────────────────────────────────
+  if (auth) {
+    utils.step(3, 'Installing Passport JWT authentication...');
+    await utils.runInProject(
+      projectName,
+      `${packageManager} ${packageManager === 'yarn' ? 'add' : 'install'} @nestjs/passport passport passport-jwt @nestjs/jwt`
+    );
+    await utils.runInProject(
+      projectName,
+      `${packageManager} ${packageManager === 'yarn' ? 'add' : 'install'} -D @types/passport-jwt`
+    );
+  }
+
+  // ─── Step 4 — Docker ──────────────────────────────
+  if (docker) {
+    utils.step(4, 'Adding Dockerfile...');
+
+    await utils.createFile(
+      `${projectName}/Dockerfile`,
+      `FROM node:20-alpine AS builder
+  WORKDIR /app
+  COPY package*.json ./
+  RUN npm ci
+  COPY . .
+  RUN npm run build
+  
+  FROM node:20-alpine AS production
+  WORKDIR /app
+  COPY package*.json ./
+  RUN npm ci --only=production
+  COPY --from=builder /app/dist ./dist
+  EXPOSE 3000
+  CMD ["node", "dist/main"]
+  `
+    );
+
+    await utils.createFile(
+      `${projectName}/.dockerignore`,
+      `node_modules
+  dist
+  .git
+  .env
+  `
+    );
+  }
+
+  // ─── Done ─────────────────────────────────────────
+  utils.success(`✅ NestJS v10 project ready!`);
+  utils.log(`  cd ${projectName}`);
+
+  if (docker) {
+    utils.log(`  docker build -t ${projectName} .`);
+    utils.log(`  docker run -p 3000:3000 ${projectName}`);
+  } else {
+    utils.log(`  ${packageManager} run start:dev`);
+  }
+
+  utils.log('');
+};

package/registry/javascript/vuejs/plugin.json

@@ -0,0 +1,44 @@
+{
+  "name": "VueJS",
+  "alias": ["vue", "vuejs"],
+  "language": "javascript",
+  "latest": "v3",
+  "versions": ["v3"],
+  "description": "The progressive JavaScript framework for building user interfaces",
+  "requires": [
+    {
+      "tool": "node",
+      "checkCommand": "node --version",
+      "parseVersion": "v([0-9.]+)",
+      "minVersion": "18.0.0",
+      "installGuide": {
+        "mac": "brew install node",
+        "linux": "sudo apt install nodejs npm",
+        "windows": "https://nodejs.org/en/download",
+        "docs": "https://nodejs.org"
+      }
+    }
+  ],
+  "packageManagerQuestion": {
+    "tool": "packageManager",
+    "message": "Package manager:",
+    "choices": [
+      {
+        "name": "npm",
+        "value": "npm",
+        "checkCommand": "npm --version"
+      },
+      {
+        "name": "yarn",
+        "value": "yarn",
+        "checkCommand": "yarn --version"
+      },
+      {
+        "name": "pnpm",
+        "value": "pnpm",
+        "checkCommand": "pnpm --version"
+      }
+    ]
+  },
+  "maintainer": "community"
+}

package/registry/javascript/vuejs/v3/questions.js

@@ -0,0 +1,64 @@
+const { detectAvailableChoices } = require('../../../../core/detector');
+const pluginMeta = require('../plugin.json');
+
+module.exports = async () => {
+  const availableManagers = await detectAvailableChoices(
+    pluginMeta.packageManagerQuestion.choices
+  );
+
+  return [
+    {
+      type: 'input',
+      name: 'projectName',
+      message: 'Project name:',
+      default: 'my-vue-app',
+      validate: input => {
+        if (!input.trim()) return 'Project name is required';
+        if (!/^[a-z0-9-_]+$/.test(input)) {
+          return 'Only lowercase letters, numbers, hyphens and underscores';
+        }
+        return true;
+      },
+    },
+    {
+      type: 'list',
+      name: 'packageManager',
+      message: pluginMeta.packageManagerQuestion.message,
+      choices: availableManagers.map(m => ({
+        name: m.name,
+        value: m.value,
+      })),
+      default: availableManagers[0].value,
+    },
+    {
+      type: 'confirm',
+      name: 'router',
+      message: 'Add Vue Router?',
+      default: true,
+    },
+    {
+      type: 'confirm',
+      name: 'pinia',
+      message: 'Add Pinia (state management)?',
+      default: true,
+    },
+    {
+      type: 'confirm',
+      name: 'vitest',
+      message: 'Add Vitest (unit testing)?',
+      default: false,
+    },
+    {
+      type: 'confirm',
+      name: 'typescript',
+      message: 'Add TypeScript?',
+      default: false,
+    },
+    {
+      type: 'confirm',
+      name: 'eslint',
+      message: 'Add ESLint?',
+      default: true,
+    },
+  ];
+};

package/registry/javascript/vuejs/v3/scaffold.js

@@ -0,0 +1,53 @@
+module.exports = async (answers, utils) => {
+  const {
+    projectName,
+    packageManager,
+    router,
+    pinia,
+    vitest,
+    typescript,
+    eslint,
+  } = answers;
+
+  // ─── Step 1 — Build create-vue flags ──────────────
+  utils.title('Creating VueJS v3 Project');
+  utils.step(1, `Scaffolding ${projectName}...`);
+
+  const flags = [
+    router ? '--router' : '--no-router',
+    pinia ? '--pinia' : '--no-pinia',
+    typescript ? '--typescript' : '--no-typescript',
+    eslint ? '--eslint' : '--no-eslint',
+  ].join(' ');
+
+  await utils.run(`npx create-vue@3 ${projectName} ${flags}`);
+
+  // ─── Step 2 — Install Dependencies ────────────────
+  utils.step(2, 'Installing dependencies...');
+
+  const installCmd =
+    packageManager === 'yarn'
+      ? 'yarn'
+      : packageManager === 'pnpm'
+        ? 'pnpm install'
+        : 'npm install';
+
+  await utils.runInProject(projectName, installCmd);
+
+  // ─── Step 3 — TypeScript extras ───────────────────
+  if (typescript) {
+    utils.step(3, 'Configuring TypeScript...');
+    await utils.runInProject(
+      projectName,
+      `${packageManager === 'yarn' ? 'yarn add' : packageManager + ' install'} -D vue-tsc`
+    );
+  }
+
+  // ─── Done ─────────────────────────────────────────
+  utils.success(`✅ VueJS v3 project ready!`);
+  utils.log(`  cd ${projectName}`);
+  utils.log(
+    `  ${packageManager === 'yarn' ? 'yarn' : packageManager + ' run'} dev`
+  );
+  utils.log('');
+};

package/registry/php/laravel/plugin.json

@@ -0,0 +1,34 @@
+{
+  "name": "Laravel",
+  "alias": ["laravel"],
+  "language": "php",
+  "latest": "v11",
+  "versions": ["v11", "v10"],
+  "description": "The PHP Framework for Web Artisans",
+  "requires": [
+    {
+      "tool": "php",
+      "checkCommand": "php --version",
+      "parseVersion": "PHP ([0-9.]+)",
+      "minVersion": "8.2.0",
+      "installGuide": {
+        "mac": "brew install php",
+        "linux": "sudo apt install php8.2",
+        "windows": "https://windows.php.net/download",
+        "docs": "https://www.php.net"
+      }
+    },
+    {
+      "tool": "composer",
+      "checkCommand": "composer --version",
+      "parseVersion": "Composer version ([0-9.]+)",
+      "installGuide": {
+        "mac": "brew install composer",
+        "linux": "sudo apt install composer",
+        "windows": "https://getcomposer.org/Composer-Setup.exe",
+        "docs": "https://getcomposer.org"
+      }
+    }
+  ],
+  "maintainer": "community"
+}

package/registry/php/laravel/v11/questions.js

@@ -0,0 +1,44 @@
+module.exports = [
+  {
+    type: 'input',
+    name: 'projectName',
+    message: 'Project name:',
+    default: 'my-laravel-app',
+    validate: input => {
+      if (!input.trim()) return 'Project name is required';
+      if (!/^[a-z0-9-_]+$/.test(input)) {
+        return 'Only lowercase letters, numbers, hyphens and underscores';
+      }
+      return true;
+    },
+  },
+  {
+    type: 'list',
+    name: 'starterKit',
+    message: 'Starter kit:',
+    choices: [
+      { name: 'None', value: 'none' },
+      { name: 'Breeze (lightweight auth)', value: 'breeze' },
+      { name: 'Jetstream (full featured auth)', value: 'jetstream' },
+    ],
+    default: 'none',
+  },
+  {
+    type: 'list',
+    name: 'database',
+    message: 'Database:',
+    choices: [
+      { name: 'SQLite (default)', value: 'sqlite' },
+      { name: 'MySQL', value: 'mysql' },
+      { name: 'PostgreSQL', value: 'pgsql' },
+      { name: 'SQL Server', value: 'sqlsrv' },
+    ],
+    default: 'sqlite',
+  },
+  {
+    type: 'confirm',
+    name: 'docker',
+    message: 'Add Laravel Sail (Docker)?',
+    default: false,
+  },
+];

package/registry/php/laravel/v11/scaffold.js

@@ -0,0 +1,74 @@
+module.exports = async (answers, utils) => {
+  const { projectName, starterKit, database, docker } = answers;
+
+  // ─── Step 1 — Create Laravel Project ──────────────
+  utils.title('Creating Laravel v11 Project');
+  utils.step(1, `Scaffolding ${projectName}...`);
+
+  await utils.run(
+    `composer create-project laravel/laravel:^11.0 ${projectName}`
+  );
+
+  // ─── Step 2 — Configure Database ──────────────────
+  utils.step(2, `Configuring ${database} database...`);
+
+  await utils.setEnv(projectName, {
+    DB_CONNECTION: database,
+    APP_NAME: projectName,
+  });
+
+  // ─── Step 3 — Generate App Key ─────────────────────
+  utils.step(3, 'Generating application key...');
+  await utils.runInProject(projectName, 'php artisan key:generate');
+
+  // ─── Step 4 — Starter Kit ─────────────────────────
+  if (starterKit === 'breeze') {
+    utils.step(4, 'Installing Laravel Breeze...');
+    await utils.runInProject(
+      projectName,
+      'composer require laravel/breeze --dev'
+    );
+    await utils.runInProject(
+      projectName,
+      'php artisan breeze:install blade --quiet'
+    );
+    await utils.runInProject(projectName, 'npm install');
+    await utils.runInProject(projectName, 'npm run build');
+  }
+
+  if (starterKit === 'jetstream') {
+    utils.step(4, 'Installing Laravel Jetstream...');
+    await utils.runInProject(projectName, 'composer require laravel/jetstream');
+    await utils.runInProject(
+      projectName,
+      'php artisan jetstream:install livewire'
+    );
+    await utils.runInProject(projectName, 'npm install');
+    await utils.runInProject(projectName, 'npm run build');
+  }
+
+  // ─── Step 5 — Docker / Sail ───────────────────────
+  if (docker) {
+    utils.step(5, 'Installing Laravel Sail...');
+    await utils.runInProject(
+      projectName,
+      'composer require laravel/sail --dev'
+    );
+    await utils.runInProject(
+      projectName,
+      'php artisan sail:install --with=mysql,redis'
+    );
+  }
+
+  // ─── Done ─────────────────────────────────────────
+  utils.success(`✅ Laravel v11 project ready!`);
+  utils.log(`  cd ${projectName}`);
+
+  if (docker) {
+    utils.log(`  ./vendor/bin/sail up`);
+  } else {
+    utils.log(`  php artisan serve`);
+  }
+
+  utils.log('');
+};