Merge branch 'post-install' into ui-rewrite

Author: bmuenzenmeyer

core/lib/markdown_parser.js

@@ -1,41 +1,39 @@
 "use strict";
 
 var md = require('markdown-it')();
+var yaml = require('js-yaml');
 
 var markdown_parser = function () {
 
+  /**
+   * Converts a markdown block with frontmatter (each is optional, technically) to a well-formed object.
+   * @param block - the ".md" file, which can contain frontmatter or not, or only frontmatter.
+   * @returns an object with any frontmatter keys, plus a .markdown key
+     */
   function parseMarkdownBlock(block) {
     var returnObject = {};
 
     try {
       //for each block process the yaml frontmatter and markdown
       var frontmatterRE = /---\r?\n{1}([\s\S]*)---\r?\n{1}([\s\S]*)+/gm;
       var chunks = frontmatterRE.exec(block);
-      if (chunks && chunks[1]) {
-
-        //convert each yaml frontmatter key / value into an object key
-        var frontmatter = chunks[1];
-        var frontmatterLines = frontmatter.split(/\n/gm);
-        for (var j = 0; j < frontmatterLines.length; j++) {
-
-          var frontmatterLine = frontmatterLines[j];
-          if (frontmatterLine.length > 0) {
-
-            var frontmatterLineChunks = frontmatterLine.split(':'); //test this
-            var frontmatterKey = frontmatterLineChunks[0].toLowerCase().trim();
-            var frontmatterValueString = frontmatterLineChunks[1].trim();
-
-            returnObject[frontmatterKey] = frontmatterValueString;
-          }
 
+      if (chunks) {
+        //we got some frontmatter
+        if (chunks && chunks[1]) {
+          //parse the yaml if we got it
+          var frontmatter = chunks[1];
+          returnObject = yaml.safeLoad(frontmatter);
         }
-      }
 
-      if (chunks && chunks[2]) {
-        //parse the actual markdown
-        returnObject.markdown = md.render(chunks[2]);
+        if (chunks[2]) {
+          //parse the actual markdown if it exists
+          returnObject.markdown = md.render(chunks[2]);
+        } else {
+          returnObject.markdown = '';
+        }
       } else {
-        //assume the passed in block is raw markdown
+        //assume the block was only markdown
         returnObject.markdown = md.render(block);
       }
     } catch (ex) {

core/lib/patternlab.js

@@ -1,10 +1,10 @@
-/*
- * patternlab-node - v2.3.0 - 2016
- *
+/* 
+ * patternlab-node - v2.4.0 - 2016 
+ * 
  * Brian Muenzenmeyer, Geoff Pursell, and the web community.
- * Licensed under the MIT license.
- *
- * Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice.
+ * Licensed under the MIT license. 
+ * 
+ * Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice. 
  *
  */
 
@@ -21,11 +21,11 @@ var diveSync = require('diveSync'),
 function buildPatternData(dataFilesPath, fs) {
   var dataFilesPath = dataFilesPath;
   var dataFiles = glob.sync(dataFilesPath + '*.json', {"ignore" : [dataFilesPath + 'listitems.json']});
-  var mergeObject = {}
+  var mergeObject = {};
   dataFiles.forEach(function (filePath) {
-    var jsonData = fs.readJSONSync(path.resolve(filePath), 'utf8')
-    mergeObject = _.merge(mergeObject, jsonData)
-  })
+    var jsonData = fs.readJSONSync(path.resolve(filePath), 'utf8');
+    mergeObject = _.merge(mergeObject, jsonData);
+  });
   return mergeObject;
 }
 
@@ -99,7 +99,6 @@ var patternlab_engine = function (config) {
     console.log(patternlab.package.version);
   }
 
-
   function help() {
 
     console.log('');
@@ -185,7 +184,7 @@ var patternlab_engine = function (config) {
   }
 
   function listStarterkits() {
-    var starterkit_manager = new sm(patternlab);
+    var starterkit_manager = new sm(patternlab.config);
     return starterkit_manager.list_starterkits();
   }
 
@@ -273,7 +272,7 @@ var patternlab_engine = function (config) {
     //set pattern-specific header if necessary
     var head;
     if (patternlab.userHead) {
-      head = patternlab.userHead.replace('{% pattern-lab-head %}', patternlab.header);
+      head = patternlab.userHead;
     } else {
       head = patternlab.header;
     }

core/lib/starterkit_manager.js

@@ -1,15 +1,15 @@
 "use strict";
 
-var starterkit_manager = function (pl) {
+var starterkit_manager = function (config) {
   var path = require('path'),
     fs = require('fs-extra'),
     util = require('./utilities'),
-    paths = pl.config.paths;
+    paths = config.paths;
 
   function loadStarterKit(starterkitName, clean) {
     try {
       var kitPath = path.resolve(
-        path.join(process.cwd(), 'node_modules', starterkitName, pl.config.starterkitSubDir)
+        path.join(process.cwd(), 'node_modules', starterkitName, config.starterkitSubDir)
       );
       console.log('Attempting to load starterkit from', kitPath);
       try {
@@ -49,6 +49,15 @@ var starterkit_manager = function (pl) {
 
   }
 
+  function detectStarterKits() {
+    var node_modules_path = path.join(process.cwd(), 'node_modules');
+    var npm_modules = fs.readdirSync(node_modules_path).filter(function (dir) {
+      var module_path = path.join(process.cwd(), 'node_modules', dir);
+      return fs.statSync(module_path).isDirectory() && dir.indexOf('starterkit-') === 0;
+    });
+    return npm_modules;
+  }
+
   return {
     load_starterkit: function (starterkitName, clean) {
       loadStarterKit(starterkitName, clean);
@@ -58,6 +67,9 @@ var starterkit_manager = function (pl) {
     },
     pack_starterkit: function () {
       packStarterkit();
+    },
+    detect_starterkits: function () {
+      return detectStarterKits();
     }
   };
 

core/lib/utilities.js

@@ -15,6 +15,10 @@ var util = {
     console.log('\x1b[32m', message, '\x1b[0m');
   },
 
+  logOrange: function (message) {
+    console.log('\x1b[33m', message, '\x1b[0m');
+  },
+
   logRed: function (message) {
     console.log('\x1b[41m', message, '\x1b[0m');
   },

core/scripts/postinstall.js

@@ -0,0 +1,33 @@
+"use strict";
+try{
+
+  console.log('Beginning Pattern Lab postinstall...');
+
+  var sm = require('../lib/starterkit_manager.js');
+  var u = require('../lib/utilities.js');
+  var path = require('path');
+  var fs = require('fs-extra');
+
+  //get the config
+  var configPath = path.resolve(process.cwd(), 'patternlab-config.json');
+  var config = fs.readJSONSync(path.resolve(configPath), 'utf8');
+
+  //determine if any starterkits are already installed
+  var starterkit_manager = new sm(config);
+  var foundStarterkits = starterkit_manager.detect_starterkits();
+
+  //todo - enhance to support multiple kits with prompt for each or all
+  if(foundStarterkits && foundStarterkits.length > 0) {
+    starterkit_manager.load_starterkit(foundStarterkits[0], true);
+  } else {
+    console.log('No starterkits found to automatically load.')
+  }
+  u.logGreen('Pattern Lab postinstall complete.');
+
+} catch (ex) {
+  u.logOrange(ex);
+  u.logOrange('An error occurred during Pattern Lab Node postinstall.');
+  u.logOrange('Pattern Lab postinstall completed with errors.');
+}
+
+

package.json

@@ -1,12 +1,13 @@
 {
   "name": "patternlab-node",
   "description": "Pattern Lab is a collection of tools to help you create atomic design systems. This is the node command line interface (CLI).",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "main": "./core/lib/patternlab.js",
   "dependencies": {
     "diveSync": "^0.3.0",
     "fs-extra": "^0.30.0",
     "glob": "^7.0.0",
+    "js-yaml": "^3.6.1",
     "json5": "^0.5.0",
     "lodash": "~4.13.1",
     "markdown-it": "^6.0.1",

test/files/_patterns/00-test/03-styled-atom.md

@@ -0,0 +1,3 @@
+---
+status: inprogress
+---

test/files/nav.md

@@ -1,5 +1,5 @@
 ---
-el: #nav
+el: '#nav'
 title : Navigation
 ---
 Navigation for adaptive web experiences can be tricky. Refer to [these repsonsive patterns](https://bradfrost.github.io/this-is-responsive/patterns.html#navigation) when evaluating solutions.

test/markdown_parser_tests.js

@@ -2,34 +2,46 @@
 
 var path = require('path');
 var fs = require('fs-extra');
-var eol = require('os').EOL;
 var mp = require('../core/lib/markdown_parser');
 var markdown_parser = new mp();
 
 exports['markdown_parser'] = {
-	'parses pattern description block correctly when frontmatter not present' : function(test){
-		//arrange
+	'parses pattern description block correctly when frontmatter not present' : function(test) {
+    //arrange
     var markdownFileName = path.resolve("./test/files/_patterns/00-test/00-foo.md");
     var markdownFileContents = fs.readFileSync(markdownFileName, 'utf8');
 
-		//act
-		var returnObject = markdown_parser.parse(markdownFileContents)
+    //act
+    var returnObject = markdown_parser.parse(markdownFileContents);
 
-		//assert
+    //assert
     test.equals(returnObject.markdown, '<h2>A Simple Include</h2>\n<p>This pattern contains an include of <code>test-bar</code>. It also has this markdown file, which does not have frontmatter.</p>\n');
     test.done();
 	},
-  'parses pattern description block correctly when frontmatter present' : function(test){
+  'parses pattern description block correctly when frontmatter present' : function (test) {
     //arrange
     var markdownFileName = path.resolve("./test/files/_patterns/00-test/01-bar.md");
     var markdownFileContents = fs.readFileSync(markdownFileName, 'utf8');
 
     //act
-    var returnObject = markdown_parser.parse(markdownFileContents)
+    var returnObject = markdown_parser.parse(markdownFileContents);
 
     //assert
     test.equals(returnObject.markdown, '<h2>A Simple Bit of Markup</h2>\n<p>Foo cannot get simpler than bar, amiright?</p>\n');
     test.equals(returnObject.status, 'complete');
     test.done();
+  },
+  'parses frontmatter only when no markdown present': function (test) {
+    //arrange
+    var markdownFileName = path.resolve("./test/files/_patterns/00-test/03-styled-atom.md");
+    var markdownFileContents = fs.readFileSync(markdownFileName, 'utf8');
+
+    //act
+    var returnObject = markdown_parser.parse(markdownFileContents);
+
+    //assert
+    test.equals(returnObject.markdown, '');
+    test.equals(returnObject.status, 'inprogress');
+    test.done();
   }
 };