Check for required deps (#68)

Author: escottalexander

package.json

@@ -56,6 +56,7 @@
     "merge-packages": "^0.1.6",
     "ncp": "^2.0.0",
     "pkg-install": "1.0.0",
+    "semver": "^7.6.3",
     "terminal-kit": "^3.1.1"
   },
   "packageManager": "[email protected]"

src/actions/setup-challenge.ts

@@ -1,4 +1,5 @@
 import { execa } from "execa";
+import semver, { Range } from 'semver';
 import ncp from "ncp";
 import path from "path";
 import fs from "fs";
@@ -10,6 +11,8 @@ import { BASE_REPO, BASE_BRANCH, BASE_COMMIT } from "../config";
 import { DefaultRenderer, Listr, ListrTaskWrapper, SimpleRenderer } from "listr2";
 import chalk from "chalk";
 
+type RequiredDependency = "node" | "git" | "yarn" | "foundryup";
+
 // Sidestep for ncp issue https://github.com/AvianFlu/ncp/issues/127
 const copy = (source: string, destination: string, options?: ncp.Options) => new Promise((resolve, reject) => {
     ncp(source, destination, options || {}, (err) => {
@@ -57,6 +60,10 @@ export const setupChallenge = async (name: string, installLocation: string) => {
     }
 
     const tasks = new Listr([
+        {
+            title: 'Checking for required dependencies',
+            task: () => checkUserDependencies()
+        },
         {
             title: 'Setting up base repository',
             task: () => setupBaseRepo(targetDir)
@@ -84,11 +91,39 @@ export const setupChallenge = async (name: string, installLocation: string) => {
         console.log(chalk.green("Challenge setup completed successfully."));
         console.log("");
         console.log(chalk.cyan(`Now open this repository in your favorite code editor and look at the readme for instructions: ${targetDir}`));
-    } catch (error) {
-        console.error(chalk.red("An error occurred during challenge setup:"), error);
+    } catch (error: any) {
+        console.error(chalk.red("An error occurred during challenge setup:"), error.message);
+    }
+}
+
+const checkDependencyInstalled = async (name: RequiredDependency) => {
+    try {
+        await execa(name, ["--help"]);
+    } catch(_) {
+        throw new Error(`${name} is required. Please install to continue.`);
     }
 }
 
+const checkDependencyVersion = async (name: RequiredDependency, requiredVersion: string | Range) => {
+    try {
+        const userVersion = (await execa(name, ["--version"])).stdout;
+        if (!semver.satisfies(userVersion, requiredVersion)) {
+            throw new Error(`${name} version requirement of ${requiredVersion} not met. Please update to continue.`);
+        }
+    } catch(_) {
+        throw new Error(`${name} ${requiredVersion} is required. Please install to continue.`);
+    }
+}
+
+export const checkUserDependencies = async () => {
+    await Promise.all([
+        checkDependencyVersion("node", ">=18.17.0"),
+        checkDependencyInstalled("git"),
+        checkDependencyInstalled("yarn"),
+        checkDependencyInstalled("foundryup"),
+    ])
+}
+
 const setupBaseRepo = async (targetDir: string): Promise<void> => {
     await execa("git", ["clone", "--branch", BASE_BRANCH, "--single-branch", BASE_REPO, targetDir]);
     await execa("git", ["checkout", BASE_COMMIT], { cwd: targetDir });

yarn.lock

@@ -1630,6 +1630,7 @@ __metadata:
     pkg-install: 1.0.0
     rollup: 3.21.0
     rollup-plugin-auto-external: 2.0.0
+    semver: ^7.6.3
     terminal-kit: ^3.1.1
     tslib: 2.5.0
     typescript: 5.0.4
@@ -4157,6 +4158,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"semver@npm:^7.6.3":
+  version: 7.6.3
+  resolution: "semver@npm:7.6.3"
+  bin:
+    semver: bin/semver.js
+  checksum: 4110ec5d015c9438f322257b1c51fe30276e5f766a3f64c09edd1d7ea7118ecbc3f379f3b69032bacf13116dc7abc4ad8ce0d7e2bd642e26b0d271b56b61a7d8
+  languageName: node
+  linkType: hard
+
 "set-blocking@npm:^2.0.0":
   version: 2.0.0
   resolution: "set-blocking@npm:2.0.0"