STCLI-240 thoroughly log errors (#340)

Log errors before throwing a simplified message. This detail facilitates
debugging while still providing a user-friendly error message.

Refs STCLI-240

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## 3.1.0 IN PROGRESS
 
+* Log additional error details. Refs STCLI-240.
+
 ## [3.0.0](https://github.com/folio-org/stripes-cli/tree/v3.0.0) (2023-10-11)
 [Full Changelog](https://github.com/folio-org/stripes-cli/compare/v2.7.0...v3.0.0)
 

lib/cli/context.js

@@ -41,6 +41,7 @@ function loadXml(filePath) {
     const data = fs.readFileSync(filePath, 'utf-8');
     xml = (new XMLParser()).parse(data);
   } catch (err) {
+    console.error('Something went wrong reading or parsing the XML file.');
     console.log(err);
   }
   return xml;

lib/cli/global-dirs.js

@@ -10,7 +10,7 @@ function isYarnVersion(version) {
     logger.log('Yarn version', yarnVersion);
     return semver.satisfies(yarnVersion, version);
   } catch (err) {
-    logger.log('Unable to determine Yarn version.', err);
+    logger.error('Unable to determine Yarn version.', err);
     return false;
   }
 }

lib/cli/stripes-config-middleware.js

@@ -10,6 +10,7 @@ function loadStripesConfig(stripesConfigFile) {
   try {
     config = require(path.resolve(stripesConfigFile)); // eslint-disable-line
   } catch (err) {
+    console.error(err);
     throw new StripesCliError(`Unable to load ${stripesConfigFile}`);
   }
   return config;

lib/commands/mod/install.js

@@ -31,6 +31,7 @@ function installModulesCommand(argv) {
       try {
         console.log(JSON.stringify(response, null, 2));
       } catch (err) {
+        console.error(err);
         console.log(response);
       }
     })

lib/commands/translate/compile.js

@@ -27,7 +27,7 @@ const createOutDir = (outDir) => {
       fs.mkdirSync(outDir);
     } catch (err) {
       console.error(`Could not create the output directory ${outDir}`);
-      console.error(err);
+      console.info(err);
       process.exit(1);
     }
   }

lib/create-app.js

@@ -109,7 +109,8 @@ async function createApp(appName, appDescription) {
     results.forEach(result => updateTemplate(result, args));
     console.log('App created successfully');
   } catch (err) {
-    console.log(err.stack);
+    console.error('Something went wrong while creating the app.');
+    console.info(err);
   }
 
   return args;

lib/stripes-cli.js

@@ -49,7 +49,7 @@ try {
     .parse();
 } catch (err) {
   if (err instanceof AliasError) {
-    console.log(`Alias Error: ${err.message}`);
+    console.error(`Alias Error: ${err.message}`);
   } else {
     throw err;
   }

lib/test/setup-bigtest.js

@@ -30,7 +30,8 @@ async function setupBigTest() {
     fs.removeSync(localTemp);
     console.log('BigTest setup successfully');
   }).catch((err) => {
-    console.log(err.stack);
+    console.error('Error setting up BigTest');
+    console.info(err);
   });
 }