create-fhevm-example 1.3.0 → 1.3.1

package/README.md

@@ -1,5 +1,3 @@
-# create-fhevm-example
-
 <p align="center">
   <strong>Create FHEVM example projects with a single command</strong>
 </p>
@@ -66,14 +64,16 @@ npx create-fhevm-example --example fhe-counter --output ./my-project --install -
 
 ## 📋 CLI Options
 
-`--example <name>` - Create a single example project
-`--category <name>` - Create a category project
-`--add` - Add FHEVM to existing Hardhat project
-`--target <dir>` - Target directory for --add mode (default: current dir)
-`--output <dir>` - Output directory
-`--install` - Auto-install dependencies
-`--test` - Auto-run tests
-`--help` - Show help
+| Option | Description |
+| :--- | :--- |
+| `--example <name>` | Create a single example project |
+| `--category <name>` | Create a category project |
+| `--add` | Add FHEVM to an existing Hardhat project |
+| `--target <dir>` | Target directory for `--add` mode (default: current dir) |
+| `--output <dir>` | Output directory for new projects |
+| `--install` | Auto-install dependencies after scaffolding |
+| `--test` | Auto-run tests (requires `--install`) |
+| `--help`, `-h` | Show help information |
 
 ---
 

package/dist/scripts/add-mode.d.ts

@@ -1,5 +1,8 @@
 /**
- * Add Mode - Add FHEVM to existing Hardhat projects
+ * Add Mode - Feature for adding FHEVM to existing Hardhat projects.
+ *
+ * Logic for managing configuration updates, dependency installations,
+ * and scaffolding example contracts into established projects.
  */
 /**
  * Main function to add FHEVM capabilities to an existing Hardhat project

package/dist/scripts/add-mode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"add-mode.d.ts","sourceRoot":"","sources":["../../scripts/add-mode.ts"],"names":[],"mappings":"AAAA;;GAEG;AAkRH;;GAEG;AACH,wBAAsB,UAAU,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA8ElE"}
+{"version":3,"file":"add-mode.d.ts","sourceRoot":"","sources":["../../scripts/add-mode.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAkRH;;GAEG;AACH,wBAAsB,UAAU,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA8ElE"}

package/dist/scripts/add-mode.js

@@ -1,6 +1,9 @@
 "use strict";
 /**
- * Add Mode - Add FHEVM to existing Hardhat projects
+ * Add Mode - Feature for adding FHEVM to existing Hardhat projects.
+ *
+ * Logic for managing configuration updates, dependency installations,
+ * and scaffolding example contracts into established projects.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

package/dist/scripts/builders.d.ts

@@ -1,20 +1,19 @@
 /**
- * Project Builders
+ * Project Builders - Core logic for scaffolding FHEVM projects.
  *
- * Creates single example and category projects from templates.
+ * Handles the creation of single example projects, category-based
+ * project bundles, and specialized test environments.
  */
 /**
  * Creates a single example project from the template
- * @param exampleName - Name of the example to create
- * @param outputDir - Target directory for the project
- * @param tempRepoPath - Path to cloned template repository
  */
 export declare function createSingleExample(exampleName: string, outputDir: string, tempRepoPath: string): Promise<void>;
 /**
  * Creates a category project with multiple examples
- * @param categoryName - Name of the category to create
- * @param outputDir - Target directory for the project
- * @param tempRepoPath - Path to cloned template repository
  */
 export declare function createCategoryProject(categoryName: string, outputDir: string, tempRepoPath: string): Promise<void>;
+/**
+ * Creates a temporary test project using LOCAL files (used by maintenance.ts)
+ */
+export declare function createLocalTestProject(exampleNames: string[], outputDir: string): Promise<void>;
 //# sourceMappingURL=builders.d.ts.map

package/dist/scripts/builders.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"builders.d.ts","sourceRoot":"","sources":["../../scripts/builders.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAuDH;;;;;GAKG;AACH,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CAgDf;AAMD;;;;;GAKG;AACH,wBAAsB,qBAAqB,CACzC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CA4Df"}
+{"version":3,"file":"builders.d.ts","sourceRoot":"","sources":["../../scripts/builders.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA0DH;;GAEG;AACH,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CA8Cf;AAED;;GAEG;AACH,wBAAsB,qBAAqB,CACzC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CAiEf;AAMD;;GAEG;AACH,wBAAsB,sBAAsB,CAC1C,YAAY,EAAE,MAAM,EAAE,EACtB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAuEf"}

package/dist/scripts/builders.js

@@ -1,8 +1,9 @@
 "use strict";
 /**
- * Project Builders
+ * Project Builders - Core logic for scaffolding FHEVM projects.
  *
- * Creates single example and category projects from templates.
+ * Handles the creation of single example projects, category-based
+ * project bundles, and specialized test environments.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -40,6 +41,7 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createSingleExample = createSingleExample;
 exports.createCategoryProject = createCategoryProject;
+exports.createLocalTestProject = createLocalTestProject;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const config_1 = require("./config");
@@ -73,13 +75,10 @@ async function initGitRepo(outputDir) {
     }
 }
 // =============================================================================
-// Single Example Builder
+// Project Scaffolding
 // =============================================================================
 /**
  * Creates a single example project from the template
- * @param exampleName - Name of the example to create
- * @param outputDir - Target directory for the project
- * @param tempRepoPath - Path to cloned template repository
  */
 async function createSingleExample(exampleName, outputDir, tempRepoPath) {
     const example = config_1.EXAMPLES[exampleName];
@@ -91,31 +90,23 @@ async function createSingleExample(exampleName, outputDir, tempRepoPath) {
     if (!contractName) {
         throw new Error("Could not extract contract name");
     }
-    // Step 1: Copy template and clean up
+    // 1. Copy template and clean up
     (0, utils_1.copyDirectoryRecursive)(templateDir, outputDir);
     (0, utils_1.cleanupTemplate)(outputDir);
-    // Step 2: Download example contract
+    // 2. Download example contract and dependencies
     await (0, utils_1.downloadFileFromGitHub)(example.contract, path.join(outputDir, "contracts", `${contractName}.sol`));
-    // Download contract dependencies if specified
     if (example.dependencies) {
         await downloadDependencies(example.dependencies, outputDir);
     }
-    // Step 3: Download test file
+    // 3. Download test file
     await (0, utils_1.downloadFileFromGitHub)(example.test, path.join(outputDir, "test", path.basename(example.test)));
-    // Step 4: Update deploy script and package.json
+    // 4. Update deploy script and package.json
     fs.writeFileSync(path.join(outputDir, "deploy", "deploy.ts"), (0, utils_1.generateDeployScript)(contractName));
     (0, utils_1.updateProjectPackageJson)(outputDir, `fhevm-example-${exampleName}`, example.description, example.npmDependencies);
-    // Initialize git repository
     await initGitRepo(outputDir);
 }
-// =============================================================================
-// Category Project Builder
-// =============================================================================
 /**
  * Creates a category project with multiple examples
- * @param categoryName - Name of the category to create
- * @param outputDir - Target directory for the project
- * @param tempRepoPath - Path to cloned template repository
  */
 async function createCategoryProject(categoryName, outputDir, tempRepoPath) {
     const category = config_1.CATEGORIES[categoryName];
@@ -123,10 +114,10 @@ async function createCategoryProject(categoryName, outputDir, tempRepoPath) {
         throw new Error(`Unknown category: ${categoryName}`);
     }
     const templateDir = path.join(tempRepoPath, utils_1.TEMPLATE_DIR_NAME);
-    // Step 1: Copy template and clean up
+    // 1. Copy template and clean up
     (0, utils_1.copyDirectoryRecursive)(templateDir, outputDir);
     (0, utils_1.cleanupTemplate)(outputDir);
-    // Step 2: Download all contracts and tests
+    // 2. Download all contracts and tests
     for (const item of category.contracts) {
         const contractName = (0, utils_1.getContractName)(item.sol);
         if (contractName) {
@@ -136,11 +127,16 @@ async function createCategoryProject(categoryName, outputDir, tempRepoPath) {
             await (0, utils_1.downloadFileFromGitHub)(item.test, path.join(outputDir, "test", path.basename(item.test)));
         }
     }
-    // Collect dependencies from all examples in this category
+    // 3. Collect and download dependencies
     const allDependencies = new Set();
     const allNpmDependencies = {};
     for (const [exampleName, exampleConfig] of Object.entries(config_1.EXAMPLES)) {
-        if (exampleConfig.category === category.name.replace(" Examples", "")) {
+        // Check if example belongs to this category
+        const configCategoryLower = exampleConfig.category
+            .toLowerCase()
+            .replace(/\s+/g, "");
+        if (configCategoryLower === categoryName ||
+            exampleConfig.category === category.name.replace(" Examples", "")) {
             if (exampleConfig.dependencies) {
                 exampleConfig.dependencies.forEach((dep) => allDependencies.add(dep));
             }
@@ -149,12 +145,67 @@ async function createCategoryProject(categoryName, outputDir, tempRepoPath) {
             }
         }
     }
-    // Download all collected dependencies
     if (allDependencies.size > 0) {
         await downloadDependencies(Array.from(allDependencies), outputDir);
     }
-    // Step 3: Update package.json
+    // 4. Update package.json
     (0, utils_1.updateProjectPackageJson)(outputDir, `fhevm-examples-${categoryName}`, undefined, allNpmDependencies);
-    // Initialize git repository
     await initGitRepo(outputDir);
 }
+// =============================================================================
+// Specialized Builders
+// =============================================================================
+/**
+ * Creates a temporary test project using LOCAL files (used by maintenance.ts)
+ */
+async function createLocalTestProject(exampleNames, outputDir) {
+    const rootDir = (0, utils_1.getRootDir)();
+    const templateDir = (0, utils_1.getTemplateDir)();
+    // 1. Setup base project from local template
+    (0, utils_1.copyDirectoryRecursive)(templateDir, outputDir);
+    (0, utils_1.cleanupTemplate)(outputDir);
+    const allNpmDeps = {};
+    const allContractDeps = new Set();
+    // 2. Copy local example files
+    for (const exampleName of exampleNames) {
+        const example = config_1.EXAMPLES[exampleName];
+        if (!example)
+            continue;
+        const contractPath = path.join(rootDir, example.contract);
+        const testPath = path.join(rootDir, example.test);
+        if (fs.existsSync(contractPath)) {
+            const contractName = (0, utils_1.getContractName)(example.contract);
+            if (contractName) {
+                fs.copyFileSync(contractPath, path.join(outputDir, "contracts", `${contractName}.sol`));
+            }
+        }
+        if (fs.existsSync(testPath)) {
+            fs.copyFileSync(testPath, path.join(outputDir, "test", path.basename(example.test)));
+        }
+        if (example.dependencies) {
+            example.dependencies.forEach((dep) => allContractDeps.add(dep));
+        }
+        if (example.npmDependencies) {
+            Object.assign(allNpmDeps, example.npmDependencies);
+        }
+    }
+    // 3. Copy dependencies
+    for (const depPath of allContractDeps) {
+        const depFullPath = path.join(rootDir, depPath);
+        if (fs.existsSync(depFullPath)) {
+            const relativePath = depPath.replace(/^contracts\//, "");
+            const depDestPath = path.join(outputDir, "contracts", relativePath);
+            const depDestDir = path.dirname(depDestPath);
+            if (!fs.existsSync(depDestDir)) {
+                fs.mkdirSync(depDestDir, { recursive: true });
+            }
+            fs.copyFileSync(depFullPath, depDestPath);
+        }
+    }
+    // 4. Finalize project
+    (0, utils_1.updateProjectPackageJson)(outputDir, "fhevm-test-project", `Testing ${exampleNames.length} examples`, Object.keys(allNpmDeps).length > 0 ? allNpmDeps : undefined);
+    const typesPath = path.join(outputDir, "test", "types.ts");
+    if (!fs.existsSync(typesPath)) {
+        fs.writeFileSync(typesPath, utils_1.TEST_TYPES_CONTENT);
+    }
+}

package/dist/scripts/doctor.d.ts

@@ -1,3 +1,11 @@
 #!/usr/bin/env node
+/**
+ * FHEVM Doctor - Environment and project integrity validator
+ *
+ * Checks:
+ *   - Node.js version compatibility
+ *   - Git installation
+ *   - Config.ts path integrity (validates all example paths)
+ */
 export {};
 //# sourceMappingURL=doctor.d.ts.map

package/dist/scripts/doctor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"doctor.d.ts","sourceRoot":"","sources":["../../scripts/doctor.ts"],"names":[],"mappings":""}
+{"version":3,"file":"doctor.d.ts","sourceRoot":"","sources":["../../scripts/doctor.ts"],"names":[],"mappings":";AAEA;;;;;;;GAOG"}

package/dist/scripts/doctor.js

@@ -1,5 +1,13 @@
 #!/usr/bin/env node
 "use strict";
+/**
+ * FHEVM Doctor - Environment and project integrity validator
+ *
+ * Checks:
+ *   - Node.js version compatibility
+ *   - Git installation
+ *   - Config.ts path integrity (validates all example paths)
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/dist/scripts/generate-config.d.ts

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 /**
- * Auto-Discovery Config Generator
+ * Auto-Discovery Config Generator - Automatically updates project configuration.
  *
- * Scans contracts/ directory and generates config.ts automatically
- * Extracts metadata from @notice tags and folder structure.
+ * Scans the contracts/ directory and generates scripts/config.ts.
+ * Extracts metadata from @notice tags and infers category structure.
  */
 export {};
 //# sourceMappingURL=generate-config.d.ts.map

package/dist/scripts/generate-config.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
 "use strict";
 /**
- * Auto-Discovery Config Generator
+ * Auto-Discovery Config Generator - Automatically updates project configuration.
  *
- * Scans contracts/ directory and generates config.ts automatically
- * Extracts metadata from @notice tags and folder structure.
+ * Scans the contracts/ directory and generates scripts/config.ts.
+ * Extracts metadata from @notice tags and infers category structure.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -39,10 +39,14 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const utils_1 = require("./utils");
+const picocolors_1 = __importDefault(require("picocolors"));
 const ROOT_DIR = path.resolve(__dirname, "..");
 const CONTRACTS_DIR = path.join(ROOT_DIR, "contracts");
 const TEST_DIR = path.join(ROOT_DIR, "test");
@@ -293,21 +297,25 @@ export function getDocsFileName(exampleName: string): string {
 // Main
 // =============================================================================
 function main() {
-    utils_1.log.info("🔍 Scanning contracts...\n");
+    utils_1.log.info(`🔍 Scanning examples in: ${picocolors_1.default.cyan("contracts/")}\n`);
     const contracts = scanContracts();
-    utils_1.log.success(`✅ Found ${contracts.length} contracts\n`);
+    if (contracts.length === 0) {
+        utils_1.log.error("❌ No valid contracts discovered. Check for @notice tags.");
+        process.exit(1);
+    }
+    utils_1.log.success(`✅ Found ${picocolors_1.default.bold(String(contracts.length))} contracts\n`);
     const categoryCount = {};
     for (const c of contracts) {
         categoryCount[c.category] = (categoryCount[c.category] || 0) + 1;
     }
-    utils_1.log.message("📊 By category:");
+    utils_1.log.message(picocolors_1.default.bold("📊 Discovery Summary:"));
     for (const [category, count] of Object.entries(categoryCount)) {
-        utils_1.log.message(`   ${category}: ${count}`);
+        utils_1.log.message(`   ${picocolors_1.default.dim("•")} ${picocolors_1.default.yellow(category.padEnd(25))} ${picocolors_1.default.cyan(String(count).padStart(2))} examples`);
     }
-    utils_1.log.message("\n📝 Generating config...");
+    utils_1.log.message(`\n📝 Generating: ${picocolors_1.default.cyan(path.relative(ROOT_DIR, OUTPUT_FILE))}...`);
     const configContent = generateConfigFile(contracts);
     fs.writeFileSync(OUTPUT_FILE, configContent);
-    utils_1.log.success(`✅ Config generated: ${path.relative(ROOT_DIR, OUTPUT_FILE)}`);
+    utils_1.log.success(`\n✨ Configuration updated successfully!`);
 }
 const isMainModule = process.argv[1]?.includes("generate-config");
 if (isMainModule) {

package/dist/scripts/generate-docs.d.ts

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
 /**
- * Generate Documentation - GitBook Documentation Generator
+ * Documentation Generator - Creates GitBook-compatible markdown docs.
  *
- * Generates GitBook-compatible markdown documentation for FHEVM examples.
+ * Processes FHEVM examples to produce structured documentation,
+ * including contract descriptions and automated index updates.
  */
 export declare function handleInteractiveDocs(): Promise<void>;
 export declare function handleDirect(args: string[]): Promise<void>;

package/dist/scripts/generate-docs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate-docs.d.ts","sourceRoot":"","sources":["../../scripts/generate-docs.ts"],"names":[],"mappings":";AAEA;;;;GAIG;AAuEH,wBAAsB,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAiE3D;AAMD,wBAAsB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAkBhE"}
+{"version":3,"file":"generate-docs.d.ts","sourceRoot":"","sources":["../../scripts/generate-docs.ts"],"names":[],"mappings":";AAEA;;;;;GAKG;AAuEH,wBAAsB,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAiE3D;AAMD,wBAAsB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAkBhE"}

package/dist/scripts/generate-docs.js

@@ -1,9 +1,10 @@
 #!/usr/bin/env node
 "use strict";
 /**
- * Generate Documentation - GitBook Documentation Generator
+ * Documentation Generator - Creates GitBook-compatible markdown docs.
  *
- * Generates GitBook-compatible markdown documentation for FHEVM examples.
+ * Processes FHEVM examples to produce structured documentation,
+ * including contract descriptions and automated index updates.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;

package/dist/scripts/index.js

@@ -133,10 +133,19 @@ async function getProjectConfig() {
         p.cancel("Operation cancelled.");
         return null;
     }
+    const shouldInstall = await p.confirm({
+        message: "Install dependencies and run tests?",
+        initialValue: false,
+    });
+    if (p.isCancel(shouldInstall)) {
+        p.cancel("Operation cancelled.");
+        return null;
+    }
     return {
         mode: mode,
         name,
         outputDir: outputDir,
+        shouldInstall: shouldInstall,
     };
 }
 /** Scaffolds project and shows completion message */
@@ -165,17 +174,27 @@ async function scaffoldProject(config) {
         p.log.success(`📁 Created: ${picocolors_1.default.cyan(relativePath)}`);
         if (config.mode === "single") {
             const exampleConfig = config_1.EXAMPLES[config.name];
-            p.log.info(`📝 Example: ${picocolors_1.default.yellow(exampleConfig?.title || config.name)}`);
+            if (exampleConfig) {
+                p.log.info(`📝 Example: ${picocolors_1.default.yellow(exampleConfig.title)}`);
+            }
         }
         else {
             const categoryConfig = config_1.CATEGORIES[config.name];
-            p.log.info(`📦 Category: ${picocolors_1.default.yellow(categoryConfig?.name || config.name)}`);
-            p.log.info(`📄 Contracts: ${picocolors_1.default.green(String(categoryConfig?.contracts.length || 0))}`);
+            if (categoryConfig) {
+                p.log.info(`📦 Category: ${picocolors_1.default.yellow(categoryConfig.name)}`);
+                p.log.info(`📄 Contracts: ${picocolors_1.default.green(String(categoryConfig.contracts.length))}`);
+            }
+        }
+        if (config.shouldInstall) {
+            p.log.message("");
+            await (0, ui_1.runInstallAndTest)(resolvedOutput);
+        }
+        else {
+            p.note(`${picocolors_1.default.dim("$")} cd ${relativePath}\n${picocolors_1.default.dim("$")} npm install\n${picocolors_1.default.dim("$")} npm run compile\n${picocolors_1.default.dim("$")} npm run test`, "🚀 Quick Start");
         }
-        await (0, ui_1.askInstallAndTest)(resolvedOutput, relativePath);
     }
     catch (error) {
-        s.stop("Failed to create project");
+        s.stop(picocolors_1.default.red("Failed to create project"));
         p.log.error(error instanceof Error ? error.message : String(error));
         process.exit(1);
     }
@@ -195,54 +214,6 @@ async function runInteractiveMode() {
         return;
     await scaffoldProject(config);
 }
-// =============================================================================
-// QUICK MODE (CLI Arguments)
-// =============================================================================
-function showHelp() {
-    console.log(`
-${picocolors_1.default.bgCyan(picocolors_1.default.black(picocolors_1.default.bold(" 🔐 create-fhevm-example ")))}
-${picocolors_1.default.dim("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")}
-
-${picocolors_1.default.cyan(picocolors_1.default.bold("📋 USAGE"))}
-
-  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")}                  ${picocolors_1.default.dim("→")} Interactive mode ${picocolors_1.default.yellow("(recommended)")}
-  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--example")} ${picocolors_1.default.yellow("<name>")}  ${picocolors_1.default.dim("→")} Create single example
-  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--category")} ${picocolors_1.default.yellow("<name>")} ${picocolors_1.default.dim("→")} Create category project
-  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--add")}               ${picocolors_1.default.dim("→")} Add to existing project
-
-${picocolors_1.default.cyan(picocolors_1.default.bold("⚙️  OPTIONS"))}
-
-  ${picocolors_1.default.green("--example")} ${picocolors_1.default.dim("<name>")}      Create a single example project
-  ${picocolors_1.default.green("--category")} ${picocolors_1.default.dim("<name>")}     Create a category project
-  ${picocolors_1.default.green("--add")}                 Add FHEVM to existing Hardhat project
-  ${picocolors_1.default.green("--target")} ${picocolors_1.default.dim("<dir>")}        Target directory for --add mode
-  ${picocolors_1.default.green("--output")} ${picocolors_1.default.dim("<dir>")}        Output directory
-  ${picocolors_1.default.green("--install")}             Auto-install dependencies
-  ${picocolors_1.default.green("--test")}                Auto-run tests (requires --install)
-  ${picocolors_1.default.green("--help")}${picocolors_1.default.dim(", -h")}            Show this help message
-
-${picocolors_1.default.cyan(picocolors_1.default.bold("⚡ EXAMPLES"))}
-
-  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--example")} ${picocolors_1.default.yellow("fhe-counter")}
-  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--category")} ${picocolors_1.default.yellow("basic")} ${picocolors_1.default.green("--output")} ${picocolors_1.default.blue("./my-project")}
-  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--add")}
-  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--example")} ${picocolors_1.default.yellow("fhe-counter")} ${picocolors_1.default.green("--install")} ${picocolors_1.default.green("--test")}
-
-${picocolors_1.default.cyan(picocolors_1.default.bold("📦 AVAILABLE EXAMPLES"))}
-
-  ${picocolors_1.default.dim(Object.keys(config_1.EXAMPLES).slice(0, 10).join(", "))}
-  ${picocolors_1.default.dim("...")} and ${picocolors_1.default.yellow(String(Object.keys(config_1.EXAMPLES).length - 10))} more
-
-${picocolors_1.default.cyan(picocolors_1.default.bold("📁 AVAILABLE CATEGORIES"))}
-
-  ${Object.keys(config_1.CATEGORIES)
-        .map((c) => picocolors_1.default.yellow(c))
-        .join(", ")}
-
-${picocolors_1.default.dim("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")}
-${picocolors_1.default.dim("📚 Documentation:")} ${picocolors_1.default.blue("https://github.com/NecipAkgz/fhevm-example-factory")}
-`);
-}
 function parseArgs(args) {
     const parsed = {};
     for (let i = 0; i < args.length; i++) {
@@ -313,25 +284,30 @@ async function runDirectMode(args) {
     }
     const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "fhevm-"));
     try {
-        utils_1.log.info(`Creating ${mode}: ${name}`);
+        utils_1.log.info(`\n🚀 Creating ${mode}: ${picocolors_1.default.yellow(name)}`);
+        utils_1.log.dim("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━");
         utils_1.log.dim("Downloading template...");
         const tempRepoPath = await (0, utils_1.cloneTemplate)(tempDir);
         utils_1.log.dim("Initializing submodules...");
         await (0, utils_1.initSubmodule)(tempRepoPath);
-        utils_1.log.dim("Creating project...");
+        utils_1.log.dim("Building project...");
         if (mode === "example") {
             await (0, builders_1.createSingleExample)(name, resolved, tempRepoPath);
         }
         else {
             await (0, builders_1.createCategoryProject)(name, resolved, tempRepoPath);
         }
-        utils_1.log.success(`✓ Created: ${output}`);
+        utils_1.log.success(`\n✨ Successfully created: ${picocolors_1.default.cyan(output)}`);
         if (shouldInstall) {
-            utils_1.log.dim("\nInstalling dependencies...");
+            utils_1.log.dim("Installing dependencies and running tests...");
             await (0, ui_1.runInstallAndTest)(resolved);
         }
         else {
-            utils_1.log.dim(`\nNext: cd ${output} && npm install && npm run compile && npm run test`);
+            utils_1.log.message(picocolors_1.default.dim("\nNext steps:"));
+            utils_1.log.message(`  ${picocolors_1.default.cyan("cd")} ${output}`);
+            utils_1.log.message(`  ${picocolors_1.default.cyan("npm install")}`);
+            utils_1.log.message(`  ${picocolors_1.default.cyan("npm run compile")}`);
+            utils_1.log.message(`  ${picocolors_1.default.cyan("npm run test")}`);
         }
     }
     catch (error) {
@@ -344,6 +320,54 @@ async function runDirectMode(args) {
     }
 }
 // =============================================================================
+// QUICK MODE (CLI Arguments)
+// =============================================================================
+function showHelp() {
+    console.log(`
+${picocolors_1.default.bgCyan(picocolors_1.default.black(picocolors_1.default.bold(" 🔐 create-fhevm-example ")))}
+${picocolors_1.default.dim("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")}
+
+${picocolors_1.default.cyan(picocolors_1.default.bold("📋 USAGE"))}
+
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")}                  ${picocolors_1.default.dim("→")} Interactive mode ${picocolors_1.default.yellow("(recommended)")}
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--example")} ${picocolors_1.default.yellow("<name>")}  ${picocolors_1.default.dim("→")} Create single example
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--category")} ${picocolors_1.default.yellow("<name>")} ${picocolors_1.default.dim("→")} Create category project
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--add")}               ${picocolors_1.default.dim("→")} Add to existing project
+
+${picocolors_1.default.cyan(picocolors_1.default.bold("⚙️  OPTIONS"))}
+
+  ${picocolors_1.default.green("--example")} ${picocolors_1.default.dim("<name>")}      Create a single example project
+  ${picocolors_1.default.green("--category")} ${picocolors_1.default.dim("<name>")}     Create a category project
+  ${picocolors_1.default.green("--add")}                 Add FHEVM to existing Hardhat project
+  ${picocolors_1.default.green("--target")} ${picocolors_1.default.dim("<dir>")}        Target directory for --add mode
+  ${picocolors_1.default.green("--output")} ${picocolors_1.default.dim("<dir>")}        Output directory
+  ${picocolors_1.default.green("--install")}             Auto-install dependencies
+  ${picocolors_1.default.green("--test")}                Auto-run tests (requires --install)
+  ${picocolors_1.default.green("--help")}${picocolors_1.default.dim(", -h")}            Show this help message
+
+${picocolors_1.default.cyan(picocolors_1.default.bold("⚡ EXAMPLES"))}
+
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--example")} ${picocolors_1.default.yellow("fhe-counter")}
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--category")} ${picocolors_1.default.yellow("basic")} ${picocolors_1.default.green("--output")} ${picocolors_1.default.blue("./my-project")}
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--add")}
+  ${picocolors_1.default.dim("$")} ${picocolors_1.default.white("npx create-fhevm-example")} ${picocolors_1.default.green("--example")} ${picocolors_1.default.yellow("fhe-counter")} ${picocolors_1.default.green("--install")} ${picocolors_1.default.green("--test")}
+
+${picocolors_1.default.cyan(picocolors_1.default.bold("📦 AVAILABLE EXAMPLES"))}
+
+  ${picocolors_1.default.dim(Object.keys(config_1.EXAMPLES).slice(0, 10).join(", "))}
+  ${picocolors_1.default.dim("...")} and ${picocolors_1.default.yellow(String(Object.keys(config_1.EXAMPLES).length - 10))} more
+
+${picocolors_1.default.cyan(picocolors_1.default.bold("📁 AVAILABLE CATEGORIES"))}
+
+  ${Object.keys(config_1.CATEGORIES)
+        .map((c) => picocolors_1.default.yellow(c))
+        .join(", ")}
+
+${picocolors_1.default.dim("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━")}
+${picocolors_1.default.dim("📚 Documentation:")} ${picocolors_1.default.blue("https://github.com/NecipAkgz/fhevm-example-factory")}
+`);
+}
+// =============================================================================
 // MAIN ENTRY POINT
 // =============================================================================
 async function main() {

package/dist/scripts/maintenance.d.ts

@@ -1,12 +1,13 @@
 #!/usr/bin/env node
 /**
- * FHEVM Example Factory - Maintenance Tools
+ * Maintenance Tools - Utilities for project maintenance and testing.
  *
- * Test multiple examples efficiently in a single project.
+ * Includes the test-all runner which allows for efficient testing
+ * of multiple examples in a temporary workspace.
  *
  * Usage:
- *   npm run test:all                    # Interactive selection
- *   npm run test:all fhe-counter,fhe-add # Direct CLI
+ *   npm run test:all                      # Interactive selection
+ *   npm run test:all fhe-counter,fhe-add  # Direct CLI
  */
 export declare function testAllExamples(cliExamples?: string[]): Promise<void>;
 //# sourceMappingURL=maintenance.d.ts.map

package/dist/scripts/maintenance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"maintenance.d.ts","sourceRoot":"","sources":["../../scripts/maintenance.ts"],"names":[],"mappings":";AAEA;;;;;;;;GAQG;AA0SH,wBAAsB,eAAe,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAqC3E"}
+{"version":3,"file":"maintenance.d.ts","sourceRoot":"","sources":["../../scripts/maintenance.ts"],"names":[],"mappings":";AAEA;;;;;;;;;GASG;AAwNH,wBAAsB,eAAe,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAqC3E"}

package/dist/scripts/maintenance.js

@@ -1,13 +1,14 @@
 #!/usr/bin/env node
 "use strict";
 /**
- * FHEVM Example Factory - Maintenance Tools
+ * Maintenance Tools - Utilities for project maintenance and testing.
  *
- * Test multiple examples efficiently in a single project.
+ * Includes the test-all runner which allows for efficient testing
+ * of multiple examples in a temporary workspace.
  *
  * Usage:
- *   npm run test:all                    # Interactive selection
- *   npm run test:all fhe-counter,fhe-add # Direct CLI
+ *   npm run test:all                      # Interactive selection
+ *   npm run test:all fhe-counter,fhe-add  # Direct CLI
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -53,57 +54,7 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const config_1 = require("./config");
 const utils_1 = require("./utils");
-// =============================================================================
-// Project Builder
-// =============================================================================
-async function createTestProject(exampleNames, outputDir) {
-    const rootDir = (0, utils_1.getRootDir)();
-    const templateDir = (0, utils_1.getTemplateDir)();
-    (0, utils_1.copyDirectoryRecursive)(templateDir, outputDir);
-    (0, utils_1.cleanupTemplate)(outputDir);
-    const allNpmDeps = {};
-    const allContractDeps = new Set();
-    for (const exampleName of exampleNames) {
-        const example = config_1.EXAMPLES[exampleName];
-        if (!example)
-            continue;
-        const contractPath = path.join(rootDir, example.contract);
-        const testPath = path.join(rootDir, example.test);
-        if (fs.existsSync(contractPath)) {
-            const contractName = (0, utils_1.getContractName)(example.contract);
-            if (contractName) {
-                fs.copyFileSync(contractPath, path.join(outputDir, "contracts", `${contractName}.sol`));
-            }
-        }
-        if (fs.existsSync(testPath)) {
-            fs.copyFileSync(testPath, path.join(outputDir, "test", path.basename(example.test)));
-        }
-        if (example.dependencies) {
-            example.dependencies.forEach((dep) => allContractDeps.add(dep));
-        }
-        if (example.npmDependencies) {
-            Object.assign(allNpmDeps, example.npmDependencies);
-        }
-    }
-    for (const depPath of allContractDeps) {
-        const depFullPath = path.join(rootDir, depPath);
-        if (fs.existsSync(depFullPath)) {
-            const relativePath = depPath.replace(/^contracts\//, "");
-            const depDestPath = path.join(outputDir, "contracts", relativePath);
-            const depDestDir = path.dirname(depDestPath);
-            if (!fs.existsSync(depDestDir)) {
-                fs.mkdirSync(depDestDir, { recursive: true });
-            }
-            fs.copyFileSync(depFullPath, depDestPath);
-        }
-    }
-    // Update package.json using shared utility
-    (0, utils_1.updateProjectPackageJson)(outputDir, "fhevm-test-project", `Testing ${exampleNames.length} examples`, Object.keys(allNpmDeps).length > 0 ? allNpmDeps : undefined);
-    const typesPath = path.join(outputDir, "test", "types.ts");
-    if (!fs.existsSync(typesPath)) {
-        fs.writeFileSync(typesPath, utils_1.TEST_TYPES_CONTENT);
-    }
-}
+const builders_1 = require("./builders");
 // =============================================================================
 // Example Selection
 // =============================================================================
@@ -266,7 +217,7 @@ async function testAllExamples(cliExamples) {
     try {
         const s = p.spinner();
         s.start("Setting up test project...");
-        await createTestProject(examplesToTest, tempDir);
+        await (0, builders_1.createLocalTestProject)(examplesToTest, tempDir);
         s.stop(picocolors_1.default.green("✓ Project ready"));
         summary = await runTestPipeline(tempDir, examplesToTest.length);
     }

package/dist/scripts/ui.d.ts

@@ -1,7 +1,8 @@
 /**
- * User Interface - Prompts & Commands
+ * User Interface - CLI Prompts and Interaction Logic.
  *
- * Interactive prompts and command execution for CLI.
+ * Provides centralized components for user input, selection menus,
+ * and standard command execution feedback for the CLI.
  */
 /**
  * Counts how many examples exist in each category
@@ -23,12 +24,4 @@ export declare function promptSelectCategoryProject(): Promise<string | symbol>;
  * Runs npm install, compile, and test in the project directory
  */
 export declare function runInstallAndTest(projectPath: string): Promise<void>;
-/**
- * Shows quick start commands for the created project
- */
-export declare function showQuickStart(relativePath: string): void;
-/**
- * Asks user if they want to install and test
- */
-export declare function askInstallAndTest(resolvedOutput: string, relativePath: string): Promise<void>;
 //# sourceMappingURL=ui.d.ts.map

package/dist/scripts/ui.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../scripts/ui.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAiBH;;GAEG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAMjE;AAMD;;GAEG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAmBrE;AAED;;GAEG;AACH,wBAAsB,+BAA+B,CACnD,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAe1B;AAED;;GAEG;AACH,wBAAsB,2BAA2B,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAS5E;AAMD;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAiD1E;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAOzD;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CACrC,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,IAAI,CAAC,CAiBf"}
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../scripts/ui.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAiBH;;GAEG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAMjE;AAMD;;GAEG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAmBrE;AAED;;GAEG;AACH,wBAAsB,+BAA+B,CACnD,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAe1B;AAED;;GAEG;AACH,wBAAsB,2BAA2B,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAS5E;AAMD;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAiD1E"}

package/dist/scripts/ui.js

@@ -1,8 +1,9 @@
 "use strict";
 /**
- * User Interface - Prompts & Commands
+ * User Interface - CLI Prompts and Interaction Logic.
  *
- * Interactive prompts and command execution for CLI.
+ * Provides centralized components for user input, selection menus,
+ * and standard command execution feedback for the CLI.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -46,8 +47,6 @@ exports.promptSelectCategory = promptSelectCategory;
 exports.promptSelectExampleFromCategory = promptSelectExampleFromCategory;
 exports.promptSelectCategoryProject = promptSelectCategoryProject;
 exports.runInstallAndTest = runInstallAndTest;
-exports.showQuickStart = showQuickStart;
-exports.askInstallAndTest = askInstallAndTest;
 const p = __importStar(require("@clack/prompts"));
 const picocolors_1 = __importDefault(require("picocolors"));
 const config_1 = require("./config");
@@ -169,29 +168,3 @@ async function runInstallAndTest(projectPath) {
     }
     p.log.success(picocolors_1.default.green("🔐 All encryption tests passed!"));
 }
-/**
- * Shows quick start commands for the created project
- */
-function showQuickStart(relativePath) {
-    p.note(`${picocolors_1.default.dim("$")} cd ${relativePath}\n${picocolors_1.default.dim("$")} npm install\n${picocolors_1.default.dim("$")} npm run compile\n${picocolors_1.default.dim("$")} npm run test`, "🚀 Quick Start");
-}
-/**
- * Asks user if they want to install and test
- */
-async function askInstallAndTest(resolvedOutput, relativePath) {
-    const shouldInstall = await p.confirm({
-        message: "Install dependencies and run tests?",
-        initialValue: false,
-    });
-    if (p.isCancel(shouldInstall)) {
-        showQuickStart(relativePath);
-        return;
-    }
-    if (shouldInstall) {
-        p.log.message("");
-        await runInstallAndTest(resolvedOutput);
-    }
-    else {
-        showQuickStart(relativePath);
-    }
-}

package/dist/scripts/utils.d.ts

@@ -1,5 +1,8 @@
 /**
- * Utility functions for FHEVM Example Factory CLI
+ * Shared Utilities - Helper functions for the FHEVM Example Factory.
+ *
+ * Contains common logic for file system operations, string formatting,
+ * error handling, and terminal logging used throughout the project.
  */
 export type ProjectMode = "single" | "category";
 export declare const CATEGORY_ICON = "\uD83D\uDCC1";
@@ -45,30 +48,22 @@ export declare const log: {
 export declare function handleError(error: unknown, exitCode?: number): never;
 /** Resolves root directory of the project */
 export declare function getRootDir(): string;
+/** Resolves template directory path */
 export declare function getTemplateDir(): string;
-/** Extracts contract name from file path or content */
-export declare function getContractName(contractPathOrContent: string): string | null;
 /** Copies directory recursively, excluding specified directories */
 export declare function copyDirectoryRecursive(source: string, destination: string, excludeDirs?: string[]): void;
 export declare function toKebabCase(str: string): string;
 export declare function contractNameToExampleName(contractName: string): string;
 export declare function contractNameToTitle(contractName: string): string;
 export declare function formatCategoryName(folderName: string): string;
+export declare function getContractName(contractPathOrContent: string): string | null;
 export declare function validateExample(name: string): void;
 export declare function validateCategory(name: string): void;
 export declare function validateDirectoryNotExists(dirPath: string): void;
 export declare function cleanupTemplate(outputDir: string): void;
 export declare function generateDeployScript(contractName: string): string;
 export declare function generateGitBookMarkdown(description: string, contractContent: string, testContent: string, contractName: string, testFileName: string): string;
-/** Downloads a file from GitHub repository */
-export declare function downloadFileFromGitHub(filePath: string, outputPath: string): Promise<void>;
-/** Clones the template repository to temp directory */
-export declare function cloneTemplate(tempDir: string): Promise<string>;
-/** Initializes git submodule for the template */
-export declare function initSubmodule(repoPath: string): Promise<void>;
-/** Updates package.json with project name, description, and npm dependencies */
 export declare function updateProjectPackageJson(outputDir: string, projectName: string, description?: string, npmDependencies?: Record<string, string>): void;
-/** Executes a command and returns output */
 export declare function runCommand(cmd: string, args: string[], cwd: string): Promise<string>;
 export declare function runCommandWithStatus(cmd: string, args: string[], cwd: string): Promise<{
     success: boolean;
@@ -76,4 +71,16 @@ export declare function runCommandWithStatus(cmd: string, args: string[], cwd: s
 }>;
 export declare function extractTestResults(output: string): string | null;
 export declare function extractErrorMessage(output: string): string;
+/**
+ * Downloads a file from GitHub repository
+ */
+export declare function downloadFileFromGitHub(filePath: string, outputPath: string): Promise<void>;
+/**
+ * Clones the template repository to temp directory
+ */
+export declare function cloneTemplate(tempDir: string): Promise<string>;
+/**
+ * Initializes git submodule for the template
+ */
+export declare function initSubmodule(repoPath: string): Promise<void>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/scripts/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../scripts/utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAYH,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;AAEhD,eAAO,MAAM,aAAa,iBAAO,CAAC;AAElC,qDAAqD;AACrD,eAAO,MAAM,iBAAiB,2BAA2B,CAAC;AAE1D,gDAAgD;AAChD,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,mDAAmD;AACnD,eAAO,MAAM,YAAY,UAQxB,CAAC;AAEF,4CAA4C;AAC5C,eAAO,MAAM,kBAAkB;;;;;;;;;CAS9B,CAAC;AAEF,eAAO,MAAM,cAAc,UAQ1B,CAAC;AAEF,eAAO,MAAM,kBAAkB,yPAS9B,CAAC;AAEF,eAAO,MAAM,cAAc;;;4BAGD,MAAM;6BACL,MAAM;uBACZ,MAAM;;;;CAI1B,CAAC;AAMF,eAAO,MAAM,GAAG;mBACC,MAAM;iBACR,MAAM;gBACP,MAAM;eACP,MAAM;mBACF,MAAM;CACtB,CAAC;AAEF;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,SAAI,GAAG,KAAK,CAI/D;AAMD,6CAA6C;AAC7C,wBAAgB,UAAU,IAAI,MAAM,CAEnC;AAED,wBAAgB,cAAc,IAAI,MAAM,CAEvC;AAED,uDAAuD;AACvD,wBAAgB,eAAe,CAAC,qBAAqB,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAqB5E;AAED,oEAAoE;AACpE,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,WAAW,GAAE,MAAM,EAAiB,GACnC,IAAI,CAoBN;AAMD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM/C;AAED,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAEtE;AAED,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAKhE;AAED,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAK7D;AAMD,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAIlD;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAInD;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAIhE;AAMD,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CA4CvD;AAED,wBAAgB,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAqBjE;AAED,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,EACvB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,GACnB,MAAM,CA2BR;AAMD,8CAA8C;AAC9C,wBAAsB,sBAAsB,CAC1C,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAoBf;AAED,uDAAuD;AACvD,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAmCpE;AAED,iDAAiD;AACjD,wBAAsB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA2BnE;AAMD,gFAAgF;AAChF,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,EACpB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACvC,IAAI,CAiBN;AAMD,4CAA4C;AAC5C,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC,CA+BjB;AAED,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CA2B/C;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAchE;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CA4B1D"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../scripts/utils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAYH,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;AAEhD,eAAO,MAAM,aAAa,iBAAO,CAAC;AAElC,qDAAqD;AACrD,eAAO,MAAM,iBAAiB,2BAA2B,CAAC;AAE1D,gDAAgD;AAChD,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,mDAAmD;AACnD,eAAO,MAAM,YAAY,UAQxB,CAAC;AAEF,4CAA4C;AAC5C,eAAO,MAAM,kBAAkB;;;;;;;;;CAS9B,CAAC;AAEF,eAAO,MAAM,cAAc,UAQ1B,CAAC;AAEF,eAAO,MAAM,kBAAkB,yPAS9B,CAAC;AAEF,eAAO,MAAM,cAAc;;;4BAGD,MAAM;6BACL,MAAM;uBACZ,MAAM;;;;CAI1B,CAAC;AAMF,eAAO,MAAM,GAAG;mBACC,MAAM;iBACR,MAAM;gBACP,MAAM;eACP,MAAM;mBACF,MAAM;CACtB,CAAC;AAEF;;GAEG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,SAAI,GAAG,KAAK,CAI/D;AAMD,6CAA6C;AAC7C,wBAAgB,UAAU,IAAI,MAAM,CAEnC;AAED,uCAAuC;AACvC,wBAAgB,cAAc,IAAI,MAAM,CAEvC;AAED,oEAAoE;AACpE,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,WAAW,GAAE,MAAM,EAAiB,GACnC,IAAI,CAoBN;AAMD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAM/C;AAED,wBAAgB,yBAAyB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAEtE;AAED,wBAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAKhE;AAED,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAK7D;AAED,wBAAgB,eAAe,CAAC,qBAAqB,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAqB5E;AAMD,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAIlD;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAInD;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAIhE;AAMD,wBAAgB,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAiDvD;AAED,wBAAgB,oBAAoB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAkCjE;AAED,wBAAgB,uBAAuB,CACrC,WAAW,EAAE,MAAM,EACnB,eAAe,EAAE,MAAM,EACvB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,YAAY,EAAE,MAAM,GACnB,MAAM,CA2BR;AAED,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,EACpB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACvC,IAAI,CAiBN;AAKD,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,CAAC,CA+BjB;AAED,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EAAE,EACd,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CA2B/C;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAchE;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CA4B1D;AAMD;;GAEG;AACH,wBAAsB,sBAAsB,CAC1C,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAoBf;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAmCpE;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA2BnE"}

package/dist/scripts/utils.js

@@ -1,6 +1,9 @@
 "use strict";
 /**
- * Utility functions for FHEVM Example Factory CLI
+ * Shared Utilities - Helper functions for the FHEVM Example Factory.
+ *
+ * Contains common logic for file system operations, string formatting,
+ * error handling, and terminal logging used throughout the project.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
@@ -43,26 +46,26 @@ exports.log = exports.ERROR_MESSAGES = exports.TEST_TYPES_CONTENT = exports.CATE
 exports.handleError = handleError;
 exports.getRootDir = getRootDir;
 exports.getTemplateDir = getTemplateDir;
-exports.getContractName = getContractName;
 exports.copyDirectoryRecursive = copyDirectoryRecursive;
 exports.toKebabCase = toKebabCase;
 exports.contractNameToExampleName = contractNameToExampleName;
 exports.contractNameToTitle = contractNameToTitle;
 exports.formatCategoryName = formatCategoryName;
+exports.getContractName = getContractName;
 exports.validateExample = validateExample;
 exports.validateCategory = validateCategory;
 exports.validateDirectoryNotExists = validateDirectoryNotExists;
 exports.cleanupTemplate = cleanupTemplate;
 exports.generateDeployScript = generateDeployScript;
 exports.generateGitBookMarkdown = generateGitBookMarkdown;
-exports.downloadFileFromGitHub = downloadFileFromGitHub;
-exports.cloneTemplate = cloneTemplate;
-exports.initSubmodule = initSubmodule;
 exports.updateProjectPackageJson = updateProjectPackageJson;
 exports.runCommand = runCommand;
 exports.runCommandWithStatus = runCommandWithStatus;
 exports.extractTestResults = extractTestResults;
 exports.extractErrorMessage = extractErrorMessage;
+exports.downloadFileFromGitHub = downloadFileFromGitHub;
+exports.cloneTemplate = cloneTemplate;
+exports.initSubmodule = initSubmodule;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const child_process_1 = require("child_process");
@@ -148,29 +151,10 @@ function handleError(error, exitCode = 1) {
 function getRootDir() {
     return path.resolve(__dirname, "..");
 }
+/** Resolves template directory path */
 function getTemplateDir() {
     return path.join(getRootDir(), exports.TEMPLATE_DIR_NAME);
 }
-/** Extracts contract name from file path or content */
-function getContractName(contractPathOrContent) {
-    let content;
-    if (contractPathOrContent.includes("contract ") ||
-        contractPathOrContent.includes("pragma solidity")) {
-        content = contractPathOrContent;
-    }
-    else {
-        const fullPath = contractPathOrContent.startsWith("/")
-            ? contractPathOrContent
-            : path.join(getRootDir(), contractPathOrContent);
-        if (!fs.existsSync(fullPath)) {
-            const match = contractPathOrContent.match(/([^/]+)\.sol$/);
-            return match ? match[1] : null;
-        }
-        content = fs.readFileSync(fullPath, "utf-8");
-    }
-    const match = content.match(/^\s*contract\s+(\w+)(?:\s+is\s+|\s*\{)/m);
-    return match ? match[1] : null;
-}
 /** Copies directory recursively, excluding specified directories */
 function copyDirectoryRecursive(source, destination, excludeDirs = exports.EXCLUDE_DIRS) {
     if (!fs.existsSync(destination)) {
@@ -217,6 +201,25 @@ function formatCategoryName(folderName) {
         .replace(/-/g, " ")
         .replace(/\b\w/g, (char) => char.toUpperCase());
 }
+function getContractName(contractPathOrContent) {
+    let content;
+    if (contractPathOrContent.includes("contract ") ||
+        contractPathOrContent.includes("pragma solidity")) {
+        content = contractPathOrContent;
+    }
+    else {
+        const fullPath = contractPathOrContent.startsWith("/")
+            ? contractPathOrContent
+            : path.join(getRootDir(), contractPathOrContent);
+        if (!fs.existsSync(fullPath)) {
+            const match = contractPathOrContent.match(/([^/]+)\.sol$/);
+            return match ? match[1] : null;
+        }
+        content = fs.readFileSync(fullPath, "utf-8");
+    }
+    const match = content.match(/^\s*contract\s+(\w+)(?:\s+is\s+|\s*\{)/m);
+    return match ? match[1] : null;
+}
 // =============================================================================
 // Validation Functions
 // =============================================================================
@@ -236,13 +239,17 @@ function validateDirectoryNotExists(dirPath) {
     }
 }
 // =============================================================================
-// Template Utilities
+// Template & Scaffolding Utilities
 // =============================================================================
 function cleanupTemplate(outputDir) {
     const gitDir = path.join(outputDir, ".git");
     if (fs.existsSync(gitDir)) {
         fs.rmSync(gitDir, { recursive: true, force: true });
     }
+    const githubDir = path.join(outputDir, ".github");
+    if (fs.existsSync(githubDir)) {
+        fs.rmSync(githubDir, { recursive: true, force: true });
+    }
     const templateContract = path.join(outputDir, "contracts", "FHECounter.sol");
     if (fs.existsSync(templateContract)) {
         fs.unlinkSync(templateContract);
@@ -279,13 +286,26 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
   const { deployer } = await hre.getNamedAccounts();
   const { deploy } = hre.deployments;
 
+  console.log("\\n🚀 Deploying ${contractName}...");
+  console.log(\`📍 Network: \${hre.network.name}\`);
+  console.log(\`👤 Deployer: \${deployer}\\n\`);
+
   const deployed = await deploy("${contractName}", {
     from: deployer,
     args: [],
     log: true,
   });
 
-  console.log(\`${contractName} contract deployed at: \${deployed.address}\`);
+  console.log("\\n✅ Deployment Complete!");
+  console.log(\`📄 Contract: ${contractName}\`);
+  console.log(\`📍 Contract Address: \${deployed.address}\`);
+
+  if (deployed.newlyDeployed) {
+    console.log(\`⛽ Gas Used: \${deployed.receipt?.gasUsed}\`);
+  } else {
+    console.log("ℹ️  Contract was already deployed");
+  }
+  console.log("");
 };
 
 export default func;
@@ -315,84 +335,6 @@ function generateGitBookMarkdown(description, contractContent, testContent, cont
     markdown += `{% endtabs %}\n`;
     return markdown;
 }
-// =============================================================================
-// GitHub Repository Utilities
-// =============================================================================
-/** Downloads a file from GitHub repository */
-async function downloadFileFromGitHub(filePath, outputPath) {
-    const urlParts = config_1.REPO_URL.replace("https://github.com/", "").split("/");
-    const owner = urlParts[0];
-    const repo = urlParts[1];
-    const url = `https://raw.githubusercontent.com/${owner}/${repo}/${config_1.REPO_BRANCH}/${filePath}`;
-    const response = await fetch(url);
-    if (!response.ok) {
-        throw new Error(`Failed to download ${filePath}: ${response.statusText}`);
-    }
-    const content = await response.text();
-    const dir = path.dirname(outputPath);
-    if (!fs.existsSync(dir)) {
-        fs.mkdirSync(dir, { recursive: true });
-    }
-    fs.writeFileSync(outputPath, content);
-}
-/** Clones the template repository to temp directory */
-async function cloneTemplate(tempDir) {
-    const templatePath = path.join(tempDir, "template");
-    return new Promise((resolve, reject) => {
-        const cloneUrl = `${config_1.REPO_URL}.git`;
-        const args = [
-            "clone",
-            "--depth=1",
-            "--branch",
-            config_1.REPO_BRANCH,
-            "--single-branch",
-            cloneUrl,
-            templatePath,
-        ];
-        const child = (0, child_process_1.spawn)("git", args, {
-            stdio: "pipe",
-        });
-        let stderr = "";
-        child.stderr?.on("data", (data) => {
-            stderr += data.toString();
-        });
-        child.on("close", (code) => {
-            if (code === 0) {
-                resolve(templatePath);
-            }
-            else {
-                reject(new Error(`Git clone failed: ${stderr}`));
-            }
-        });
-        child.on("error", reject);
-    });
-}
-/** Initializes git submodule for the template */
-async function initSubmodule(repoPath) {
-    return new Promise((resolve, reject) => {
-        const child = (0, child_process_1.spawn)("git", ["submodule", "update", "--init", "--recursive", exports.TEMPLATE_DIR_NAME], {
-            cwd: repoPath,
-            stdio: "pipe",
-        });
-        let stderr = "";
-        child.stderr?.on("data", (data) => {
-            stderr += data.toString();
-        });
-        child.on("close", (code) => {
-            if (code === 0) {
-                resolve();
-            }
-            else {
-                reject(new Error(`Submodule init failed: ${stderr}`));
-            }
-        });
-        child.on("error", reject);
-    });
-}
-// =============================================================================
-// Package.json Utilities
-// =============================================================================
-/** Updates package.json with project name, description, and npm dependencies */
 function updateProjectPackageJson(outputDir, projectName, description, npmDependencies) {
     const packageJsonPath = path.join(outputDir, "package.json");
     const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
@@ -411,7 +353,6 @@ function updateProjectPackageJson(outputDir, projectName, description, npmDepend
 // =============================================================================
 // Command Execution Utilities
 // =============================================================================
-/** Executes a command and returns output */
 function runCommand(cmd, args, cwd) {
     return new Promise((resolve, reject) => {
         const child = (0, child_process_1.spawn)(cmd, args, {
@@ -502,3 +443,83 @@ function extractErrorMessage(output) {
     const nonEmptyLines = lines.filter((l) => l.trim().length > 0);
     return nonEmptyLines.slice(-5).join("\n");
 }
+// =============================================================================
+// GitHub Repository Utilities
+// =============================================================================
+/**
+ * Downloads a file from GitHub repository
+ */
+async function downloadFileFromGitHub(filePath, outputPath) {
+    const urlParts = config_1.REPO_URL.replace("https://github.com/", "").split("/");
+    const owner = urlParts[0];
+    const repo = urlParts[1];
+    const url = `https://raw.githubusercontent.com/${owner}/${repo}/${config_1.REPO_BRANCH}/${filePath}`;
+    const response = await fetch(url);
+    if (!response.ok) {
+        throw new Error(`Failed to download ${filePath}: ${response.statusText}`);
+    }
+    const content = await response.text();
+    const dir = path.dirname(outputPath);
+    if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true });
+    }
+    fs.writeFileSync(outputPath, content);
+}
+/**
+ * Clones the template repository to temp directory
+ */
+async function cloneTemplate(tempDir) {
+    const templatePath = path.join(tempDir, "template");
+    return new Promise((resolve, reject) => {
+        const cloneUrl = `${config_1.REPO_URL}.git`;
+        const args = [
+            "clone",
+            "--depth=1",
+            "--branch",
+            config_1.REPO_BRANCH,
+            "--single-branch",
+            cloneUrl,
+            templatePath,
+        ];
+        const child = (0, child_process_1.spawn)("git", args, {
+            stdio: "pipe",
+        });
+        let stderr = "";
+        child.stderr?.on("data", (data) => {
+            stderr += data.toString();
+        });
+        child.on("close", (code) => {
+            if (code === 0) {
+                resolve(templatePath);
+            }
+            else {
+                reject(new Error(`Git clone failed: ${stderr}`));
+            }
+        });
+        child.on("error", reject);
+    });
+}
+/**
+ * Initializes git submodule for the template
+ */
+async function initSubmodule(repoPath) {
+    return new Promise((resolve, reject) => {
+        const child = (0, child_process_1.spawn)("git", ["submodule", "update", "--init", "--recursive", exports.TEMPLATE_DIR_NAME], {
+            cwd: repoPath,
+            stdio: "pipe",
+        });
+        let stderr = "";
+        child.stderr?.on("data", (data) => {
+            stderr += data.toString();
+        });
+        child.on("close", (code) => {
+            if (code === 0) {
+                resolve();
+            }
+            else {
+                reject(new Error(`Submodule init failed: ${stderr}`));
+            }
+        });
+        child.on("error", reject);
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-fhevm-example",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Create FHEVM example projects with a single command - A comprehensive toolkit for building privacy-preserving smart contracts",
   "bin": {
     "create-fhevm-example": "./dist/scripts/index.js"
@@ -22,6 +22,7 @@
     "help:docs": "npx ts-node scripts/generate-docs.ts --help",
     "help:test": "npx ts-node scripts/maintenance.ts test-all --help",
 
+    "postinstall": "git submodule update --init --recursive",
     "prepublishOnly": "npm run build",
     "prepack": "mv README.md GITHUB_README.md && cp NPM_README.md README.md",
     "postpack": "mv GITHUB_README.md README.md"