feat(guess-parser): update to latest guess-parser (#244)

SanderElias · web-flow · commit d0ac97aa7b05 · 2020-01-28T15:30:39.000+01:00
Update to the latest guess parser. Make sure the guess paarser uses the tsconfig.app.json. updated
packacge versions. couple off small touch-ups
diff --git a/blog/page-3.md b/blog/page-3.md
diff --git a/blog/page-4.adoc b/blog/page-4.adoc
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -66,7 +66,7 @@
     "express": "^4.17.1",
     "front-matter": "^3.0.2",
     "fs-extra": "^8.1.0",
-    "guess-parser": "^0.4.14",
+    "guess-parser": "^0.4.15",
     "husky": "^4.0.0-beta.5",
     "jasmine-core": "~3.5.0",
     "jasmine-spec-reporter": "~4.2.1",
diff --git a/projects/sampleBlog/src/app/user/user-routing.module.ts b/projects/sampleBlog/src/app/user/user-routing.module.ts
@@ -14,7 +14,7 @@ const routes: Routes = [
     children: [
       {path: '', component: PostsComponent, pathMatch: 'full'},
       {path: 'friend/:friendCode', component: UserComponent},
-      {path: 'post/:post', component: PostComponent},
+      {path: 'post/:postId', component: PostComponent},
     ],
   },
 ];
diff --git a/projects/scullyio/ng-lib/package.json b/projects/scullyio/ng-lib/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@scullyio/ng-lib",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "repository": {
     "type": "GIT",
     "url": "https://github.com/scullyio/scully/tree/master/projects/scullyio/ng-lib"
diff --git a/schematics/scully/src/scully/index.ts b/schematics/scully/src/scully/index.ts
@@ -34,7 +34,7 @@ const createScullyConfig = (options: Schema) => (tree: Tree, context: SchematicC
     tree.create(
       scullyConfigFile,
       `exports.config = {
-  projectRoot: "./${srcFolder}/app",
+  projectRoot: "./${srcFolder}",
   projectName: "${projectName}",
   outDir: './dist/static',
   routes: {
diff --git a/schematics/scully/src/scully/index_spec.ts b/schematics/scully/src/scully/index_spec.ts
@@ -42,7 +42,7 @@ describe('scully schematic', () => {
       expect(appTree.files).toContain(SCULLY_PATH);
       const scullyConfFile = getFileContent(appTree, SCULLY_PATH);
       expect(scullyConfFile).toEqual(`exports.config = {
-  projectRoot: "./src/app",
+  projectRoot: "./src/",
   outDir: './dist/static',
   routes: {
   }
diff --git a/scully.sampleBlog.config.js b/scully.sampleBlog.config.js
@@ -4,12 +4,10 @@ require('./extraPlugin/tocPlugin');
 require('./extraPlugin/voidPlugin');
 
 exports.config = {
-  /** projectRoot is mandatory! */
-  projectRoot: './projects/sampleBlog/src/app',
   /** outDir is where the static distribution files end up */
   outDir: './dist/static',
   // hostName: '0.0.0.0',
-  extraRoutes: ['', '/user/:userId/post/:postId'],
+  extraRoutes: [''],
   routes: {
     '/demo/:id': {
       type: 'extra',
@@ -49,22 +47,6 @@ exports.config = {
         property: 'id',
       },
     },
-    '/nouser/:userId/:friendCode': {
-      // Type is mandatory
-      type: 'json',
-      /**
-       * Every parameter in the route must exist here
-       */
-      userId: {
-        url: 'https://jsonplaceholder.typicode.com/users',
-        property: 'id',
-      },
-      friendCode: {
-        /** users are their own friend in this sample ;) */
-        url: 'https://jsonplaceholder.typicode.com/users?userId=${userId}',
-        property: 'id',
-      },
-    },
     '/todos/:todoId': {
       // Type is mandatory
       type: 'json',
@@ -82,25 +64,6 @@ exports.config = {
         },
       },
     },
-    '/nouser/:userId/:posts/:comments': {
-      // Type is mandatory
-      type: 'json',
-      /**
-       * Every parameter in the route must exist here
-       */
-      userId: {
-        url: 'https://jsonplaceholder.typicode.com/users',
-        property: 'id',
-      },
-      posts: {
-        url: 'https://jsonplaceholder.typicode.com/posts?userId=${userId}',
-        property: 'id',
-      },
-      comments: {
-        url: 'https://jsonplaceholder.typicode.com/comments?postId=${posts}',
-        property: 'id',
-      },
-    },
     '/blog/:slug': {
       type: 'contentFolder',
       postRenderers: ['toc'],
diff --git a/scully/package.json b/scully/package.json
@@ -20,7 +20,7 @@
     "express": "^4.17.1",
     "front-matter": "^3.0.2",
     "fs-extra": "^8.1.0",
-    "guess-parser": "^0.4.13",
+    "guess-parser": "^0.4.15",
     "jsonc": "2.0.0",
     "marked": "^0.7.0",
     "puppeteer": "^2.0.0",
diff --git a/scully/renderPlugins/contentRenderPlugin.ts b/scully/renderPlugins/contentRenderPlugin.ts
@@ -16,6 +16,7 @@ export async function contentRenderPlugin(html: string, route: HandledRoute) {
   try {
     const extension = file.split('.').pop();
     const {meta, fileContent} = await readFileAndCheckPrePublishSlug(file, route);
+    // TODO: create additional "routes" for every slug
     route.data = {...route.data, ...meta};
     const additionalHTML = await handleFile(extension, fileContent);
     return insertContent(scullyBegin, scullyEnd, html, additionalHTML, getScript());
diff --git a/scully/routerPlugins/traverseAppRoutesPlugin.ts b/scully/routerPlugins/traverseAppRoutesPlugin.ts
@@ -1,17 +1,30 @@
 import {parseAngularRoutes} from 'guess-parser';
+import {join} from 'path';
 import * as yargs from 'yargs';
 import {scullyConfig} from '../utils/config';
+import {existFolder} from '../utils/fsFolder';
 import {green, logError, logWarn, yellow} from '../utils/log';
 
 const {sge} = yargs
   .boolean('sge')
   .alias('sge', 'showGuessError')
   .describe('sb', 'dumps the error from guess to the console').argv;
+
 export const traverseAppRoutes = async (appRootFolder = scullyConfig.projectRoot) => {
   const extraRoutes = await addExtraRoutes();
   let routes = [];
   try {
-    routes = parseAngularRoutes(appRootFolder).map(r => r.path);
+    const file = join(appRootFolder, 'tsconfig.app.json');
+    if (!existFolder(file)) {
+      logWarn(
+        `We could not find "${yellow(
+          file
+        )}". Using the apps source folder as source. This might lead to unpredictable results`
+      );
+      routes = parseAngularRoutes(appRootFolder).map(r => r.path);
+    } else {
+      routes = parseAngularRoutes(file).map(r => r.path);
+    }
   } catch (e) {
     if (sge) {
       console.error(e);
diff --git a/scully/systemPlugins/storeRoutes.ts b/scully/systemPlugins/storeRoutes.ts
@@ -13,8 +13,7 @@ export async function storeRoutes(routes: HandledRoute[]) {
   let staticFile;
   try {
     const jsonResult = JSON.stringify(routes.map(r => ({route: r.route || '/', ...r.data})));
-    // logError('root', scullyConfig.projectRoot);
-    appFile = join(scullyConfig.projectRoot, `..${routesFileName}`);
+    appFile = join(scullyConfig.sourceRoot, `${routesFileName}`);
     createFolderFor(appFile);
     writeFileSync(appFile, jsonResult);
     staticFile = join(scullyConfig.outDir, routesFileName);
diff --git a/scully/utils/config.ts b/scully/utils/config.ts
@@ -13,11 +13,12 @@ const loadIt = async () => {
   const compiledConfig = await compileConfig();
   let angularConfig = {} as any;
   let distFolder = join(angularRoot, './dist');
+  let projectConfig: any = {};
   try {
     angularConfig = jsonc.parse(readFileSync(join(angularRoot, 'angular.json')).toString());
-    // TODO: make scully handle other projects as just the default one.
     const defaultProject = compiledConfig.projectName;
-    distFolder = angularConfig.projects[defaultProject].architect.build.options.outputPath;
+    projectConfig = angularConfig.projects[defaultProject];
+    distFolder = projectConfig.architect.build.options.outputPath;
     if (distFolder.endsWith('dist') && !distFolder.includes('/')) {
       logError(
         `Your distribution files are in "${yellow(distFolder)}". Please change that to include a subfolder`
@@ -40,6 +41,8 @@ const loadIt = async () => {
     {
       homeFolder: angularRoot,
       outDir: join(angularRoot, './dist/static/'),
+      sourceRoot: projectConfig.sourceRoot,
+      projectRoot: projectConfig.root,
       distFolder,
       appPort: /** 1864 */ 'herodevs'.split('').reduce((sum, token) => (sum += token.charCodeAt(0)), 1000),
       staticport: /** 1668 */ 'scully'.split('').reduce((sum, token) => (sum += token.charCodeAt(0)), 1000),
diff --git a/scully/utils/interfacesandenums.ts b/scully/utils/interfacesandenums.ts
@@ -9,8 +9,10 @@ export enum RouteTypes {
 export interface ScullyConfig {
   /** the name of the project we are using. Provided by Scully itself */
   projectName: string;
-  /** the folder where the app-source is. Can be any off the projects in a repo */
-  projectRoot: string;
+  /** the folder where project is. Can be any off the projects in a repo, read from angular.json */
+  projectRoot?: string;
+  /** the folder where the project sources resides, read from angular.json */
+  sourceRoot?: string;
   /** Array with string ID's of the content-renderes that will be run on all routes */
   defaultPostRenderers: string[];
   /** the root of the project (where angular.json lives) */
diff --git a/scully/utils/validateConfig.ts b/scully/utils/validateConfig.ts
@@ -18,15 +18,6 @@ export async function validateConfig(config: ScullyConfig) {
   /** make sure the config is completely loaded */
   // await loadConfig;
   const result: Partial<ScullyConfig> = {routes: {}};
-  if (config.projectRoot) {
-    if (!checkFolderExists(config.projectRoot)) {
-      error(`projectRoot folder not found "${yellow(config.projectRoot)}"`);
-    }
-    result.projectRoot = config.projectRoot;
-  } else {
-    // TODO define a constant for the config file name string
-    error(`projectRoot missing in "${yellow(configFileName)}"`);
-  }
   if (config.routes) {
     await Promise.all(
       Object.entries(config.routes).map(async ([route, definition]) => {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@scullyio/ng-lib",`
`3`		`- "version": "0.0.14",`
	`3`	`+ "version": "0.0.15",`
`4`	`4`	`"repository": {`
`5`	`5`	`"type": "GIT",`
`6`	`6`	`"url": "https://github.com/scullyio/scully/tree/master/projects/scullyio/ng-lib"`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ describe('scully schematic', () => {`
`42`	`42`	`expect(appTree.files).toContain(SCULLY_PATH);`
`43`	`43`	`const scullyConfFile = getFileContent(appTree, SCULLY_PATH);`
`44`	`44`	expect(scullyConfFile).toEqual(`exports.config = {
`45`		`- projectRoot: "./src/app",`
	`45`	`+ projectRoot: "./src/",`
`46`	`46`	`outDir: './dist/static',`
`47`	`47`	`routes: {`
`48`	`48`	`}`