Sander/guess error handling (#173)

* improvement(treaverseapproutes): more explainatory error

update the error to list common casues, and exit the proccess

* improvement(contentrenderplugin.ts): better error on missin httpClienmodule or scully-content

* feat(contentrenderplugin): update other error display too

* fix(traverserouteplugin): fix wrong import

Author: SanderElias

scully/renderPlugins/contentRenderPlugin.ts

@@ -18,7 +18,11 @@ export async function contentRenderPlugin(html: string, route: HandledRoute) {
     const additionalHTML = await handleFile(extension, fileContent);
     return insertContent(scullyBegin, scullyEnd, html, additionalHTML, getScript());
   } catch (e) {
-    logError(`Error during content generation for ${yellow(file)}`, e);
+    logWarn(
+      `Error, probably missing "${yellow('<scully-conent>')}" or "${yellow('httpClientModule')}" for ${yellow(
+        file
+      )}`
+    );
   }
 }
 
@@ -28,9 +32,10 @@ function insertContent(startTag: string, endTag: string, html: string, insertTex
     const [takeout, endText] = rest.split(endTag);
     return [openingText, startTag, insertText, endTag, ...extras, endText].join('');
   } catch (e) {}
-  logWarn(html);
+  logWarn(`missing "${yellow('<scully-conent>')}" or "${yellow('httpClientModule')}"`);
   return `<h1>Scully could not find the &lt.scully-content&gt. tag in this page.</h1>
-  <p>Are you sure you inserted the mandatory "scully-content" in the component that is rendering this page?</p>
+  <p>This error can happen when you forgot to put the  mandatory "scully-content" in the component that is rendering this page?</p>
+  <p>It may also occur if the 'httpClientModule' is not load in your app.module</p>
   `;
 }
 

scully/routerPlugins/traverseAppRoutesPlugin.ts

@@ -1,13 +1,21 @@
 import {parseAngularRoutes} from 'guess-parser';
 import {scullyConfig} from '../utils/config';
+import {logError} from '../utils/log';
 
 export const traverseAppRoutes = async (appRootFolder = scullyConfig.projectRoot) => {
   try {
     const routes = parseAngularRoutes(appRootFolder).map(r => r.path);
 
     return routes;
   } catch (e) {
-    console.log('e', e);
+    // console.log('e', e);
     throw new Error('Scully could not traverse routes');
+    logError(`
+We encountered a problem while reading the routes from your applications source.
+This might happen when there are lazy-loaded routes, that are not loaded,
+Or when there are paths we can not resolve statically.
+Check the routes in your app, rebuild and retry.
+`);
+    process.exit(15);
   }
 };