add final page parsing

ShMcK · ShMcK · commit 3650763d3eae · 2016-09-16T20:40:33.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.10.0] - 2016-09-16
+- add to parser:
+  - `@resource([link to resource](http://path/to/link))` - collect helpful resource links
+  - `## Final` fill in the content for the final page after tutorial completion. Matches on page title "Final".
+
 ## [0.9.1] - 2016-09-15
 - find tutorials now returns "isLatest" (bool) & "latest": (string of version)
 
diff --git a/lib/build/index.js b/lib/build/index.js
@@ -17,7 +17,7 @@ function parseAndBuild(dir, lines) {
         page: -1,
         task: -1,
     };
-    return info_1.info({ dir: dir, result: result, lines: lines, index: index });
+    return info_1.default({ dir: dir, result: result, lines: lines, index: index });
 }
 function build(_a) {
     var dir = _a.dir, filePath = _a.filePath, _b = _a.output, output = _b === void 0 ? './coderoad.json' : _b;
diff --git a/lib/build/lint.js b/lib/build/lint.js
@@ -2,7 +2,7 @@
 var chalk_1 = require('chalk');
 var validKeys = {
     info: ['title', 'description'],
-    page: ['title', 'description', 'onPageComplete', 'tasks', 'video', 'link'],
+    page: ['title', 'description', 'onPageComplete', 'tasks', 'video', 'resource'],
     task: ['description', 'tests', 'actions', 'hints']
 };
 function lintOutput(json) {
diff --git a/lib/build/parser/actions.js b/lib/build/parser/actions.js
@@ -47,6 +47,16 @@ function addToTasks(_a) {
                 task: task,
             });
             break;
+        case 'resource':
+            result = doAction({
+                type: 'resource',
+                isArray: isActionArray,
+                actionValue: actionValue,
+                result: result,
+                page: page,
+                task: task
+            });
+            break;
         case 'continue':
             break;
         case 'action':
diff --git a/lib/build/parser/final.js b/lib/build/parser/final.js
@@ -0,0 +1,41 @@
+"use strict";
+var Match = require('./match');
+var import_1 = require('./import');
+function final(_a) {
+    var dir = _a.dir, result = _a.result, lines = _a.lines;
+    var inCodeBlock = false;
+    var currentPageComplete = null;
+    var bracketCount = 0;
+    result.final = {
+        description: '',
+    };
+    var i = 0;
+    while (i < lines.length - 1) {
+        i += 1;
+        var line = lines[i];
+        switch (true) {
+            case !!Match.isImport(line):
+                lines = import_1.default({ dir: dir, lines: lines, pathToMd: Match.isImport(line) });
+                continue;
+            case !!Match.codeBlock(line):
+                if (line.length > 3) {
+                    result.final.description += '\n' + line;
+                }
+                else {
+                    inCodeBlock = !inCodeBlock;
+                }
+                continue;
+            case inCodeBlock:
+                continue;
+            default:
+                if (i > 1) {
+                    result.final.description += '\n';
+                }
+                result.final.description += line;
+                continue;
+        }
+    }
+    return result;
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = final;
diff --git a/lib/build/parser/import.js b/lib/build/parser/import.js
@@ -24,4 +24,5 @@ function loadImport(_a) {
     var splitLines = importLines.split('\n');
     return lines.concat(splitLines);
 }
-exports.loadImport = loadImport;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = loadImport;
diff --git a/lib/build/parser/info.js b/lib/build/parser/info.js
@@ -11,7 +11,7 @@ function info(_a) {
         var line = lines[i];
         switch (true) {
             case !!Match.isImport(line):
-                lines = import_1.loadImport({ dir: dir, lines: lines, pathToMd: Match.isImport(line) });
+                lines = import_1.default({ dir: dir, lines: lines, pathToMd: Match.isImport(line) });
                 continue;
             case !!Match.codeBlock(line):
                 if (line.length > 3) {
@@ -25,7 +25,7 @@ function info(_a) {
                 result.info.title = Match.info(line).trim();
                 continue;
             case !!Match.page(line):
-                return page_1.page({ dir: dir, result: result, lines: lines.slice(i), index: index });
+                return page_1.default({ dir: dir, result: result, lines: lines.slice(i), index: index });
             default:
                 if (i > 1) {
                     result.info.description += '\n';
@@ -35,4 +35,5 @@ function info(_a) {
     }
     return result;
 }
-exports.info = info;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = info;
diff --git a/lib/build/parser/match.js b/lib/build/parser/match.js
@@ -8,9 +8,9 @@ var regex = {
     '##': match('#', 2),
     '+': match('\\+', 1),
     '```': match('`', 3),
-    'action': /^@(action|test|hint|openConsole|write|writeFromFile)/,
+    'action': /^@(action|test|hint|openConsole|resource)/,
     'import': /^@import\((.+)\)$/,
-    'onPageComplete': /^(@onPageComplete.+)/
+    'onPageComplete': /^(@onPageComplete.+)/,
 };
 function parseWithCode(code) {
     return function (line) {
diff --git a/lib/build/parser/page.js b/lib/build/parser/page.js
@@ -2,13 +2,18 @@
 var Match = require('./match');
 var task_1 = require('./task');
 var import_1 = require('./import');
+var final_1 = require('./final');
 var cleanup_1 = require('./cleanup');
 function page(_a) {
     var dir = _a.dir, result = _a.result, lines = _a.lines, index = _a.index;
     index.page += 1;
     index.task = -1;
+    var title = Match.page(lines[0]);
+    if (title === 'Final') {
+        return final_1.default({ dir: dir, result: result, lines: lines });
+    }
     result.pages.push({
-        title: Match.page(lines[0]),
+        title: title,
         description: ''
     });
     var inCodeBlock = false;
@@ -20,7 +25,7 @@ function page(_a) {
         var line = lines[i];
         switch (true) {
             case !!Match.isImport(line):
-                lines = import_1.loadImport({ dir: dir, lines: lines, pathToMd: Match.isImport(line) });
+                lines = import_1.default({ dir: dir, lines: lines, pathToMd: Match.isImport(line) });
                 continue;
             case (!!Match.isPageComplete(line) || !!currentPageComplete):
                 currentPageComplete = !!currentPageComplete
@@ -48,7 +53,7 @@ function page(_a) {
                 if (result.pages[index.page].tasks === undefined) {
                     result.pages[index.page].tasks = [];
                 }
-                return task_1.task({ dir: dir, result: result, lines: lines.slice(i), index: index });
+                return task_1.default({ dir: dir, result: result, lines: lines.slice(i), index: index });
             default:
                 if (i > 1) {
                     result.pages[index.page].description += '\n';
@@ -59,4 +64,5 @@ function page(_a) {
     }
     return result;
 }
-exports.page = page;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = page;
diff --git a/lib/build/parser/task.js b/lib/build/parser/task.js
@@ -20,7 +20,7 @@ function task(_a) {
         var line = lines[i];
         switch (true) {
             case !!Match.isImport(line):
-                lines = import_1.loadImport({ dir: dir, lines: lines, pathToMd: Match.isImport(line) });
+                lines = import_1.default({ dir: dir, lines: lines, pathToMd: Match.isImport(line) });
                 continue;
             case (!!Match.isPageComplete(line) || !!currentPageComplete):
                 currentPageComplete = !!currentPageComplete
@@ -69,7 +69,7 @@ function task(_a) {
             case !!Match.task(line):
                 return task({ dir: dir, result: result, lines: lines.slice(i), index: index });
             case !!Match.page(line):
-                return page_1.page({ dir: dir, result: result, lines: lines.slice(i), index: index });
+                return page_1.default({ dir: dir, result: result, lines: lines.slice(i), index: index });
             default:
                 if (i > 0) {
                     result.pages[index.page].tasks[index.task].description += '\n';
@@ -79,4 +79,5 @@ function task(_a) {
     }
     return result;
 }
-exports.task = task;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = task;
diff --git a/lib/build/readme.js b/lib/build/readme.js
@@ -21,7 +21,7 @@ function createReadme(dir) {
 exports.createReadme = createReadme;
 function generateReadme(data, packageJson) {
     var readme = [];
-    var info = data.info, pages = data.pages;
+    var info = data.info, pages = data.pages, final = data.final;
     readme = readme.concat([
         '# ' + info.title,
         '',
@@ -59,16 +59,23 @@ function generateReadme(data, packageJson) {
         '## Outline',
         ''
     ]);
-    var parsedPages = pages.map(function (page) {
-        return [
-            '##### ' + page.title,
-            '',
-            page.description,
-            ''
-        ];
-    });
+    var parsedPages = pages.map(function (page) { return ([
+        '##### ' + page.title,
+        '',
+        page.description,
+        ''
+    ]); });
     parsedPages.forEach(function (page) {
         readme = readme.concat(page);
     });
+    if (final && final.description) {
+        readme = readme.concat([
+            '',
+            '## Final',
+            '',
+            final.description,
+            ''
+        ]);
+    }
     return readme.join('\n');
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "coderoad-cli",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "description": "Command line interface for CodeRoad. Build project files.",
   "keywords": [
     "coderoad"
diff --git a/src/build/index.ts b/src/build/index.ts
@@ -1,6 +1,6 @@
 import {readFileSync, writeFileSync}  from 'fs';
 import * as validate from './validators';
-import {info} from './parser/info';
+import info from './parser/info';
 import {createReadme} from './readme';
 import {cleanup} from './parser/cleanup';
 import {join} from 'path';
diff --git a/src/build/lint.ts b/src/build/lint.ts
@@ -2,7 +2,7 @@ import {yellow, red} from 'chalk';
 
 const validKeys = {
   info: ['title', 'description'],
-  page: ['title', 'description', 'onPageComplete', 'tasks', 'video', 'link'],
+  page: ['title', 'description', 'onPageComplete', 'tasks', 'video', 'resource'],
   task: ['description', 'tests', 'actions', 'hints']
 };
 
diff --git a/src/build/parser/actions.ts b/src/build/parser/actions.ts
@@ -50,6 +50,16 @@ export function addToTasks({ result, line, index: {page, task} }) {
         task,
       });
       break;
+    case 'resource':
+      result = doAction({
+        type: 'resource',
+        isArray: isActionArray,
+        actionValue,
+        result,
+        page,
+        task
+      });
+      break;
     case 'continue':
       break;
     case 'action':
diff --git a/src/build/parser/final.ts b/src/build/parser/final.ts
@@ -0,0 +1,47 @@
+import * as Match from './match';
+import loadImport from './import';
+import {bracketTracker, trimValue} from './cleanup';
+
+export default function final({ dir, result, lines }) {
+  let inCodeBlock = false;
+  let currentPageComplete = null;
+  let bracketCount = 0;
+
+  result.final = {
+    description: '',
+  };
+
+  let i = 0;
+  while (i < lines.length - 1) {
+    i += 1;
+    let line = lines[i];
+
+    switch (true) {
+
+      // @import
+      case !!Match.isImport(line):
+        lines = loadImport({dir, lines, pathToMd: Match.isImport(line)});
+        continue;
+
+      // ``` `
+      case !!Match.codeBlock(line):
+        if (line.length > 3) {
+          result.final.description += '\n' + line;
+        } else {
+          inCodeBlock = !inCodeBlock;
+        }
+        continue;
+      case inCodeBlock:
+        continue;
+
+      // description
+      default:
+        if (i > 1) {
+          result.final.description += '\n';
+        }
+        result.final.description += line;
+        continue;
+    }
+  }
+  return result;
+}
diff --git a/src/build/parser/import.ts b/src/build/parser/import.ts
@@ -4,7 +4,7 @@ import fileExists from 'node-file-exists';
 import {trimQuotes} from './cleanup';
 import {tutorialDir} from './settings';
 
-export function loadImport({ dir, lines, pathToMd }): string[] {
+export default function loadImport({ dir, lines, pathToMd }): string[] {
   // add .md suffix
   pathToMd = trimQuotes(pathToMd);
   if (!pathToMd.match(/\.md$/)) {
diff --git a/src/build/parser/info.ts b/src/build/parser/info.ts
@@ -1,8 +1,8 @@
 import * as Match from './match';
-import {page} from './page';
-import {loadImport} from './import';
+import page from './page';
+import loadImport from './import';
 
-export function info({ dir, result, lines, index }): CR.Output {
+export default function info({ dir, result, lines, index }): CR.Output {
   let inCodeBlock = false;
   let i = -1;
 
diff --git a/src/build/parser/match.ts b/src/build/parser/match.ts
@@ -9,9 +9,9 @@ var regex = {
   '##': match('#', 2),
   '+': match('\\+', 1),
   '```': match('`', 3),
-  'action': /^@(action|test|hint|openConsole|write|writeFromFile)/,
+  'action': /^@(action|test|hint|openConsole|resource)/,
   'import': /^@import\((.+)\)$/,
-  'onPageComplete': /^(@onPageComplete.+)/
+  'onPageComplete': /^(@onPageComplete.+)/,
 };
 
 function parseWithCode(code: string) {
diff --git a/src/build/parser/page.ts b/src/build/parser/page.ts
@@ -1,13 +1,18 @@
 import * as Match from './match';
-import {task} from './task';
-import {loadImport} from './import';
+import task from './task';
+import loadImport from './import';
+import final from './final';
 import {bracketTracker, trimValue} from './cleanup';
 
-export function page({ dir, result, lines, index }) {
+export default function page({ dir, result, lines, index }) {
   index.page += 1;
   index.task = -1;
+  const title = Match.page(lines[0]);
+  if (title === 'Final') {
+    return final({dir, result, lines});
+  }
   result.pages.push({
-    title: Match.page(lines[0]),
+    title,
     description: ''
   });
   let inCodeBlock = false;
diff --git a/src/build/parser/task.ts b/src/build/parser/task.ts
diff --git a/src/build/readme.ts b/src/build/readme.ts
diff --git a/src/typings/cr.d.ts b/src/typings/cr.d.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ function parseAndBuild(dir, lines) {`
`17`	`17`	`page: -1,`
`18`	`18`	`task: -1,`
`19`	`19`	`};`
`20`		`- return info_1.info({ dir: dir, result: result, lines: lines, index: index });`
	`20`	`+ return info_1.default({ dir: dir, result: result, lines: lines, index: index });`
`21`	`21`	`}`
`22`	`22`	`function build(_a) {`
`23`	`23`	`var dir = _a.dir, filePath = _a.filePath, _b = _a.output, output = _b === void 0 ? './coderoad.json' : _b;`
Original file line number	Diff line number	Diff line change
`@@ -24,4 +24,5 @@ function loadImport(_a) {`
`24`	`24`	`var splitLines = importLines.split('\n');`
`25`	`25`	`return lines.concat(splitLines);`
`26`	`26`	`}`
`27`		`-exports.loadImport = loadImport;`
	`27`	`+Object.defineProperty(exports, "__esModule", { value: true });`
	`28`	`+exports.default = loadImport;`