create-fhevm-example 1.3.0 → 1.3.2

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.2",
   "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"
@@ -18,10 +18,11 @@
     "test:all": "npx ts-node scripts/maintenance.ts test-all",
     "generate:config": "npx ts-node scripts/generate-config.ts",
     "doctor": "npx ts-node scripts/doctor.ts",
-    "help:create": "npx ts-node scripts/index.ts --help",
+    "help:create": "LOCAL_DEV=1 npx ts-node scripts/index.ts --help",
     "help:docs": "npx ts-node scripts/generate-docs.ts --help",
     "help:test": "npx ts-node scripts/maintenance.ts test-all --help",
 
+    "prepare": "git submodule update --init --recursive || true",
     "prepublishOnly": "npm run build",
     "prepack": "mv README.md GITHUB_README.md && cp NPM_README.md README.md",
     "postpack": "mv GITHUB_README.md README.md"