fix: update error message when installing dependencies fails

affects: @medly/create-app, @medly/create-module, @medly/starter-shared

Author: gmukul01

.gitignore

@@ -2,6 +2,7 @@ node_modules/
 coverage/
 *.log
 packages/**/dist
+packages/**/node_modules
 .DS_Store
 .out/
 .idea

packages/app/bin/index.js

@@ -8,10 +8,17 @@ const { execSync } = require('child_process');
 const questions = require('./questions');
 const { Option } = require('commander');
 const commander = require('commander');
-const { addProjectDetails, installDependencies, printMedly, updateHuskyCommands, printGenericError } = require('@medly/starter-shared');
+const {
+    addProjectDetails,
+    installDependencies,
+    printMedly,
+    updateHuskyCommands,
+    printGenericError,
+    removeProjectFolder
+} = require('@medly/starter-shared');
 
 async function init() {
-    let cmdProjectName;
+    let cmdProjectName, folderName;
 
     try {
         printMedly();
@@ -35,6 +42,8 @@ async function init() {
             options = await questions({ ...commanderOptions, projectName: cmdProjectName }),
             { packageManager, projectName } = options;
 
+        folderName = projectName;
+
         // Create project directory
         const projectRoot = path.resolve(projectName);
         fs.ensureDirSync(projectName);
@@ -73,6 +82,7 @@ async function init() {
         ]);
     } catch (error) {
         printGenericError(error);
+        removeProjectFolder(folderName);
     }
 }
 

packages/module/bin/index.js

@@ -9,10 +9,10 @@ const commander = require('commander');
 const { Option } = require('commander');
 const questions = require('./questions');
 const copyTemplateFiles = require('./copyTemplateFiles');
-const { addProjectDetails, installDependencies, printMedly, printGenericError } = require('@medly/starter-shared');
+const { addProjectDetails, installDependencies, printMedly, printGenericError, removeProjectFolder } = require('@medly/starter-shared');
 
 async function init() {
-    let cmdProjectName;
+    let cmdProjectName, folderName;
 
     try {
         printMedly();
@@ -43,6 +43,8 @@ async function init() {
             options = await questions({ ...commanderOptions, projectName: cmdProjectName }),
             { registry, packageManager, projectName } = options;
 
+        folderName = projectName;
+
         // Create project directory
         const projectRoot = path.resolve(projectName);
         fs.ensureDirSync(projectName);
@@ -80,6 +82,7 @@ async function init() {
             console.log('\nAdd ' + chalk.green('NPM_TOKEN') + ' as secret in github repo to publish the package.');
     } catch (error) {
         printGenericError(error);
+        removeProjectFolder(folderName);
     }
 }
 

packages/shared/src/installDependencies.js

@@ -2,7 +2,6 @@ const { execSync, spawnSync } = require('child_process');
 const chalk = require('chalk');
 const fs = require('fs-extra');
 const path = require('path');
-const removeProjectFolder = require('./removeProjectFolder');
 
 module.exports = packageManager => {
     let package = fs.readJSONSync(path.resolve('package.json'));
@@ -31,20 +30,29 @@ module.exports = packageManager => {
     }
     try {
         const param =
-            packageManager === 'yarn' ? ['add', '--prefer-offline', '--silent'] : packageManager === 'npm' ? ['install'] : ['add'];
-        dependencies.length > 0 &&
+            packageManager === 'yarn'
+                ? ['add', '--prefer-offline', '--silent']
+                : packageManager === 'npm'
+                ? ['install', '--legacy-peer-deps']
+                : ['add'];
+        dependencies?.length > 0 &&
             spawnSync(packageManager, [...param, ...dependencies], {
                 stdio: 'inherit'
             });
-        devDependencies.length > 0 && spawnSync(packageManager, [...param, '-D', ...devDependencies], { stdio: 'inherit' });
-    } catch {
-        removeProjectFolder();
-        packageManager === 'yarn' &&
-            console.log('\n 🛠️ If there is any cache issue, you can try running -> ', chalk.green('yarn cache clean'));
+        devDependencies?.length > 0 && spawnSync(packageManager, [...param, '-D', ...devDependencies], { stdio: 'inherit' });
+    } catch (error) {
+        console.log(chalk.red('\nInstalling dependency failed with error: \n'));
+        console.log(chalk.red(error));
+
+        console.log('\n🛠️ ' + '  Possible resolution \n');
+
+        packageManager === 'yarn' && console.log('If there is any cache issue, you can try running -> ', chalk.green('yarn cache clean'));
         packageManager === 'npm' &&
             console.log(
-                '\n 🛠️ If there is any peer dependency error, you can try running -> ',
+                'If there is any peer dependency error, you can try running -> ',
                 chalk.green('npm config set legacy-peer-deps true')
             );
+
+        throw new Error();
     }
 };

packages/shared/src/printGenericError.js

@@ -1,12 +1,9 @@
 const chalk = require('chalk');
-const removeProjectFolder = require('./removeProjectFolder');
 
 module.exports = error => {
-    removeProjectFolder();
     console.log(
-        chalk.red('\n\nSomething went wrong.\n\n') +
-            'Please help us in improving the package by raising the bug with error stack' +
-            chalk.blue('\n\nhttps://github.com/medly/starter/issues')
+        '\nPlease help us in improving the package by raising the bug with the screenshot of the error on this link --> ' +
+            chalk.blue(' https://github.com/medly/starter/issues')
     );
-    console.log('\nError:\n\n' + chalk.red(error));
+    error && error.toString() !== 'Error' && console.log('\n' + chalk.red(error) + '\n');
 };