feat(cli): add error handling

Author: kguzek

src/cli/index.ts

@@ -13,6 +13,8 @@ import { installGithubActions } from "./install-ga";
 import { installLintStaged } from "./install-lint-staged";
 import { installPrettier } from "./install-prettier";
 
+const REPO_URL = "https://github.com/Solvro/lib-web-solvro-config";
+
 // Types
 interface CliOptions {
   force?: boolean;
@@ -54,9 +56,9 @@ async function main() {
     const warningMessage = `
 ${c.red(c.bold(`⚠️  OSTRZEŻENIE: ${packageManager} nie jest obsługiwany ⚠️`))}
 
-Próbujesz uruchomić ten skrypt z ${c.yellow(packageManager)}'em, ale @solvro/config działa tylko z ${c.yellow("npm'em")}. 
+Próbujesz uruchomić ten skrypt z ${c.yellow(packageManager)}'em, ale @solvro/config obecnie działa tylko z ${c.yellow("npm")}'em.
 
-Support dla innych menedżerów pakietów nie jest planowany - chcemy jednolitego stacku technologicznego dla projektów w naszym kochanym kole Solvro.
+Support dla innych menedżerów pakietów jest planowany w nadchodzących wersjach - zagwiazdkuj i spróbuj ponownie wkrótce!.
 
 Użyj zamiast tego npm'a:
 ${c.cyan("npx @solvro/config")}`;
@@ -249,18 +251,33 @@ ${c.cyan("npx @solvro/config")}`;
 
   await packageJson.clearInstall();
 
-  if (isNonInteractive) {
-    console.log("✅ Konfiguracja zakończona pomyślnie!");
-  } else {
-    p.outro("✅ Konfiguracja zakończona pomyślnie!");
-  }
+  const printSuccess = isNonInteractive ? console.info : p.outro;
+  printSuccess("✅ Konfiguracja zakończona pomyślnie!");
 }
 
-// Run the main function
-try {
-  // eslint-disable-next-line unicorn/prefer-top-level-await
-  void main();
-} catch (error: unknown) {
-  console.error("Wystąpił błąd:", error);
-  process.exit(1);
+async function mainWrapper() {
+  try {
+    await main();
+  } catch (error: unknown) {
+    if (process.env.NODE_ENV === "development") {
+      console.error(
+        c.red("Unhandled error in main:"),
+        error instanceof Error ? error.message : error,
+      );
+    } else {
+      const errorMessage =
+        "Wystąpił nieoczekiwany błąd :( Proszę zgłosić go twórcom:";
+      const errorLink = `${REPO_URL}/issues/new`;
+      if (isNonInteractive) {
+        console.error(errorMessage);
+        console.error(errorLink);
+      } else {
+        p.cancel(`${errorMessage} ${errorLink}`);
+      }
+    }
+    process.exit(1);
+  }
 }
+
+// eslint-disable-next-line unicorn/prefer-top-level-await
+void mainWrapper();

src/eslint/configs/comments.ts

@@ -7,7 +7,6 @@ export function comments(): ConfigWithExtends[] {
     {
       name: "solvro/eslint-comments/rules",
       plugins: {
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
         "eslint-comments": pluginComments,
       },
       rules: {

src/utils/package-json.ts

@@ -7,7 +7,7 @@ import semver from "semver";
 
 import { $$ } from "./$$";
 import { projectRoot } from "./git-root";
-import { runIfInteractive } from "./run-if-interactive";
+import { runWithSpinner } from "./run-with-spinner";
 
 export class PackageJson {
   public json: Awaited<ReturnType<typeof loadPackageJSON>> = null;
@@ -121,14 +121,13 @@ export class PackageJson {
     const isInstalled = await this.hasPackage(package_);
 
     if (!isInstalled) {
-      const spinner = p.spinner();
-      runIfInteractive(() => {
-        spinner.start(`Instalowanie ${package_}`);
-      });
-
-      await $$`npm i ${options?.dev === true ? "-D" : ""} ${package_}@latest`;
-      runIfInteractive(() => {
-        spinner.stop(`${package_} zainstalowany 😍`);
+      await runWithSpinner({
+        start: `Instalowanie ${package_}`,
+        stop: `${package_} zainstalowany 😍`,
+        error: `Instalacja pakietu ${package_} nie powiodła się 🥶`,
+        callback: async () => {
+          await $$`npm i ${options?.dev === true ? "-D" : ""} ${package_}@latest`;
+        },
       });
 
       await this.load();
@@ -144,13 +143,13 @@ export class PackageJson {
         !semver.satisfies(info.version, options.minVersion)) ||
       options?.alwaysUpdate === true
     ) {
-      const spinner = p.spinner();
-      runIfInteractive(() => {
-        spinner.start(`Aktualizowanie ${package_}`);
-      });
-      await $$`npm i ${options.dev === true ? "-D" : ""} ${package_}@latest`;
-      runIfInteractive(() => {
-        spinner.stop(`${package_} zaktualizowany 😍`);
+      await runWithSpinner({
+        start: `Aktualizowanie ${package_}`,
+        stop: `${package_} zaktualizowany 😍`,
+        error: `Aktualiacja pakietu ${package_} nie powiodła się 🥶`,
+        callback: async () => {
+          await $$`npm i ${options.dev === true ? "-D" : ""} ${package_}@latest`;
+        },
       });
 
       await this.load();

src/utils/run-with-spinner.ts

@@ -0,0 +1,27 @@
+import * as p from "@clack/prompts";
+
+import { runIfInteractive } from "./run-if-interactive";
+
+/** Executes a callback using a clack spinner, printing the provided messages, with error handling. */
+export const runWithSpinner = async (options: {
+  start: string;
+  stop: string;
+  error: string;
+  callback: () => void | Promise<void>;
+}) => {
+  const spinner = p.spinner();
+  runIfInteractive(() => {
+    spinner.start(options.start);
+  });
+  try {
+    await options.callback();
+  } catch (error) {
+    runIfInteractive(() => {
+      spinner.error(options.error);
+    });
+    throw error;
+  }
+  runIfInteractive(() => {
+    spinner.stop(options.stop);
+  });
+};