scaffoldrite 2.0.2 → 2.0.4

package/dist/library/ai/ait.js

@@ -0,0 +1,129 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ai = void 0;
+const child_process_1 = require("child_process");
+const data_1 = require("../../data");
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const generateStructure_1 = require("./generateStructure");
+// ─────────────────────────────────────────────
+// HELPER: readline wrapper
+// ─────────────────────────────────────────────
+function createAsk() {
+    const rl = require("readline").createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    const ask = (q) => new Promise((res) => rl.question(q, res));
+    return { ask, close: () => rl.close() };
+}
+// ─────────────────────────────────────────────
+// HELPER: sanitize AI output for ScaffoldRite
+// ─────────────────────────────────────────────
+function sanitizeStructureSR(input) {
+    return input
+        .split("\n")
+        .filter((line) => !line.match(/^\s*(STRUCTURE|FORMAT|SYNTAX|RULES)/i))
+        .join("\n")
+        .trim();
+}
+// ─────────────────────────────────────────────
+// MAIN AI FUNCTION
+// ─────────────────────────────────────────────
+const ai = async () => {
+    try {
+        // ─────────────────────────────────────────────
+        // 1️⃣ INITIAL QUESTIONS
+        // ─────────────────────────────────────────────
+        let { ask, close } = createAsk();
+        const projectName = await ask("Project name: ");
+        const framework = await ask("Framework (react, vue, vanilla): ");
+        const language = await ask("Language (js, ts): ");
+        close(); // ❗ CLOSE BEFORE execSync
+        // ─────────────────────────────────────────────
+        // 2️⃣ CREATE VITE PROJECT
+        // ─────────────────────────────────────────────
+        let template = framework.toLowerCase();
+        if (framework === "react" && language === "ts")
+            template = "react-ts";
+        if (framework === "vue" && language === "ts")
+            template = "vue-ts";
+        if (framework === "vanilla" && language === "ts")
+            template = "vanilla-ts";
+        (0, child_process_1.execSync)(`npx create-vite@latest "${projectName}" --template ${template} --no-rolldown --no-immediate`, {
+            stdio: "inherit",
+            shell: process.platform === "win32" ? "cmd.exe" : "/bin/sh",
+        });
+        const projectPath = path_1.default.resolve(process.cwd(), projectName);
+        // ─────────────────────────────────────────────
+        // 3️⃣ INIT SCAFFOLDRITE
+        // ─────────────────────────────────────────────
+        (0, child_process_1.execSync)("sr init --from-fs .", {
+            cwd: projectPath,
+            stdio: "inherit",
+            shell: process.platform === "win32" ? "cmd.exe" : "/bin/sh",
+        });
+        // ─────────────────────────────────────────────
+        // 4️⃣ ASK FOR AI ASSISTANCE
+        // ─────────────────────────────────────────────
+        ({ ask, close } = createAsk());
+        const wantAI = await ask("\n🤖 Do you want AI assistance in scaffolding the structure of your app? (yes/no): ");
+        if (wantAI.toLowerCase() === "yes") {
+            while (true) {
+                const description = await ask("\n📝 Describe your project or what you want to add/change:\n");
+                const structurePath = path_1.default.join(projectPath, ".scaffoldrite", "structure.sr");
+                const existingStructure = fs_1.default.readFileSync(structurePath, "utf-8");
+                const result = await (0, generateStructure_1.generateStructure)({
+                    existingStructure,
+                    description,
+                });
+                // 🧠 CLARIFICATION MODE
+                if (result.startsWith("CLARIFICATION_REQUIRED")) {
+                    console.log("\n🤖 I need clarification:\n");
+                    console.log(result);
+                    const confirm = await ask("\nIs this what you meant? (yes/no): ");
+                    if (confirm.toLowerCase() === "yes") {
+                        await ask("\n✏️ Please rephrase clearly what you want:\n");
+                        continue;
+                    }
+                    else {
+                        console.log("\n🔁 Okay, please describe what you want again.\n");
+                        continue;
+                    }
+                }
+                // ✅ STRUCTURE MODE
+                const clean = sanitizeStructureSR(result);
+                fs_1.default.writeFileSync(structurePath, clean);
+                // Generate the project structure
+                (0, child_process_1.execSync)("sr generate .", {
+                    cwd: projectPath,
+                    stdio: "inherit",
+                });
+                (0, child_process_1.execSync)("sr list --sr --with-icon", {
+                    cwd: projectPath,
+                    stdio: "inherit",
+                });
+                // Ask if satisfied
+                ({ ask, close } = createAsk());
+                const satisfied = await ask("\n✅ Are you satisfied with the structure? (yes/no): ");
+                if (satisfied.toLowerCase() === "yes")
+                    break;
+            }
+        }
+        close();
+        // ─────────────────────────────────────────────
+        // 5️⃣ FINISH
+        // ─────────────────────────────────────────────
+        console.log(data_1.theme.success(`\n🎉 Project ${projectName} is ready!\n`));
+        console.log(data_1.theme.muted(`  cd ${projectName}`));
+        console.log(data_1.theme.muted("  npm install"));
+        console.log(data_1.theme.muted("  npm run dev"));
+    }
+    catch (err) {
+        console.error(data_1.theme.error(`❌ Failed: ${err.message}`));
+    }
+};
+exports.ai = ai;

package/dist/library/ai/generateStructure.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateStructure = generateStructure;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+async function generateStructure(params) {
+    try {
+        const response = await (0, node_fetch_1.default)("http://localhost:3000/generate-structure", {
+            method: "POST",
+            headers: { "Content-Type": "application/json" },
+            body: JSON.stringify(params),
+        });
+        if (!response.ok) {
+            const text = await response.text();
+            throw new Error(`Backend error: ${text}`);
+        }
+        const data = await response.json();
+        if (typeof data?.result !== "string") {
+            throw new Error("Invalid backend response: result missing");
+        }
+        return data.result;
+    }
+    catch (err) {
+        throw new Error(`Failed to generate structure: ${err.message}`);
+    }
+}

package/dist/library/ai/generateStructureWithGroq.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateStructureWithGroq = generateStructureWithGroq;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+async function generateStructureWithGroq(params) {
+    const { existingStructure, description } = params;
+    const GROQ_API_KEY = process.env.GROQ_API_KEY;
+    if (!GROQ_API_KEY) {
+        console.error("❌ GROQ_API_KEY is missing.");
+        console.error("➡️  Add it to your .env file:");
+        console.error("   GROQ_API_KEY=your_key_here");
+        process.exit(1);
+    }
+    const systemPrompt = `
+You are a frontend project structure generator for Scaffoldrite.
+
+STRICT RULES:
+- Output ONLY valid structure.sr syntax
+- DO NOT include markdown
+- DO NOT explain anything
+- DO NOT add comments
+- DO NOT wrap output in code blocks
+- Preserve all existing files and folders
+- Only ADD or EXTEND structure where necessary
+- NEVER delete existing entries
+- Frontend-only structure
+- Ignore backend, database, server, API implementation details
+- Backend mentions should be interpreted as frontend needs
+- Valid entities: folder, file
+- Maintain correct indentation
+`;
+    const userPrompt = `
+EXISTING STRUCTURE:
+${existingStructure}
+
+PROJECT DESCRIPTION:
+${description}
+
+TASK:
+Update the existing structure to satisfy the description.
+`;
+    const response = await (0, node_fetch_1.default)("https://api.groq.com/openai/v1/chat/completions", {
+        method: "POST",
+        headers: {
+            "Authorization": `Bearer ${GROQ_API_KEY}`,
+            "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
+            model: "llama-3.1-70b-versatile",
+            temperature: 0.2,
+            max_tokens: 1500,
+            messages: [
+                { role: "system", content: systemPrompt },
+                { role: "user", content: userPrompt },
+            ],
+        }),
+    });
+    if (!response.ok) {
+        const text = await response.text();
+        throw new Error(`Groq API error: ${text}`);
+    }
+    const data = (await response.json());
+    const output = data.choices?.[0]?.message?.content;
+    if (!output || typeof output !== "string") {
+        throw new Error("Groq returned empty structure");
+    }
+    // 🔒 Final safety check
+    if (!output.includes("folder") && !output.includes("file")) {
+        throw new Error("Invalid structure.sr output from Groq");
+    }
+    return output.trim();
+}

package/dist/library/checkpage/checkPackageType.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateStructure = generateStructure;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+async function generateStructure(params) {
+    try {
+        const response = await (0, node_fetch_1.default)("https://your-backend.com/generate-structure", {
+            method: "POST",
+            headers: { "Content-Type": "application/json" },
+            body: JSON.stringify(params),
+        });
+        if (!response.ok) {
+            const text = await response.text();
+            throw new Error(`Backend error: ${text}`);
+        }
+        const data = await response.json();
+        return data.structure;
+    }
+    catch (err) {
+        throw new Error(`Failed to generate structure: ${err.message}`);
+    }
+}

package/dist/library/checkpage/checkpackage.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkAndReportPackages = checkAndReportPackages;
+// ./checkpage/checkpackage.ts
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const depcheck_1 = __importDefault(require("depcheck"));
+const data_1 = require("../../data");
+const TS_TYPE_REGEX = /^@types\//;
+async function checkAndReportPackages() {
+    console.log(data_1.theme.primary.bold(`${data_1.icons.folder} Checking project dependencies...\n`));
+    const packageJsonPath = path_1.default.join(process.cwd(), "package.json");
+    if (!fs_1.default.existsSync(packageJsonPath)) {
+        console.error(data_1.theme.error(`${data_1.icons.error} package.json was not found in current directory.`));
+        return;
+    }
+    const packageJson = JSON.parse(fs_1.default.readFileSync(packageJsonPath, "utf-8"));
+    const allDeps = { ...packageJson.dependencies, ...packageJson.devDependencies };
+    const missingDeps = [];
+    // 1️⃣ Check runtime-resolvable deps
+    for (const dep of Object.keys(allDeps)) {
+        try {
+            require.resolve(dep);
+        }
+        catch {
+            missingDeps.push(dep);
+        }
+    }
+    // 2️⃣ Run depcheck to catch imported-but-not-listed packages
+    const options = { ignoreDirs: ["dist", "build", "node_modules"] };
+    const result = await (0, depcheck_1.default)(process.cwd(), options);
+    // Combine depcheck missing deps (filter duplicates)
+    const depcheckMissing = Object.keys(result.missing || {}).filter((dep) => !missingDeps.includes(dep));
+    const finalMissing = [...missingDeps, ...depcheckMissing];
+    if (finalMissing.length === 0) {
+        console.log(data_1.theme.success.bold(`${data_1.icons.check} All packages are installed!`));
+        return;
+    }
+    // Separate runtime deps vs TypeScript types
+    const runtimeDeps = [];
+    const typeDeps = [];
+    finalMissing.forEach((pkg) => {
+        if (TS_TYPE_REGEX.test(pkg))
+            typeDeps.push(pkg);
+        else
+            runtimeDeps.push(pkg);
+    });
+    console.log(data_1.theme.error.bold(`${data_1.icons.error} Missing packages:`));
+    runtimeDeps.forEach((pkg) => console.log(data_1.theme.warning(`  - ${pkg} (runtime)`)));
+    typeDeps.forEach((pkg) => console.log(data_1.theme.warning(`  - ${pkg} (TypeScript type)`)));
+    console.log(); // newline
+    if (runtimeDeps.length)
+        console.log(data_1.theme.info(`Install runtime packages: npm install ${runtimeDeps.join(" ")}`));
+    if (typeDeps.length)
+        console.log(data_1.theme.info(`Install TypeScript types as dev deps: npm install -D ${typeDeps.join(" ")}`));
+}

package/dist/library/commandHandler.js

@@ -28,6 +28,7 @@ const index_7 = require("../utils/index");
 const index_8 = require("../utils/index");
 const index_9 = require("../utils/index");
 const index_10 = require("../utils/index");
+const checkpackage_1 = require("./checkpage/checkpackage");
 const args = process.argv.slice(3).filter((a) => !a.startsWith("--"));
 const arg3 = args[0];
 const arg4 = args[1];
@@ -64,9 +65,11 @@ if (!index_9.command || index_9.command === "--help" || index_9.command === "-h"
     (0, index_3.printUsage)();
     (0, index_8.exit)(0);
 }
-if (!allowedFlags) {
-    console.error(index_4.theme.error.bold(`${index_4.icons.error} Unknown command: ${index_9.command}`));
-    (0, index_8.exit)(1);
+if (!index_3.ALLOWED_FLAGS.hasOwnProperty(index_9.command)) {
+    console.log(allowedFlags, 'wati');
+    console.error(`✗ Unknown command: ${index_9.command}`);
+    (0, index_3.printUsage)();
+    process.exit(1);
 }
 const invalidFlags = passedFlags?.filter((flag) => !allowedFlags.includes(flag));
 if (invalidFlags?.length > 0) {
@@ -128,6 +131,7 @@ exports.commandHandlers = {
     //   return;
     // }
     // },
+    "check-packages": checkpackage_1.checkAndReportPackages,
     init: async () => {
         const shouldOverwrite = force;
         const sDir = path_1.default.join(index_7.baseDir, ".scaffoldrite");

package/dist/library/sam.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/index.js

@@ -240,6 +240,7 @@ exports.ALLOWED_FLAGS = {
     rename: ["--yes", "--dry-run", "--verbose", "--summary"],
     list: ["--structure", "--sr", "--fs", "--diff", "--with-icon"],
     version: [],
+    "check-packages": ["--validate"]
 };
 function printUsage(cmd) {
     if (cmd && exports.ALLOWED_FLAGS[cmd]) {
@@ -254,6 +255,7 @@ function printUsage(cmd) {
             delete: "<path> [--yes | -y] [--dry-run] [--verbose | --summary]",
             rename: "<path> <newName> [--yes | -y] [--dry-run] [--verbose | --summary]",
             version: "",
+            "check-packages": "[--validate]"
         };
         const args = argsMap[cmd] ? ` ${argsMap[cmd]}` : "";
         console.log(data_1.theme.primary.bold(`Usage for '${cmd}':`) +

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scaffoldrite",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "A project structure validator and generator CLI tool.",
   "author": "Isaac Anasonye",
   "license": "MIT",
@@ -51,5 +51,11 @@
   },
   "engines": {
     "node": ">=17"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "depcheck": "^1.4.7",
+    "dotenv": "^17.2.3",
+    "node-fetch": "^3.3.2"
   }
 }

package/readme.md

@@ -621,7 +621,6 @@ Sometimes you need exceptions. That's where `.scaffoldignore` comes in:
 node_modules/      # Ignore dependencies
 dist/             # Ignore build output
 .temp/            # Ignore temporary files
-
 ```
 
 **Used when:**
@@ -819,17 +818,64 @@ When generating to **output directories**, you can use the `--copy` flag to pres
 # Generate structure with empty files (default)
 sr generate ./output
 
-# Generate structure AND copy file contents
+
+## 💾 Preserving Content & Mitigating Risks
+
+Scaffoldrite focuses on **structure, not file content**. By default, `sr generate` creates missing files or folders **without preserving existing file content**. To make this safer, follow these best practices:
+
+### 1️⃣ Use `--copy` when generating to a different directory
+
+```bash
 sr generate ./output --copy
 ```
 
-**Use `--copy` when:**
-- Creating project templates from existing codebases
-- Distributing complete starter kits
-- Preserving file contents in generated output
-- Building project generators
+* Copies existing file contents from source to output
+* Maintains templates or boilerplate if defined
+* Great for creating project templates or starter kits
+
+**Notes:**
+
+* `--copy` **does not work in-place**; use Git or manual backup for regenerating in the same directory.
+* Cannot be combined with `--ignore-tooling`.
+
+### 2️⃣ Commit changes before regenerating
+
+Always commit your work before running `sr generate`:
+
+```bash
+git add .
+git commit -m "Save work before sr generate"
+```
+
+This ensures you can **restore deleted or modified files** if anything goes wrong.
+
+### 3️⃣ Validate first
+
+Preview what Scaffoldrite would change without affecting your files:
+
+```bash
+sr validate --allow-extra
+```
+
+This shows missing, extra, or misaligned files, so you can make informed decisions.
+
+### 4️⃣ Rename carefully
+
+Instead of renaming in `structure.sr` first:
+
+1. Rename the file in your filesystem.
+2. Sync your `structure.sr`:
+
+```bash
+sr update --from-fs .
+```
+
+This preserves content because the filesystem rename happens before Scaffoldrite updates the structure.
+
+### Warning
+
+> ⚠ Renaming a file in `structure.sr` **will delete the old file in the filesystem**. Commit or back up your work first.
 
-**Note:** `--copy` cannot be used with `--ignore-tooling` as they're mutually exclusive flags.
 
 ### Real-World Examples