create-eth/src/utils/system-validation.ts

Create a Scaffold-ETH-2 app

import chalk from "chalk";
import { execa } from "execa";
import semver from "semver";

const REQUIRED_FOUNDRY_VERSION = "1.4.0";

// Custom error for Foundry validation
class FoundryValidationError extends Error {
  constructor(message: string) {
    super(message);
    this.name = "FoundryValidationError";
  }
}

export const validateFoundry = async () => {
  let versionMatch: RegExpMatchArray | null = null;
  // Check if forge is installed
  try {
    const { stdout: forgeVersion } = await execa("forge", ["--version"]);
    // Extract version from output like "forge Version: 1.4.3-stable"
    versionMatch = forgeVersion.match(/forge Version: (\d+\.\d+\.\d+)/);
    if (!versionMatch) {
      throw new Error();
    }
  } catch {
    const message = ` 
    ${chalk.bold.yellow("Could not parse foundry version.")}
    ${chalk.bold.yellow("Please ensure foundry is properly installed")}
    ${chalk.bold.yellow("Checkout: https://getfoundry.sh")}
       `;
    throw new FoundryValidationError(message);
  }

  // Parse and validate version
  try {
    const version = versionMatch[1];
    if (semver.lt(version, REQUIRED_FOUNDRY_VERSION)) {
      const message = `
 ${chalk.bold.yellow("Foundry version is older than required.")}
 ${chalk.bold.yellow(`Current version: ${version}, required: >= ${REQUIRED_FOUNDRY_VERSION}`)}
 ${chalk.bold.yellow("Please update foundry by running: foundryup")}
 ${chalk.bold.yellow("Checkout: https://getfoundry.sh")}
    `;
      throw new FoundryValidationError(message);
    }
  } catch (error) {
    // Re-throw custom validation errors
    if (error instanceof FoundryValidationError) {
      throw error;
    }
    throw new Error("Unknown error occurred while validating Foundry version");
  }
};

export const checkSystemRequirements = async () => {
  const errors: string[] = [];

  try {
    const { stdout: nodeVersion } = await execa("node", ["--version"]);
    const cleanNodeVersion = nodeVersion.replace("v", "");
    if (semver.lt(cleanNodeVersion, "20.18.3")) {
      errors.push(`Node.js version must be >= 20.18.3. Current version: ${nodeVersion}`);
    }
  } catch {
    errors.push("Node.js is not installed. Please install Node.js >= 20.18.3");
  }

  try {
    const { stdout: yarnVersion } = await execa("yarn", ["--version"]);
    if (semver.lt(yarnVersion, "1.0.0")) {
      errors.push(`Yarn version should be >= 1.0.0. Recommended version is >= 2.0.0. Current version: ${yarnVersion}`);
    }
  } catch {
    errors.push("Yarn is not installed. Please install Yarn >= 1.0.0. Recommended version is >= 2.0.0");
  }

  try {
    await execa("git", ["--version"]);

    try {
      await execa("git", ["config", "user.name"]);
    } catch {
      errors.push("Git user.name is not configured. Please set it using: git config --global user.name 'Your Name'");
    }

    try {
      await execa("git", ["config", "user.email"]);
    } catch {
      errors.push(
        "Git user.email is not configured. Please set it using: git config --global user.email 'your.email@example.com'",
      );
    }
  } catch {
    errors.push("Git is not installed. Please install Git");
  }

  return { errors };
};