Feat(contentFolder): add support for multi-level folders (#290)

* feat(contentfolder): support multi-level folders for contentFolder

* test(update): update test for new files

* chore(config): remove **

Author: jorgeucano

blog/2014/2/12/asdf.md

@@ -0,0 +1,21 @@
+---
+
+title: 'My testing page'
+author: 'Sander Elias'
+'publish date': 2019-11-27T00:00:00.000Z
+published: true
+description: 'This is the second demo page in this sample.'
+slugs:
+
+- **_UNPUBLISHED_**k6gdpy1m_BTpYcQqBTb1b1O2PhZMouEEVowWCj2f9
+  ---# Page 2
+
+## its a wild world after all
+
+```typescript
+console.log('amazing');
+```
+
+Related information [page-3](/blog/page-3)
+
+[site-map](/home)

blog/page-5.md

@@ -0,0 +1,21 @@
+---
+
+title: 'My asdf page'
+author: 'Sander Elias'
+'publish date': 2019-11-27T00:00:00.000Z
+published: true
+description: 'This is the second demo page in this sample.'
+slugs:
+
+- **_UNPUBLISHED_**k6gdpy1j_O72ihU7pHaGazECXHBnXR7v3nPchK3PX
+  ---# Page 2
+
+## its a wild world after all
+
+```typescript
+console.log('amazing');
+```
+
+Related information [page-3](/blog/page-3)
+
+[site-map](/home)

blog/test/testing.md

@@ -12,7 +12,7 @@
     "scully:r": "node ./dist/scully/scully serve",
     "scully:precommit": "npm run scully:compile:all && rm -rf ./dist/static && node  ./dist/scully/scully && npm run test",
     "scully:compile:all": "ng build @scullyio/ng-lib && ng build --prod && npm run scully:dev:compile",
-    "generate": "tsc -p  ./scully/tsconfig.scully.json && node ./scully/bin",
+    "generate": "tsc -p  ./scully/tsconfig.scully.json && node ./dist/scully/scully",
     "scully:dev:watch": "tsc -w -p ./scully/tsconfig.scully.json",
     "scully:dev:compile": "tsc -p    ./scully/tsconfig.scully.json",
     "scully:dev:run": "nodemon ./dist/scully/scully.js  --ext js",

blog/testing-empty.md

@@ -9,6 +9,10 @@ const routes: Routes = [
     path: ':slug',
     component: BlogComponent,
   },
+  {
+    path: '**',
+    component: BlogComponent,
+  },
 ];
 
 @NgModule({

package.json

@@ -7,6 +7,10 @@ const routes: Routes = [
   {
     path: ':<%= camelize(slug) %>',
     component: <%= classify(name) %>Component,
+  },
+  {
+    path: '**',
+    component: <%= classify(name) %>Component,
   }
 ];
 

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

@@ -71,8 +71,12 @@ exports.config = {
         folder: './blog',
       },
     },
-    '/**': {
-      type: 'ignored',
+    '/blog/:slug': {
+      type: 'contentFolder',
+      // postRenderers: ['toc'],
+      slug: {
+        folder: './blog',
+      },
     },
   },
   guessParserOptions: {

schematics/scully/src/files/markdown-module/__name@dasherize__-routing.module.ts.template

@@ -1,10 +1,10 @@
-import {readdir} from 'fs';
-import {basename, extname, join} from 'path';
+import {readdir, lstatSync, readFileSync} from 'fs';
+import {basename, extname, join, sep} from 'path';
 import {registerPlugin} from '../pluginManagement/pluginRepository';
 import {readFileAndCheckPrePublishSlug} from '../renderPlugins/content-render-utils/readFileAndCheckPrePublishSlug';
 import {scullyConfig} from '../utils/config';
 import {RouteTypeContentFolder} from '../utils/interfacesandenums';
-import {log, yellow} from '../utils/log';
+import {log, logWarn, yellow} from '../utils/log';
 import {HandledRoute} from './addOptionalRoutesPlugin';
 
 export async function contentFolderPlugin(
@@ -22,32 +22,68 @@ export async function contentFolderPlugin(
   const baseRoute = angularRoute.split(':' + param)[0];
   const path = join(scullyConfig.homeFolder, paramConfig.folder);
   log(`Finding files in folder "${yellow(path)}"`);
+  return await checkSourceIsDirectoryAndRun(path, baseRoute, conf);
+}
+
+async function checkSourceIsDirectoryAndRun(path, baseRoute, conf) {
   const files = await new Promise<string[]>(resolve => readdir(path, (err, data) => resolve(data)));
   const handledRoutes: HandledRoute[] = [];
   for (const sourceFile of files) {
     const ext = extname(sourceFile);
     const templateFile = join(path, sourceFile);
-    const base = basename(sourceFile, ext);
-    const routify = frag => `${baseRoute}${slugify(frag)}`;
-    const {meta, prePublished} = await readFileAndCheckPrePublishSlug(templateFile);
-    const handledRoute: HandledRoute = {
-      route: routify(meta.slug || base),
-      type: conf.type,
-      templateFile,
-      data: {...meta, sourceFile},
-    };
-    handledRoutes.push(handledRoute);
-    if (!prePublished && Array.isArray(meta.slugs)) {
-      /** also add routes for all available slugs */
-      meta.slugs
-        .filter(slug => typeof slug === 'string')
-        .map(routify)
-        .forEach(route => handledRoutes.push({...handledRoute, route}));
+    if (lstatSync(templateFile).isDirectory()) {
+      handledRoutes.push(...(await checkSourceIsDirectoryAndRun(templateFile, baseRoute, conf)));
+    } else {
+      if (checkIfEmpty(templateFile)) {
+        logWarn(`The file ${templateFile} is empty, scully will ignore.`);
+      } else {
+        handledRoutes.push(...(await addHandleRoutes(sourceFile, baseRoute, templateFile, conf, ext)));
+      }
     }
   }
   return handledRoutes;
 }
 
+function checkIfEmpty(templateFile: string) {
+  try {
+    const file = readFileSync(templateFile).toString();
+    return file.length === 0 ? true : false;
+  } catch (e) {
+    return false;
+  }
+}
+
+async function addHandleRoutes(sourceFile, baseRoute, templateFile, conf, ext) {
+  const handledRoutes = [];
+  const base = basename(sourceFile, ext);
+  // if a subfolder we need add a route for this folder
+  let routify = frag => `${baseRoute}${slugify(frag)}`;
+  // replace \ for / for windows
+  const newTemplateFile = templateFile.split('\\').join('/');
+  if (!newTemplateFile.endsWith(`${baseRoute}${sourceFile}`)) {
+    const position = newTemplateFile.search(baseRoute);
+    const br = newTemplateFile.substr(position).replace(sourceFile, '');
+    routify = frag => `${br}${slugify(frag)}`;
+  }
+  // is a folder we need iterate the content in the folder
+  const {meta, prePublished} = await readFileAndCheckPrePublishSlug(templateFile);
+  const handledRoute: HandledRoute = {
+    route: routify(meta.slug || base),
+    type: conf.type,
+    templateFile,
+    data: {...meta, sourceFile},
+  };
+  handledRoutes.push(handledRoute);
+  if (!prePublished && Array.isArray(meta.slugs)) {
+    /** also add routes for all available slugs */
+    meta.slugs
+      .filter(slug => typeof slug === 'string')
+      .map(routify)
+      .forEach(route => handledRoutes.push({...handledRoute, route}));
+  }
+  return handledRoutes;
+}
+
 export function slugify(frag: string): string {
   return encodeURIComponent(
     frag

scully.sampleBlog.config.js

@@ -44,9 +44,11 @@ export const generateAll = async (localBaseFilter = baseFilter) => {
     performance.mark('startDiscovery');
     performanceIds.add('Discovery');
     log('Pull in data to create additional routes.');
-    const handledRoutes = await addOptionalRoutes(
-      unhandledRoutes.filter((r: string) => typeof r === 'string' && r.startsWith(localBaseFilter))
-    );
+    const handledRoutes = (
+      await addOptionalRoutes(
+        unhandledRoutes.filter((r: string) => typeof r === 'string' && r.startsWith(localBaseFilter))
+      )
+    ).filter(r => !r.route.endsWith('*'));
     performance.mark('stopDiscovery');
     /** save routerinfo, so its available during rendering */
     if (localBaseFilter === '') {