Check missing dependencies before run CLI command (#776)

This PR adds a new dependency check before running scripts in the `codama run` CLI command. In other words, it'll check that all external dependencies about to be imported from a script are all installed before running these scripts. When some dependencies are missing, it'll prompt the user to install them.

Author: lorisleiva

.changeset/cold-colts-agree.md

@@ -0,0 +1,5 @@
+---
+'@codama/cli': minor
+---
+
+Check missing dependencies before `run` CLI commands

packages/cli/src/commands/run.ts

@@ -5,7 +5,15 @@ import pico from 'picocolors';
 
 import { ScriptName } from '../config';
 import { getParsedConfigFromCommand, ParsedConfig } from '../parsedConfig';
-import { CliError, getRootNodeVisitors, logInfo, logSuccess, logWarning } from '../utils';
+import {
+    CliError,
+    getRootNodeVisitors,
+    installMissingDependencies,
+    isLocalModulePath,
+    logInfo,
+    logSuccess,
+    logWarning,
+} from '../utils';
 
 export function setRunCommand(program: Command): void {
     program
@@ -43,18 +51,8 @@ async function getPlans(
         throw new CliError('There are no scripts or before visitors to run.');
     }
 
-    const missingScripts = scripts.filter(script => !parsedConfig.scripts[script]);
-    if (missingScripts.length > 0) {
-        const scriptPluralized = missingScripts.length === 1 ? 'Script' : 'Scripts';
-        const message = parsedConfig.configPath
-            ? `${scriptPluralized} not found in configuration file.`
-            : `${scriptPluralized} not found because no configuration file was found.`;
-        const items = [
-            `${pico.bold(scriptPluralized)}: ${missingScripts.join(', ')}`,
-            ...(parsedConfig.configPath ? [`${pico.bold('Path')}: ${parsedConfig.configPath}`] : []),
-        ];
-        throw new CliError(message, items);
-    }
+    checkMissingScripts(parsedConfig, scripts);
+    await checkMissingDependencies(parsedConfig, scripts);
 
     if (parsedConfig.before.length > 0) {
         plans.push({ script: null, visitors: await getRootNodeVisitors(parsedConfig.before) });
@@ -87,3 +85,37 @@ function runPlan(plan: RunPlan, rootNode: RootNode): RootNode {
     logSuccess(`Executed ${identifier}!`);
     return newRoot;
 }
+
+function checkMissingScripts(parsedConfig: Pick<ParsedConfig, 'configPath' | 'scripts'>, scripts: ScriptName[]) {
+    const missingScripts = scripts.filter(script => !parsedConfig.scripts[script]);
+    if (missingScripts.length === 0) return;
+
+    const scriptPluralized = missingScripts.length === 1 ? 'Script' : 'Scripts';
+    const message = parsedConfig.configPath
+        ? `${scriptPluralized} not found in configuration file.`
+        : `${scriptPluralized} not found because no configuration file was found.`;
+    const items = [
+        `${pico.bold(scriptPluralized)}: ${missingScripts.join(', ')}`,
+        ...(parsedConfig.configPath ? [`${pico.bold('Path')}: ${parsedConfig.configPath}`] : []),
+    ];
+    throw new CliError(message, items);
+}
+
+async function checkMissingDependencies(
+    parsedConfig: Pick<ParsedConfig, 'before' | 'configPath' | 'scripts'>,
+    scripts: ScriptName[],
+) {
+    const dependencies = new Set<string>([
+        ...parsedConfig.before.map(v => v.path),
+        ...scripts.flatMap(script => parsedConfig.scripts[script]?.map(v => v.path) ?? []),
+    ]);
+    const externalDependencies = [...dependencies].filter(dep => !isLocalModulePath(dep));
+    const scriptsRequirePluralized = scripts.length === 1 ? 'script requires' : 'scripts require';
+    const installed = await installMissingDependencies(
+        `Your ${scriptsRequirePluralized} additional dependencies.`,
+        externalDependencies,
+    );
+    if (!installed) {
+        throw new CliError('Cannot proceed without missing dependencies.');
+    }
+}