scaffy-tool 0.2.0 → 1.0.1

package/core/registry.js

@@ -1,6 +1,12 @@
-const path = require('path');
-const fs = require('fs');
-const chalk = require('chalk');
+import path from 'path';
+import fs from 'fs';
+import chalk from 'chalk';
+import { createRequire } from 'module';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const require = createRequire(import.meta.url);
 
 const REGISTRY_PATH = path.join(__dirname, '..', 'registry');
 const INDEX_PATH = path.join(REGISTRY_PATH, 'index.json');
@@ -23,11 +29,21 @@ const getFrameworks = () => {
   return index.frameworks;
 };
 
+const isPluginComplete = framework => {
+  const pluginPath = path.join(REGISTRY_PATH, framework.path);
+  const versionPath = path.join(pluginPath, framework.latest);
+  return (
+    fs.existsSync(path.join(versionPath, 'questions.js')) &&
+    fs.existsSync(path.join(versionPath, 'scaffold.js'))
+  );
+};
+
+const getAvailableFrameworks = () => getFrameworks().filter(isPluginComplete);
+
 const findFramework = query => {
   const q = query.toLowerCase().trim();
-
   return (
-    getFrameworks().find(
+    getAvailableFrameworks().find(
       f =>
         f.name.toLowerCase() === q || f.alias.some(a => a.toLowerCase() === q)
     ) || null
@@ -36,8 +52,7 @@ const findFramework = query => {
 
 const searchFrameworks = query => {
   const q = query.toLowerCase().trim();
-
-  return getFrameworks().filter(
+  return getAvailableFrameworks().filter(
     f =>
       f.name.toLowerCase().includes(q) ||
       f.language.toLowerCase().includes(q) ||
@@ -56,58 +71,60 @@ const groupByLanguage = frameworks =>
 
 const validatePluginFiles = (pluginPath, version) => {
   const versionPath = path.join(pluginPath, version);
-
   const requiredFiles = [
     { path: path.join(pluginPath, 'plugin.json'), name: 'plugin.json' },
     { path: path.join(versionPath, 'questions.js'), name: 'questions.js' },
     { path: path.join(versionPath, 'scaffold.js'), name: 'scaffold.js' },
   ];
-
   const missing = requiredFiles
     .filter(f => !fs.existsSync(f.path))
     .map(f => f.name);
-
   return {
     valid: missing.length === 0,
     missing,
   };
 };
 
-const loadPlugin = (framework, version) => {
+const loadPlugin = async (framework, version) => {
   const pluginPath = path.join(REGISTRY_PATH, framework.path);
   const versionPath = path.join(pluginPath, version);
-
   const { valid, missing } = validatePluginFiles(pluginPath, version);
-
   if (!valid) {
     throw new Error(
       `Missing files for ${framework.name} ${version}: ` + missing.join(', ')
     );
   }
-
-  return {
-    meta: require(path.join(pluginPath, 'plugin.json')),
-    questions: require(path.join(versionPath, 'questions.js')),
-    scaffold: require(path.join(versionPath, 'scaffold.js')),
-  };
+  const meta = JSON.parse(
+    fs.readFileSync(path.join(pluginPath, 'plugin.json'), 'utf8')
+  );
+  const { default: questions } = await import(
+    path.join(versionPath, 'questions.js')
+  );
+  const { default: scaffold } = await import(
+    path.join(versionPath, 'scaffold.js')
+  );
+  return { meta, questions, scaffold };
 };
 
-const formatFrameworkLine = f =>
-  chalk.white(`    • ${f.name}`) +
-  chalk.gray(` (${f.alias.join(', ')}) — latest: ${f.latest}`);
+const formatFrameworkLine = f => {
+  const versionsStr = f.versions
+    .map(v => (v === f.latest ? chalk.green(`${v} (latest)`) : chalk.gray(v)))
+    .join(chalk.gray(', '));
+  return (
+    chalk.white(`    • ${f.name}`) +
+    chalk.gray(` (${f.alias.join(', ')}) — `) +
+    versionsStr
+  );
+};
 
 const displayFrameworks = () => {
-  const frameworks = getFrameworks();
-
+  const frameworks = getAvailableFrameworks();
   if (frameworks.length === 0) {
     console.log(chalk.red('\n❌ No frameworks found\n'));
     return;
   }
-
   const grouped = groupByLanguage(frameworks);
-
   console.log(chalk.bold('\n📦 Available Frameworks:\n'));
-
   Object.entries(grouped).forEach(([lang, list]) => {
     console.log(chalk.cyan(`  ${lang.toUpperCase()}`));
     list.forEach(f => console.log(formatFrameworkLine(f)));
@@ -115,9 +132,11 @@ const displayFrameworks = () => {
   });
 };
 
-module.exports = {
+export {
   loadIndex,
   getFrameworks,
+  getAvailableFrameworks,
+  isPluginComplete,
   findFramework,
   searchFrameworks,
   groupByLanguage,

package/core/utils.js

@@ -1,40 +1,33 @@
-const chalk = require('chalk');
+import chalk from 'chalk';
 
 const log = message => {
   console.log(chalk.white(`  ${message}`));
 };
 
-// ─── Success Message ───────────────────────────────────
 const success = message => {
   console.log(chalk.green(`\n  ${message}\n`));
 };
 
-// ─── Warning Message ───────────────────────────────────
 const warn = message => {
   console.log(chalk.yellow(`  ⚠️  ${message}`));
 };
 
-// ─── Error Message ─────────────────────────────────────
 const error = message => {
   console.log(chalk.red(`  ❌ ${message}`));
 };
 
-// ─── Section Title ─────────────────────────────────────
 const title = message => {
   console.log(chalk.cyan.bold(`\n  ── ${message} ──\n`));
 };
 
-// ─── Divider Line ──────────────────────────────────────
 const divider = () => {
   console.log(chalk.gray('  ──────────────────────────────────────────'));
 };
 
-// ─── Step Indicator ────────────────────────────────────
 const step = (number, message) => {
   console.log(chalk.cyan(`  [${number}]`) + chalk.white(` ${message}`));
 };
 
-// ─── Build Utils Object For Plugins ───────────────────
 const buildPluginUtils = executor => ({
   run: executor.run,
   runInProject: executor.runInProject,
@@ -50,14 +43,4 @@ const buildPluginUtils = executor => ({
   divider,
 });
 
-// ─── Exports ───────────────────────────────────────────
-module.exports = {
-  log,
-  success,
-  warn,
-  error,
-  title,
-  divider,
-  step,
-  buildPluginUtils,
-};
+export { log, success, warn, error, title, divider, step, buildPluginUtils };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "scaffy-tool",
-  "type": "commonjs",
-  "version": "0.2.0",
+  "type": "module",
+  "version": "1.0.1",
   "description": "One command. Any framework. Ready to code.",
   "author": "Md Tanvir Hossen <tanvirhossen112@gmail.com>",
   "license": "MIT",
@@ -10,7 +10,7 @@
     "scaffy": "cli.js"
   },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "keywords": [
     "scaffolding",
@@ -41,10 +41,10 @@
   },
   "scripts": {
     "start": "node cli.js",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
-    "test:ci": "jest --coverage --ci --runInBand",
+    "test": "node --experimental-vm-modules node_modules/.bin/jest",
+    "test:coverage": "node --experimental-vm-modules node_modules/.bin/jest --coverage",
+    "test:watch": "node --experimental-vm-modules node_modules/.bin/jest --watch",
+    "test:ci": "node --experimental-vm-modules node_modules/.bin/jest --coverage --ci --runInBand",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "format": "prettier --write .",
@@ -52,11 +52,11 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "chalk": "^4.1.2",
+    "chalk": "^5.6.2",
     "commander": "^11.1.0",
     "figlet": "^1.10.0",
-    "inquirer": "^8.2.6",
-    "ora": "^5.4.1",
+    "inquirer": "^13.3.2",
+    "ora": "^9.3.0",
     "semver": "^7.7.4"
   },
   "devDependencies": {
@@ -73,7 +73,7 @@
     "!(jest.config).js": [
       "eslint --fix",
       "prettier --write",
-      "jest --bail --findRelatedTests"
+      "node --experimental-vm-modules node_modules/.bin/jest --bail --findRelatedTests"
     ],
     "*.json": [
       "prettier --write"

package/registry/go/gin/plugin.json

@@ -0,0 +1,23 @@
+{
+  "name": "Gin",
+  "alias": ["gin"],
+  "language": "go",
+  "latest": "v1",
+  "versions": ["v1"],
+  "description": "Fast and lightweight Go web framework",
+  "requires": [
+    {
+      "tool": "go",
+      "checkCommand": "go version",
+      "parseVersion": "go version go([0-9]+\\.[0-9]+\\.[0-9]+)",
+      "minVersion": "1.21.0",
+      "installGuide": {
+        "mac": "brew install go",
+        "linux": "sudo apt install golang-go",
+        "windows": "https://go.dev/dl",
+        "docs": "https://go.dev"
+      }
+    }
+  ],
+  "maintainer": "community"
+}

package/registry/go/gin/v1/questions.js

@@ -0,0 +1,19 @@
+export default [
+  {
+    type: 'select',
+    name: 'database',
+    message: 'Database?',
+    choices: [
+      { name: 'None', value: 'none' },
+      { name: 'PostgreSQL — GORM + postgres driver', value: 'postgresql' },
+      { name: 'MySQL     — GORM + mysql driver', value: 'mysql' },
+      { name: 'SQLite    — GORM + sqlite driver', value: 'sqlite' },
+    ],
+  },
+  {
+    type: 'confirm',
+    name: 'docker',
+    message: 'Include Docker config?',
+    default: false,
+  },
+];

package/registry/go/gin/v1/scaffold.js

@@ -0,0 +1,196 @@
+export default async (answers, utils) => {
+  const { projectName, database, docker } = answers;
+
+  utils.title('Creating Gin v1 Project');
+
+  // ─── Step 1: Create project folder ────────────────────
+  utils.step(1, 'Creating project structure');
+  await utils.run(`mkdir ${projectName}`);
+
+  // ─── Step 2: Initialize Go module ─────────────────────
+  utils.step(2, 'Initializing Go module');
+  await utils.runInProject(projectName, `go mod init ${projectName}`);
+
+  // ─── Step 3: Install Gin ───────────────────────────────
+  utils.step(3, 'Installing Gin');
+  await utils.runInProject(projectName, 'go get github.com/gin-gonic/gin');
+
+  // ─── Step 4: Database ─────────────────────────────────
+  if (database !== 'none') {
+    utils.step(4, 'Installing database dependencies');
+    await utils.runInProject(projectName, 'go get gorm.io/gorm');
+
+    if (database === 'postgresql') {
+      await utils.runInProject(projectName, 'go get gorm.io/driver/postgres');
+    }
+
+    if (database === 'mysql') {
+      await utils.runInProject(projectName, 'go get gorm.io/driver/mysql');
+    }
+
+    if (database === 'sqlite') {
+      await utils.runInProject(projectName, 'go get gorm.io/driver/sqlite');
+    }
+  }
+
+  // ─── Step 5: Generate main.go ─────────────────────────
+  utils.step(5, 'Generating application files');
+
+  const mainGo = `package main
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+)
+
+func main() {
+	r := gin.Default()
+
+	r.GET("/", func(c *gin.Context) {
+		c.JSON(http.StatusOK, gin.H{
+			"message": "Hello from ${projectName}",
+		})
+	})
+
+	r.GET("/health", func(c *gin.Context) {
+		c.JSON(http.StatusOK, gin.H{
+			"status": "ok",
+		})
+	})
+
+	r.Run(":8080")
+}
+`;
+
+  await utils.createFile(`${projectName}/main.go`, mainGo);
+
+  // ─── Step 6: Generate database.go if needed ───────────
+  if (database !== 'none') {
+    const dsnMap = {
+      postgresql: `host=localhost user=postgres password=password dbname=${projectName} port=5432 sslmode=disable`,
+      mysql: `user:password@tcp(localhost:3306)/${projectName}?charset=utf8mb4&parseTime=True&loc=Local`,
+      sqlite: `${projectName}.db`,
+    };
+
+    const driverMap = {
+      postgresql: 'postgres',
+      mysql: 'mysql',
+      sqlite: 'sqlite',
+    };
+
+    const databaseGo = `package main
+
+import (
+	"log"
+
+	"gorm.io/driver/${driverMap[database]}"
+	"gorm.io/gorm"
+)
+
+var DB *gorm.DB
+
+func initDB() {
+	dsn := "${dsnMap[database]}"
+	db, err := gorm.Open(${driverMap[database]}.Open(dsn), &gorm.Config{})
+	if err != nil {
+		log.Fatal("Failed to connect to database:", err)
+	}
+	DB = db
+}
+`;
+    await utils.createFile(`${projectName}/database.go`, databaseGo);
+  }
+
+  // ─── Step 7: Generate .gitignore ──────────────────────
+  const gitignore = `# Binaries
+${projectName}
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary
+*.test
+
+# Output of go coverage tool
+*.out
+
+# Environment
+.env
+
+# IDE
+.vscode/
+.idea/
+`;
+  await utils.createFile(`${projectName}/.gitignore`, gitignore);
+
+  // ─── Step 8: Docker ───────────────────────────────────
+  if (docker) {
+    utils.step(6, 'Creating Docker config');
+
+    const dockerfile = `FROM golang:1.21-alpine AS builder
+
+WORKDIR /app
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+RUN go build -o main .
+
+FROM alpine:latest
+
+WORKDIR /app
+COPY --from=builder /app/main .
+
+EXPOSE 8080
+CMD ["./main"]
+`;
+
+    const dockerCompose = `version: '3.8'
+services:
+  web:
+    build: .
+    ports:
+      - "8080:8080"
+    depends_on:
+      - db
+${
+  database === 'postgresql'
+    ? `  db:
+    image: postgres:15
+    environment:
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: ${projectName}
+    ports:
+      - "5432:5432"`
+    : ''
+}
+${
+  database === 'mysql'
+    ? `  db:
+    image: mysql:8.0
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: ${projectName}
+    ports:
+      - "3306:3306"`
+    : ''
+}
+`;
+
+    await utils.createFile(`${projectName}/Dockerfile`, dockerfile);
+    await utils.createFile(`${projectName}/docker-compose.yml`, dockerCompose);
+  }
+
+  // ─── Step 9: go mod tidy ──────────────────────────────
+  utils.step(7, 'Tidying Go modules');
+  await utils.runInProject(projectName, 'go mod tidy');
+
+  utils.success(`Gin v1 project "${projectName}" created successfully!`);
+  utils.log(`  cd ${projectName}`);
+  utils.log(`  go run main.go`);
+  utils.log(`  Server running at http://localhost:8080`);
+};

package/registry/index.json

@@ -5,8 +5,8 @@
         "name": "Laravel",
         "alias": ["laravel"],
         "language": "php",
-        "latest": "v11",
-        "versions": ["v11", "v10"],
+        "latest": "v13",
+        "versions": ["v13", "v12", "v11"],
         "path": "php/laravel"
       },
       {
@@ -61,8 +61,8 @@
         "name": "FastAPI",
         "alias": ["fastapi"],
         "language": "python",
-        "latest": "v0",
-        "versions": ["v0"],
+        "latest": "v1",
+        "versions": ["v1"],
         "path": "python/fastapi"
       },
       {

package/registry/javascript/expressjs/plugin.json

@@ -0,0 +1,44 @@
+{
+  "name": "ExpressJS",
+  "alias": ["express", "expressjs"],
+  "language": "javascript",
+  "latest": "v4",
+  "versions": ["v4"],
+  "description": "Fast, minimalist web framework for Node.js",
+  "requires": [
+    {
+      "tool": "node",
+      "checkCommand": "node --version",
+      "parseVersion": "v([0-9]+\\.[0-9]+\\.[0-9]+)",
+      "minVersion": "18.0.0",
+      "installGuide": {
+        "mac": "brew install node",
+        "linux": "sudo apt install nodejs",
+        "windows": "https://nodejs.org",
+        "docs": "https://nodejs.org"
+      }
+    },
+    {
+      "tool": "npm",
+      "checkCommand": "npm --version",
+      "parseVersion": "([0-9]+\\.[0-9]+\\.[0-9]+)",
+      "minVersion": "8.0.0",
+      "installGuide": {
+        "mac": "brew install node",
+        "linux": "sudo apt install npm",
+        "windows": "https://nodejs.org",
+        "docs": "https://docs.npmjs.com"
+      }
+    }
+  ],
+  "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/expressjs/v4/questions.js

@@ -0,0 +1,43 @@
+import { detectAvailableChoices } from '../../../../core/detector.js';
+import { createRequire } from 'module';
+
+const require = createRequire(import.meta.url);
+const pluginMeta = require('../plugin.json');
+
+export default async () => {
+  const availableManagers = await detectAvailableChoices(
+    pluginMeta.packageManagerQuestion.choices
+  );
+
+  return [
+    {
+      type: 'select',
+      name: 'packageManager',
+      message: pluginMeta.packageManagerQuestion.message,
+      choices: availableManagers,
+    },
+    {
+      type: 'confirm',
+      name: 'typescript',
+      message: 'Use TypeScript?',
+      default: false,
+    },
+    {
+      type: 'select',
+      name: 'database',
+      message: 'Database?',
+      choices: [
+        { name: 'None', value: 'none' },
+        { name: 'MongoDB   — Mongoose ODM', value: 'mongodb' },
+        { name: 'PostgreSQL — pg driver', value: 'postgresql' },
+        { name: 'MySQL     — mysql2 driver', value: 'mysql' },
+      ],
+    },
+    {
+      type: 'confirm',
+      name: 'docker',
+      message: 'Include Docker config?',
+      default: false,
+    },
+  ];
+};