Frosty/excluded files (#280)

* feat(excludedfiles): added guessParserOptions to scully.config

Added ability to pass guessParserOptions to scully.config. Currently only supports excludedFiles so
that you can remove files from guessParsers scan for routes. Also added some tests around
extraRoutes, excludedFiles, and moved and improved the transferState tests.

* fix(excludedfiles): fixed path for sampleBlog

* Fix the docs for guessParserOptions

Author: aaronfrost

cypress/videos/sampleBlog.spec.js.mp4

@@ -39,6 +39,7 @@ export interface ScullyConfig {
   puppeteerLaunchOptions?: LaunchOptions;
   hostName?: string;
   hostUrl?: string;
+  guessParserOptions?: {excludedFiles: string[]};
 }
 ```
 
@@ -139,4 +140,9 @@ use a different name as `localhost` for the local server. Needed if doe to envir
 
 Connect to a other server. If your app has special demands to host it, you might need to use your own server. When that is needed you can provide this setting to let scully know where to look for your running app. Make sure the server is up and running, and hosting the correct application.
 
+### guessParserOptions
+
+These are the `guessParserOptions` that get passed to the `guess-parser` library. Currently the only property supported
+`excludedFiles`, which allows you to exclude files from the `guess-parser` route discovery process.
+
 [Full Documentation ➡️](scully.md)

docs/scully-configuration.md

@@ -5,7 +5,7 @@
     "ng": "ng",
     "test": "jest",
     "test:watch": "jest --watch",
-    "e2e": "cypress run --spec 'cypress/integration/**/*' --browser chrome interactive",
+    "e2e": "cypress run --spec 'cypress/integration/**/*' --browser chrome",
     "tsc": "tsc",
     "generate": "tsc -p  ./scully/tsconfig.scully.json && node ./scully/bin",
     "scully:dev:watch": "tsc -w -p ./scully/tsconfig.scully.json",

package.json

@@ -6,6 +6,7 @@ const routes: Routes = [
     path: 'about',
     loadChildren: () => import('./about/about.module').then(m => m.AboutModule),
   },
+  {path: '', redirectTo: '/home', pathMatch: 'full'},
   {
     path: 'home',
     loadChildren: () => import('./static/static.module').then(m => m.StaticModule),
@@ -19,12 +20,11 @@ const routes: Routes = [
     loadChildren: () => import('./user/user.module').then(m => m.UserModule),
   },
   {path: 'demo', loadChildren: () => import('./demo/demo.module').then(m => m.DemoModule)},
-  {path: '', redirectTo: '/home', pathMatch: 'full'},
+  {path: 'exclude', loadChildren: () => import('./exclude/exclude.module').then(m => m.ExcludeModule)},
   {
     path: '**',
     loadChildren: () => import('./pagenotfound/pagenotfound.module').then(m => m.PagenotfoundModule),
   },
-  {path: '', redirectTo: 'home', pathMatch: 'full'},
 ];
 
 @NgModule({

projects/sampleBlog/src/app/app-routing.module.ts

@@ -0,0 +1,15 @@
+import {NgModule} from '@angular/core';
+import {Routes, RouterModule} from '@angular/router';
+
+import {ExcludeComponent} from './exclude.component';
+
+const routes: Routes = [
+  {path: 'present', component: ExcludeComponent},
+  {path: 'notpresent', component: ExcludeComponent},
+];
+
+@NgModule({
+  imports: [RouterModule.forChild(routes)],
+  exports: [RouterModule],
+})
+export class ExcludeRoutingModule {}

projects/sampleBlog/src/app/exclude/exclude-routing.module.ts

@@ -0,0 +1,24 @@
+import {async, ComponentFixture, TestBed} from '@angular/core/testing';
+
+import {ExcludeComponent} from './exclude.component';
+
+describe('ExcludeComponent', () => {
+  let component: ExcludeComponent;
+  let fixture: ComponentFixture<ExcludeComponent>;
+
+  beforeEach(async(() => {
+    TestBed.configureTestingModule({
+      declarations: [ExcludeComponent],
+    }).compileComponents();
+  }));
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(ExcludeComponent);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});

projects/sampleBlog/src/app/exclude/exclude.component.spec.ts

@@ -0,0 +1,14 @@
+import {Component, OnInit} from '@angular/core';
+
+@Component({
+  selector: 'app-exclude',
+  template: `
+    <p>exclude works!</p>
+  `,
+  styles: [``],
+})
+export class ExcludeComponent implements OnInit {
+  constructor() {}
+
+  ngOnInit() {}
+}

projects/sampleBlog/src/app/exclude/exclude.component.ts

@@ -0,0 +1,11 @@
+import {NgModule} from '@angular/core';
+import {CommonModule} from '@angular/common';
+
+import {ExcludeRoutingModule} from './exclude-routing.module';
+import {ExcludeComponent} from './exclude.component';
+
+@NgModule({
+  declarations: [ExcludeComponent],
+  imports: [CommonModule, ExcludeRoutingModule],
+})
+export class ExcludeModule {}

projects/sampleBlog/src/app/exclude/exclude.module.ts

@@ -1,3 +1,4 @@
+const {join} = require('path');
 /** load the plugin  */
 require('./extraPlugin/extra-plugin.js');
 require('./extraPlugin/tocPlugin');
@@ -7,8 +8,8 @@ exports.config = {
   /** outDir is where the static distribution files end up */
   outDir: './dist/static',
   // hostName: '0.0.0.0',
-  hostUrl: 'http://localHost:5000',
-  extraRoutes: [''],
+  // hostUrl: 'http://localHost:5000',
+  extraRoutes: ['/exclude/present'],
   routes: {
     '/demo/:id': {
       type: 'extra',
@@ -71,4 +72,7 @@ exports.config = {
       type: 'ignored',
     },
   },
+  guessParserOptions: {
+    excludedFiles: ['projects/sampleBlog/src/app/exclude/exclude-routing.module.ts'],
+  },
 };

scully.sampleBlog.config.js

@@ -1,7 +1,7 @@
 import {parseAngularRoutes} from 'guess-parser';
 import {join} from 'path';
 import * as yargs from 'yargs';
-import {scullyConfig} from '../utils/config';
+import {scullyConfig, loadConfig} from '../utils/config';
 import {existFolder} from '../utils/fsFolder';
 import {green, logError, logWarn, yellow} from '../utils/log';
 
@@ -13,6 +13,10 @@ const {sge} = yargs
 export const traverseAppRoutes = async (appRootFolder = scullyConfig.projectRoot) => {
   const extraRoutes = await addExtraRoutes();
   let routes = [];
+  const excludedFiles =
+    scullyConfig.guessParserOptions && scullyConfig.guessParserOptions.excludedFiles
+      ? scullyConfig.guessParserOptions.excludedFiles
+      : [];
   try {
     const file = join(appRootFolder, 'tsconfig.app.json');
     if (!existFolder(file)) {
@@ -21,9 +25,9 @@ export const traverseAppRoutes = async (appRootFolder = scullyConfig.projectRoot
           file
         )}". Using the apps source folder as source. This might lead to unpredictable results`
       );
-      routes = parseAngularRoutes(appRootFolder).map(r => r.path);
+      routes = parseAngularRoutes(appRootFolder, excludedFiles).map(r => r.path);
     } else {
-      routes = parseAngularRoutes(file).map(r => r.path);
+      routes = parseAngularRoutes(file, excludedFiles).map(r => r.path);
     }
   } catch (e) {
     if (sge) {