Allowing for redirects to be declared. (#217)

* Allowing for redirects to be declared.

* Fixed linting error

* Fixed linting error x2

Author: Bobby Earl

lib/sky-pages-route-generator.js

@@ -100,6 +100,19 @@ function parseFileIntoEntity(skyAppConfig, file, index) {
   };
 }
 
+function generateRedirects(skyAppConfig) {
+  let redirects = [];
+  if (skyAppConfig.skyux && skyAppConfig.skyux.redirects) {
+    redirects = Object.keys(skyAppConfig.skyux.redirects).map(key =>
+`{
+  path: '${key}',
+  redirectTo: '${skyAppConfig.skyux.redirects[key]}'
+}`);
+  }
+
+  return redirects;
+}
+
 function generateRoutes(skyAppConfig) {
   let counter = 0;
   let entities = glob
@@ -231,7 +244,7 @@ function mergeRoutes(routes) {
   return uniqueRoutes;
 }
 
-function generateDeclarations(routes) {
+function generateDeclarations(skyAppConfig, routes) {
   let mappedRoutes = mergeRoutes(routes.map(r => parseRoute(r)));
 
   // nest all routes under a top-level route to allow for app-wide guard
@@ -253,8 +266,10 @@ function generateDeclarations(routes) {
 
   // reset root route path to ''
   rootRoute.routePath = '';
-  const declarations = baseRoutes
-    .map(r => generateRouteDeclaration(r))
+
+  // Redirects need to be before '**' catch all
+  let declarations = generateRedirects(skyAppConfig)
+    .concat(baseRoutes.map(r => generateRouteDeclaration(r)))
     .join(',\n');
 
   return `[\n${declarations}\n]`;
@@ -289,7 +304,7 @@ function getRoutesForConfig(routes) {
 function getRoutes(skyAppConfig) {
   const routes = generateRoutes(skyAppConfig);
   return {
-    declarations: generateDeclarations(routes),
+    declarations: generateDeclarations(skyAppConfig, routes),
     definitions: generateDefinitions(routes),
     imports: generateRuntimeImports(skyAppConfig, routes),
     providers: generateProviders(routes),

test/sky-pages-route-generator.spec.js

@@ -297,4 +297,29 @@ describe('SKY UX Builder route generator', () => {
     });
     expect(routes.definitions).toContain('public config: SkyAppConfig');
   });
+
+  it('should prepend any redirects to the route declarations', () => {
+    spyOn(glob, 'sync').and.returnValue(['custom/nested/index.html']);
+    spyOn(path, 'join').and.returnValue('');
+    spyOn(fs, 'readFileSync').and.returnValue('');
+
+    const routes = generator.getRoutes({
+      runtime: {
+        srcPath: ''
+      },
+      skyux: {
+        redirects: {
+          'old': 'new'
+        }
+      }
+    });
+
+    const rootIndex = routes.declarations.indexOf(`path: ''`);
+    const redirectIndex = routes.declarations.indexOf(`{
+  path: 'old',
+  redirectTo: 'new'
+}`);
+
+    expect(redirectIndex).toBeLessThan(rootIndex);
+  });
 });