scaffy-tool 0.1.1 → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-<img src="https://readme-typing-svg.demolab.com?font=Fira+Code&weight=700&size=40&pause=1000&color=00D4FF&center=true&vCenter=true&width=600&lines=Scaffy+%F0%9F%9A%80;One+Command.+Any+Framework." alt="Scaffy" />
+<img src="https://readme-typing-svg.demolab.com?font=Fira+Code&weight=700&size=40&pause=1000&color=00D4FF&center=true&vCenter=true&width=800&lines=Scaffy+%F0%9F%9A%80;One+Command.+Any+Framework." alt="Scaffy" />
 
 <p align="center">
   <strong>The universal CLI scaffolding tool for modern developers.</strong><br/>
@@ -88,13 +88,13 @@ One command. A few questions. Ready to code.
 
 Existing scaffolding tools are framework-specific, opinionated, and go stale fast. Scaffy takes a fundamentally different approach.
 
-|                             | Traditional Scaffolding        | Scaffy                              |
-|-----------------------------|-------------------------------|-------------------------------------|
-| **Multi-framework support** | ❌ One tool per framework      | ✅ Every framework, one tool        |
-| **Always up to date**       | ❌ Stores stale templates      | ✅ Uses official CLI commands       |
-| **Requirement checking**    | ❌ Breaks halfway through      | ✅ Validates before starting        |
-| **Community extensible**    | ❌ Closed, maintainer-only     | ✅ Add any framework in 3 files     |
-| **Version management**      | ❌ Usually locked to one       | ✅ Multiple versions per framework  |
+|                             | Traditional Scaffolding    | Scaffy                             |
+| --------------------------- | -------------------------- | ---------------------------------- |
+| **Multi-framework support** | ❌ One tool per framework  | ✅ Every framework, one tool       |
+| **Always up to date**       | ❌ Stores stale templates  | ✅ Uses official CLI commands      |
+| **Requirement checking**    | ❌ Breaks halfway through  | ✅ Validates before starting       |
+| **Community extensible**    | ❌ Closed, maintainer-only | ✅ Add any framework in 3 files    |
+| **Version management**      | ❌ Usually locked to one   | ✅ Multiple versions per framework |
 
 ---
 
@@ -142,7 +142,7 @@ scaffy --help            # Help
   <td rowspan="2"><strong>PHP</strong></td>
   <td>Laravel</td>
   <td><code>scaffy laravel</code></td>
-  <td>v10, v11</td>
+  <td>v11, v12, v13</td>
 </tr>
 <tr>
   <td>Symfony</td>
@@ -153,7 +153,7 @@ scaffy --help            # Help
   <td rowspan="4"><strong>JavaScript</strong></td>
   <td>NestJS</td>
   <td><code>scaffy nestjs</code></td>
-  <td>v10</td>
+  <td>v10, v11</td>
 </tr>
 <tr>
   <td>VueJS</td>
@@ -179,12 +179,7 @@ scaffy --help            # Help
 <tr>
   <td>FastAPI</td>
   <td><code>scaffy fastapi</code></td>
-  <td>v0.100+</td>
-</tr>
-<tr>
-  <td>Flask</td>
-  <td><code>scaffy flask</code></td>
-  <td>v3</td>
+  <td>v1</td>
 </tr>
 <tr>
   <td><strong>Go</strong></td>
@@ -219,20 +214,16 @@ Scaffy does **not** store template files. Instead, `scaffold.js` calls the frame
 ```javascript
 // registry/php/laravel/v11/scaffold.js
 module.exports = async (answers, utils) => {
-  const { projectName, starterKit, database } = answers
+  const { projectName, starterKit, database } = answers;
 
   // Step 1 — Official Laravel installer
-  await utils.run(
-    `composer create-project laravel/laravel ${projectName}`
-  )
+  await utils.run(`composer create-project laravel/laravel ${projectName}`);
 
   // Step 2 — Layered on top with your choices
   if (starterKit === 'Breeze') {
-    await utils.runInProject(projectName,
-      `php artisan breeze:install`
-    )
+    await utils.runInProject(projectName, `php artisan breeze:install`);
   }
-}
+};
 ```
 
 When a new framework version releases tomorrow, a community member can add support in minutes — with zero changes to Scaffy's core.
@@ -306,7 +297,8 @@ Scaffy maintains a minimum **80% test coverage** across all core modules. Every
 
 ## 🛣️ Roadmap
 
-**v0.1.0 — Hello World** *(current)*
+**v0.1.0 — Hello World** _(current)_
+
 - [x] Core engine — detector, registry, interviewer, executor
 - [x] Functional programming architecture
 - [x] Requirement checking with OS-specific install guides
@@ -315,17 +307,20 @@ Scaffy maintains a minimum **80% test coverage** across all core modules. Every
 - [x] Published on npm
 
 **v0.2.0 — Community Ready**
+
 - [ ] ESM migration — modern JavaScript standard
 - [ ] Plugin contribution system with automated CI validation
 - [ ] Full documentation site
 - [ ] 15+ framework plugins
 
 **v0.3.0 — Growth**
+
 - [ ] AI mode — describe your project in plain English
 - [ ] `scaffy add github:user/plugin` — install external plugins
 - [ ] Discord community
 
 **v1.0.0 — Ecosystem**
+
 - [ ] VS Code extension
 - [ ] Plugin marketplace website
 - [ ] Enterprise adoption
@@ -389,4 +384,4 @@ Built with dedication by the Scaffy community
 &nbsp;·&nbsp;
 <a href="https://github.com/TanvirHossen112/scaffy/discussions">💬 Join the discussion</a>
 
-</div>
+</div>

package/cli.js

@@ -1,17 +1,18 @@
 #!/usr/bin/env node
-
-const { Command } = require('commander');
-const chalk = require('chalk');
-const figlet = require('figlet');
-const ora = require('ora');
+import { Command } from 'commander';
+import chalk from 'chalk';
+import figlet from 'figlet';
+import ora from 'ora';
+import { createRequire } from 'module';
+import * as detector from './core/detector.js';
+import * as registry from './core/registry.js';
+import * as interviewer from './core/interviewer.js';
+import * as executor from './core/executor.js';
+import { buildPluginUtils, title, error, divider } from './core/utils.js';
+
+const require = createRequire(import.meta.url);
 const { version } = require('./package.json');
-const detector = require('./core/detector');
-const registry = require('./core/registry');
-const interviewer = require('./core/interviewer');
-const executor = require('./core/executor');
-const { buildPluginUtils, title, error, divider } = require('./core/utils');
 
-// ─── Banner ───────────────────────────────────────────
 const showBanner = () => {
   console.log(
     chalk.cyan(
@@ -24,32 +25,24 @@ const showBanner = () => {
   console.log(chalk.gray('  One command. Any framework. Ready to code.\n'));
 };
 
-// ─── Run Full Scaffold Flow ────────────────────────────
 const runScaffold = async framework => {
   try {
-    // Step 1 — Load plugin
-    const version = await interviewer.askVersion(framework);
-    const plugin = registry.loadPlugin(framework, version);
+    const selectedVersion = await interviewer.askVersion(framework);
+    const plugin = await registry.loadPlugin(framework, selectedVersion);
 
-    // Step 2 — Check requirements
     const requirementsMet = await detector.report(plugin.meta.requires);
-
     if (!requirementsMet) {
       process.exit(1);
     }
 
-    // Step 3 — Ask questions
     const answers = await interviewer.askFrameworkQuestions(framework, plugin);
 
-    // Step 4 — Build utils for plugin
     const utils = buildPluginUtils(executor);
 
-    // Step 5 — Run scaffold
     divider();
     const spinner = ora(
       chalk.cyan(`Scaffolding ${framework.name} project...`)
     ).start();
-
     try {
       await plugin.scaffold(answers, utils);
       spinner.succeed(
@@ -68,7 +61,6 @@ const runScaffold = async framework => {
   }
 };
 
-// ─── Program Setup ────────────────────────────────────
 const program = new Command();
 
 program
@@ -76,21 +68,16 @@ program
   .description('One command. Any framework. Ready to code.')
   .version(version, '-v, --version', 'Show current version');
 
-// ─── Default Command ───────────────────────────────────
 program
   .argument('[framework]', 'Framework name to scaffold directly')
   .action(async frameworkQuery => {
     showBanner();
-
-    // Direct framework mode
     if (frameworkQuery) {
       const framework = await interviewer.askDirectFramework(frameworkQuery);
       if (!framework) process.exit(1);
       await runScaffold(framework);
       return;
     }
-
-    // Interactive mode
     try {
       title('Select A Framework');
       const framework = await interviewer.askFramework();
@@ -101,7 +88,6 @@ program
     }
   });
 
-// ─── List Command ──────────────────────────────────────
 program
   .command('list')
   .description('List all available frameworks')
@@ -110,15 +96,12 @@ program
     registry.displayFrameworks();
   });
 
-// ─── Search Command ────────────────────────────────────
 program
   .command('search <query>')
   .description('Search for a framework by name or language')
   .action(query => {
     showBanner();
-
     const results = registry.searchFrameworks(query);
-
     if (results.length === 0) {
       console.log(chalk.red(`\n  No frameworks found for "${query}"\n`));
       console.log(
@@ -126,18 +109,14 @@ program
       );
       return;
     }
-
     console.log(chalk.bold(`\n  🔍 Results for "${query}":\n`));
-
     results.forEach(f => {
       console.log(
         chalk.white(`  • ${f.name}`) +
           chalk.gray(` (${f.language}) — scaffy ${f.alias[0]}`)
       );
     });
-
     console.log('');
   });
 
-// ─── Parse ────────────────────────────────────────────
 program.parse(process.argv);

package/core/detector.js

@@ -1,7 +1,7 @@
-const { execSync } = require('child_process');
-const os = require('os');
-const semver = require('semver');
-const chalk = require('chalk');
+import { execSync } from 'child_process';
+import os from 'os';
+import semver from 'semver';
+import chalk from 'chalk';
 
 const getOS = () => {
   const platform = os.platform();
@@ -49,25 +49,18 @@ const buildToolResult = (tool, installed, versionOk, extra = {}) => ({
 
 const checkTool = requirement => {
   const { tool, checkCommand, parseVersion, minVersion } = requirement;
-
   const { success, output } = runCommand(checkCommand);
-
   if (!success) {
     return buildToolResult(tool, false, false);
   }
-
   if (!parseVersion || !minVersion) {
     return buildToolResult(tool, true, true);
   }
-
   const installedVersion = parseVersionFromOutput(output, parseVersion);
-
   if (!installedVersion) {
     return buildToolResult(tool, true, true);
   }
-
   const versionOk = satisfiesMinVersion(installedVersion, minVersion);
-
   return buildToolResult(tool, true, versionOk, {
     installedVersion,
     ...(!versionOk && { requiredVersion: minVersion }),
@@ -79,9 +72,7 @@ const checkAll = requirements => {
     ...checkTool(req),
     installGuide: req.installGuide,
   }));
-
   const allPassed = results.every(r => r.installed && r.versionOk);
-
   return { allPassed, results };
 };
 
@@ -89,7 +80,6 @@ const formatToolStatus = result => {
   if (result.installed && result.versionOk) {
     return chalk.green(`  ✅ ${result.tool}`) + chalk.gray(' — found');
   }
-
   if (result.installed && !result.versionOk) {
     return (
       chalk.yellow(`  ⚠️  ${result.tool}`) +
@@ -99,35 +89,27 @@ const formatToolStatus = result => {
       )
     );
   }
-
   return chalk.red(`  ❌ ${result.tool}`) + chalk.gray(' — not found');
 };
 
 const formatInstallGuide = (guide, currentOS) => {
   if (!guide) return [];
-
   const lines = [];
-
   if (guide[currentOS]) {
     lines.push(chalk.cyan(`     💻 Install: `) + chalk.white(guide[currentOS]));
   }
-
   if (guide.docs) {
     lines.push(chalk.cyan(`     📖 Docs: `) + chalk.underline(guide.docs));
   }
-
   return lines;
 };
 
 const formatResult = currentOS => result => {
   const lines = [formatToolStatus(result)];
-
   const needsGuide = !result.installed || !result.versionOk;
-
   if (needsGuide) {
     lines.push(...formatInstallGuide(result.installGuide, currentOS));
   }
-
   return lines.join('\n');
 };
 
@@ -144,43 +126,35 @@ const formatSuccessMessage = () =>
 
 const report = requirements => {
   console.log(chalk.bold('\n🔍 Checking requirements...\n'));
-
   const { allPassed, results } = checkAll(requirements);
   const currentOS = getOS();
-
   results.map(formatResult(currentOS)).forEach(line => console.log(line));
-
   console.log(allPassed ? formatSuccessMessage() : formatFailureMessage());
-
   return allPassed;
 };
 
 const detectAvailableChoices = async choices => {
   if (!choices || choices.length === 0) return [];
-
   const results = await Promise.all(
     choices.map(async choice => {
       try {
         const { success, output } = runCommand(choice.checkCommand);
-
         if (!success || !output || output.toString().trim() === '') {
           return { ...choice, installed: false };
         }
-
         return { ...choice, installed: true };
       } catch {
         return { ...choice, installed: false };
       }
     })
   );
-
   const available = results.filter(c => c.installed);
   return available.length > 0
     ? available
     : [{ ...choices[0], installed: false }];
 };
 
-module.exports = {
+export {
   getOS,
   runCommand,
   parseVersionFromOutput,

package/core/executor.js

@@ -1,19 +1,16 @@
-const { spawn } = require('child_process');
-const fs = require('fs');
-const path = require('path');
-const chalk = require('chalk');
+import { spawn } from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
 
 const run = command =>
   new Promise((resolve, reject) => {
     console.log(chalk.gray(`\n  $ ${command}\n`));
-
     const [cmd, ...args] = command.split(' ');
-
     const child = spawn(cmd, args, {
       stdio: 'inherit',
       shell: true,
     });
-
     child.on('close', code => {
       if (code !== 0) {
         reject(new Error(`Command failed with exit code ${code}: ${command}`));
@@ -21,7 +18,6 @@ const run = command =>
         resolve();
       }
     });
-
     child.on('error', err => {
       reject(new Error(`Failed to run command: ${command}\n${err.message}`));
     });
@@ -29,16 +25,13 @@ const run = command =>
 
 const runInProject = (projectName, command) => {
   console.log(chalk.gray(`\n  $ cd ${projectName} && ${command}\n`));
-
   return new Promise((resolve, reject) => {
     const [cmd, ...args] = command.split(' ');
-
     const child = spawn(cmd, args, {
       stdio: 'inherit',
       shell: true,
       cwd: path.join(process.cwd(), projectName),
     });
-
     child.on('close', code => {
       if (code !== 0) {
         reject(new Error(`Command failed with exit code ${code}: ${command}`));
@@ -46,7 +39,6 @@ const runInProject = (projectName, command) => {
         resolve();
       }
     });
-
     child.on('error', err => {
       reject(new Error(`Failed to run command: ${command}\n${err.message}`));
     });
@@ -55,13 +47,10 @@ const runInProject = (projectName, command) => {
 
 const setEnv = (projectName, vars) => {
   const envPath = path.join(process.cwd(), projectName, '.env');
-
   if (!fs.existsSync(envPath)) {
     throw new Error(`.env file not found in ${projectName}`);
   }
-
   let content = fs.readFileSync(envPath, 'utf8');
-
   Object.entries(vars).forEach(([key, value]) => {
     const regex = new RegExp(`^${key}=.*`, 'm');
     if (regex.test(content)) {
@@ -70,36 +59,25 @@ const setEnv = (projectName, vars) => {
       content += `\n${key}=${value}`;
     }
   });
-
   fs.writeFileSync(envPath, content);
 };
 
 const appendToFile = (filePath, content) => {
   const fullPath = path.join(process.cwd(), filePath);
   const dir = path.dirname(fullPath);
-
   if (!fs.existsSync(dir)) {
     fs.mkdirSync(dir, { recursive: true });
   }
-
   fs.appendFileSync(fullPath, content);
 };
 
 const createFile = (filePath, content = '') => {
   const fullPath = path.join(process.cwd(), filePath);
   const dir = path.dirname(fullPath);
-
   if (!fs.existsSync(dir)) {
     fs.mkdirSync(dir, { recursive: true });
   }
-
   fs.writeFileSync(fullPath, content);
 };
 
-module.exports = {
-  run,
-  runInProject,
-  setEnv,
-  appendToFile,
-  createFile,
-};
+export { run, runInProject, setEnv, appendToFile, createFile };

package/core/interviewer.js

@@ -1,6 +1,6 @@
-const chalk = require('chalk');
-const inquirer = require('inquirer');
-const { getFrameworks, findFramework } = require('./registry');
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import { getFrameworks, findFramework } from './registry.js';
 
 const baseQuestions = framework => [
   {
@@ -55,7 +55,6 @@ const askVersion = async framework => {
   if (framework.versions.length === 1) {
     return framework.latest;
   }
-
   const { version } = await inquirer.prompt([
     {
       type: 'list',
@@ -64,13 +63,11 @@ const askVersion = async framework => {
       choices: buildVersionChoices(framework),
     },
   ]);
-
   return version;
 };
 
 const askDirectFramework = async query => {
   const framework = findFramework(query);
-
   if (!framework) {
     console.log(chalk.red(`\n❌ Framework "${query}" not found.\n`));
     console.log(
@@ -78,20 +75,16 @@ const askDirectFramework = async query => {
     );
     return null;
   }
-
   return framework;
 };
 
 const askFrameworkQuestions = async (framework, plugin) => {
   console.log(chalk.bold(`\n🚀 Setting up ${framework.name}\n`));
-
   const pluginQuestions =
     typeof plugin.questions === 'function'
       ? await plugin.questions()
       : plugin.questions;
-
   const questions = buildQuestions(framework, pluginQuestions);
-
   const answers = await inquirer.prompt(questions);
   return answers;
 };
@@ -125,7 +118,7 @@ const runInteractiveMode = async () => {
   }
 };
 
-module.exports = {
+export {
   baseQuestions,
   buildQuestions,
   buildFrameworkChoices,

package/core/plugin-validator.js

@@ -1,2 +1,2 @@
 // TODO: Coming in Sprint 1
-module.exports = {};
+export default {};