Merge pull request #39 from pattern-lab/plnode1-1

PL Node 1.1

Author: Brian Muenzenmeyer

CHANGELOG

@@ -1,5 +1,13 @@
 THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.
 
+PL-node-v0.1.1
+ - FIX: Removed View All Pattern SubItem Link Logic, no longer in reference implementation
+ - ADD: Flag for generating debug file
+ - ADD: Travis CI test support!
+ - ADD: Contributing file
+ - ADD: Repository to package.json
+ - THX: thank you @tbranyen for tip on repository, and NPM
+
 PL-node-v0.1.0
  - FIX: Links to patterns did not work when visited from a server
  - FIX: Patterns with hyphens in the name were breaking the iframe messaging

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+#Contributing to Patternlab - Node
+If you'd like to contribute to patternlab - node, please do so! There is always a lot of ground to cover, with patternlab - php being so feature-rich.  
+
+No pull request is too small.
+
+##Guidelines
+1. Please keep your pull requests concise
+2. _ALWAYS_ submit it against the [dev branch](https://github.com/pattern-lab/patternlab-node/tree/dev). If this does not occur, I will first, try to redirect you gently, second, port over your contribution manually if time allows, and/or third, close your pull request.

Gruntfile.js

@@ -3,7 +3,10 @@ module.exports = function(grunt) {
 	// Project configuration.
 	grunt.initConfig({
 		pkg: grunt.file.readJSON('package.json'),
-		clean: ['./public/patterns'],
+		clean: {
+			options: { force: true },
+			files: ['./public/patterns']
+		},
 		concat: {
 			options: {
 				stripBanners: true,

README.md

@@ -2,10 +2,6 @@
 
 The Node version of Pattern Lab is, at its core, a static site generator. It combines platform-agnostic assets, like the [Mustache](http://mustache.github.io/)-based patterns and the JavaScript-based viewer, with a Node-based "builder" that transforms and dynamically builds the Pattern Lab site. By making it a static site generator, the Node version of Pattern Lab strongly separates patterns, data, and presentation from build logic. The Node version is a work in progress, the [PHP version](https://github.com/pattern-lab/patternlab-php) should be seen as a reference for other developers to improve upon as they build their own Pattern Lab Builders in their language of choice.
 
-## Under Active Development
-
-[![Build Status](https://travis-ci.org/pattern-lab/patternlab-node.png?branch=master)](https://travis-ci.org/pattern-lab/patternlab-node) The Node version of Pattern Lab is under active development by [@bmuenzenmeyer](https://twitter.com/bmuenzenmeyer).  Contributions welcome!
-
 ### Getting Started
 
 To run patternlab-node, just do the following from the command line at the root of patternlab-node: 
@@ -14,18 +10,22 @@ To run patternlab-node, just do the following from the command line at the root
 2. `npm install -g grunt-cli`
 3. `grunt`  
 
-This creates all patterns, the styleguide, and the patternlab site. `patternlab.json` is a file created for debugging purposes.  It tells you all the secrets in tidy json.
+This creates all patterns, the styleguide, and the pattern lab site. `patternlab.json` is a file created for debugging purposes.  It tells you all the secrets in tidy json.
 
 To have patternlab-node watch for changes to either a mustache template, data, or stylesheets, run `grunt watch`. The `Gruntfile` governs what is watched. It should be easy to add scss or whatever preprocessor you fancy.
 
-#### Watching Progress
+### Under Active Development
+
+[![Build Status](https://travis-ci.org/pattern-lab/patternlab-node.png?branch=master)](https://travis-ci.org/pattern-lab/patternlab-node) The Node version of Pattern Lab is under active development by [@bmuenzenmeyer](https://twitter.com/bmuenzenmeyer) and contributors. Pull requests welcome, but please take a moment to read the [guidelines](https://github.com/pattern-lab/patternlab-node/blob/master/CONTRIBUTING.md).
+
+#### Forward, To the Specification!
+
+Dave Olsen has published the [specification](https://github.com/pattern-lab/the-spec/blob/draft/SPEC.md) for Pattern Lab ports. Development will be oriented toward compliance with this as the spec and the port mature together. 
+
+#### Is Pattern Lab a Platform or a Build Tool?
 
-Patternlab Node has reached [minimum viable product](http://en.wikipedia.org/wiki/Minimum_viable_product) status.  The main branch will always have the most up to date version of patternlab-node.  Watch the dev branch for what it coming next!
+A lot of good conversation has revolved around whether Pattern Lab is a platform or a tool in the toolbox, part of a larger solution. It's my goal to #1) adhere to the specification and #2) meet the needs of both use cases.
 
-#### Roadmap
-* DRY & Testing.
-* Lineage
-* Documentation
 
 **THE FOLLOWING IS FROM THE PATTERNLAB-PHP PROJECT.  A LOT STILL APPLIES TO PATTERNLAB-NODE, BUT IT HAS NOT BEEN ADAPTED YET.  USE AT YOUR OWN PERIL**
 

builder/patternlab.js

@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.1.0 - 2014-01-21 
+ * patternlab-node - v0.1.1 - 2014-05-05 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
@@ -57,7 +57,9 @@ var mustache = require('./lib/Mustache/mustache.js');
 module.exports = function(grunt) {	
 	grunt.registerTask('patternlab', 'create design systems with atomic design', function(arg) {
 
+		
 		var patternlab = {};
+		patternlab.package = grunt.file.readJSON('package.json');
 		patternlab.data = grunt.file.readJSON('./source/_data/data.json');
 		patternlab.listitems = grunt.file.readJSON('./source/_data/listitems.json');
 		patternlab.header = grunt.file.read('./source/_patternlab-files/pattern-header-footer/header.html');
@@ -286,40 +288,8 @@ module.exports = function(grunt) {
 
 				}
 
-				//check to see if this bucket has a View All yet.  If not, add it.
-				// var navItem = bucket.navItems[navItemIndex];
-				// if(navItem){
-				// 	var hasViewAll = navItem.navSubItemsIndex.indexOf('View All');
-				// 	if(hasViewAll === -1){
-				// 		console.log('add a view all pattern');
-
-				// 			var navSubItem = new oNavSubItem('View All');
-				// 			navSubItem.patternPath = pattern.flatPatternPath + '/index.html'; //this is likely wrong
-				// 			navSubItem.patternPartial = 'viewall-' + bucketName + '-' + pattern.patternSubGroup;
-
-				// 			//add the navSubItem
-				// 			console.log(navSubItem);
-				// 			navItem.navSubItems.push(navSubItem);
-				// 			navItem.navSubItemsIndex.push('View All');
-				// 	} 	
-				// }
 			}
 
-			//VIEW ALL LOGIC CAN LOOP THROUGH PATTERNS TOO
-			//only add if it's an atom, molecule, or organism
-			// if(pattern.patternGroup === 'atoms' || pattern.patternGroup === 'molecules' || pattern.patternGroup === 'organisms'){
-			// 	if(patternlab.viewAllPaths[pattern.patternGroup]){
-					
-			// 		//add the pattern sub-group
-			// 		patternlab.viewAllPaths[pattern.patternGroup][pattern.patternSubGroup] = pattern.flatPatternPath;
-			// 	}
-			// 	else{
-			// 		//add the new group then the subgroup
-			// 		patternlab.viewAllPaths[pattern.patternGroup] = {};
-			// 		patternlab.viewAllPaths[pattern.patternGroup][pattern.patternSubGroup] = pattern.flatPatternPath;
-			// 	}
-			// }
-
 		};
 
 		//the patternlab site requires a lot of partials to be rendered.
@@ -357,9 +327,10 @@ module.exports = function(grunt) {
 		});
 		grunt.file.write('./public/index.html', patternlabSiteHtml);
 
-		//debug
-		var outputFilename = './patternlab.json';
-		grunt.file.write(outputFilename, JSON.stringify(patternlab, null, 3));
-
+		//debug file can be written by setting flag on package.json
+		if(patternlab.package.debug){
+			var outputFilename = './patternlab.json';
+			grunt.file.write(outputFilename, JSON.stringify(patternlab, null, 3));
+		}
 	});
 };

package.json

@@ -1,7 +1,7 @@
 {
   "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": "0.1.0",
+  "version": "0.1.1",
   "devDependencies": {
     "grunt": "~0.4.0",
     "grunt-contrib-watch": "~0.2.0",
@@ -20,12 +20,17 @@
     "Grunt",
     "Javascript"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/pattern-lab/patternlab-node.git"
+  },
   "author": "Brian Muenzenmeyer",
   "license": "MIT",
   "scripts": {
     "test" : "grunt travis --verbose"
   },
   "engines": {
     "node": ">=0.8"
-  }
+  },
+  "debug": false
 }