work in progress

readme updates
dependency cleanup
started work on grunt file. can talk to API. pl-serve not yet working

Author: bmuenzenmeyer

Gruntfile.js

@@ -1,14 +1,68 @@
+/******************************************************
+ * PATTERN LAB NODE
+ * EDITION-NODE-GRUNT
+ * The grunt wrapper around patternlab-node core, providing tasks to interact with the core library and move supporting frontend assets.
+******************************************************/
+
 module.exports = function (grunt) {
 
-  var path = require('path');
+  var path = require('path'),
+      argv = require('minimist')(process.argv.slice(2));;
+
+  /******************************************************
+   * PATTERN LAB CONFIGURATION
+  ******************************************************/
+
+  //read all paths from our namespaced config file
+  var config = require('./patternlab-config.json'),
+    pl = require('patternlab-node')(config);
 
   function paths() {
     return require('./patternlab-config.json').paths;
   }
 
-  // Project configuration.
+  function getConfiguredCleanOption() {
+    return config.cleanPublic;
+  }
+
+  grunt.registerTask('patternlab', 'create design systems with atomic design', function (arg) {
+
+    if (arguments.length === 0) {
+      pl.build(getConfiguredCleanOption());
+    }
+
+    if (arg && arg === 'version') {
+      pl.version();
+    }
+
+    if (arg && arg === "patternsonly") {
+      pl.patternsonly(getConfiguredCleanOption());
+    }
+
+    if (arg && arg === "help") {
+      pl.help();
+    }
+
+    if (arg && arg === "starterkit-list") {
+      pl.liststarterkits();
+    }
+
+    if (arg && arg === "starterkit-load") {
+      pl.loadstarterkit(argv.kit);
+    }
+
+    if (arg && (arg !== "version" && arg !== "patternsonly" && arg !== "help" && arg !== "starterkit-list" && arg !== "starterkit-load")) {
+      pl.help();
+    }
+  });
+
+
   grunt.initConfig({
     pkg: grunt.file.readJSON('package.json'),
+
+    /******************************************************
+     * COPY TASKS
+    ******************************************************/
     copy: {
       main: {
         files: [
@@ -26,6 +80,9 @@ module.exports = function (grunt) {
         ]
       }
     },
+    /******************************************************
+     * SERVER AND WATCH TASKS
+    ******************************************************/
     watch: {
       all: {
         files: [
@@ -91,11 +148,15 @@ module.exports = function (grunt) {
   // load all grunt tasks
   require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
 
-  //load the patternlab task
-  require('./core/lib/patternlab_grunt')(grunt);
 
-  grunt.registerTask('default', ['patternlab', 'copy:main', 'copy:styleguide']);
+  /******************************************************
+   * COMPOUND AND ALIASED TASKS
+  ******************************************************/
 
-  grunt.registerTask('serve', ['patternlab', 'copy:main', 'copy:styleguide', 'browserSync', 'watch:all']);
+  grunt.registerTask('default', ['patternlab', 'copy:main', 'copy:styleguide']);
+  grunt.registerTask('pl-serve', ['patternlab', 'copy:main', 'copy:styleguide', 'browserSync', 'watch:all']);
 
+  //Aliases
+  grunt.registerTask('pl-help', ['patternlab:help']);
+  grunt.registerTask('pl-patterns', ['patternlab:patternsonly']);
 };

README.md

@@ -1,6 +1,92 @@
-# edition-node-grunt
-The grunt wrapper around patternlab-node core.
+# Pattern Lab Node - Grunt Edition
 
-**Work In Progress** **Unstable** **Infantile** **Borked**
+The Grunt wrapper around [Pattern Lab Node Core](https://github.com/pattern-lab/patternlab-node), currently in 2.0.0-alpha, providing tasks to interact with the core library and move supporting frontend assets.
 
-Be warned, this is work-in-progress development, aligning with the broader [Pattern Lab Node Roadmap](https://github.com/pattern-lab/patternlab-node/wiki/Roadmap#v2xx-upcoming--future).
+## Packaged Components
+
+The Grunt Edition comes with the following components:
+
+* `patternlab-node`: [GitHub](https://github.com/pattern-lab/patternlab-node), [npm](https://www.npmjs.com/package/patternlab-node)
+* `patternengine-node-mustache`: [GitHub](https://github.com/pattern-lab/patternengine-node-mustache), [npm](https://www.npmjs.com/package/patternengine-node-mustache)
+* `pattern-lab/styleguidekit-assets-default`: [GitHub](https://github.com/pattern-lab/styleguidekit-assets-default)
+* `pattern-lab/styleguidekit-mustache-default`: [GitHub](https://github.com/pattern-lab/styleguidekit-mustache-default)
+
+## Prerequisites
+
+Pattern Lab Node uses [Node](https://nodejs.org) and  [npm](https://www.npmjs.com/) to manage project dependencies, and [grunt](http://gruntjs.com/) to run tasks and interface with core.
+
+Please follow the directions for [installing Node](https://nodejs.org/en/download/) on the Node website. This should include `npm`.
+
+It's also highly recommended that you [install grunt](http://gruntjs.com/getting-started) globally.
+
+## Installing
+
+There are two methods for downloading and installing the Grunt Edition:
+
+* [Download a pre-built package](#download-a-pre-built-package)
+* [Use npm](#use-npm)
+
+### Download a pre-built package
+
+The fastest way to get started with the Grunt Edition is to [download the pre-built version](https://github.com/pattern-lab/edition-node-gulp/releases) from the [releases page](https://github.com/pattern-lab/edition-node-gulp/releases). The pre-built project comes with the [Default Starterkit for Mustache](https://github.com/pattern-lab/starterkit-mustache-default/tree/dev) installed by default.
+
+**Please note:** Pattern Lab Node uses [npm](https://www.npmjs.com/) to manage project dependencies. To upgrade the Grunt Edition or to install plug-ins you'll need to be familiar with npm.
+
+### Use npm
+
+`npm` is a dependency management and package system which can pull in all of the Grunt Edition's dependencies for you. To accomplish this:
+
+* download or clone this repository to an install location.
+
+* run the following
+    cd install/location
+    npm install
+
+Running `npm install` from a directory containing a `package.json` file will download all dependencies defined within.
+
+#### Install the Grunt Edition of Pattern Lab Node as a Dependency
+
+Most people want to run Pattern Lab Node standalone and not as a dependency. If you wish to install as a dependency you can do the following:
+
+Use npm's [`install` command](https://docs.npmjs.com/cli/install) with an argument to install the Grunt Edition into a location of your choosing. In Terminal type:
+
+    cd install/location/
+    npm install edition-node-grunt
+
+This will install the Grunt Edition into a directory called `node_modules` in `install/location/`.
+
+## Updating Pattern Lab
+
+To update Pattern Lab please refer to each component's GitHub repository, and the [master instructions for core](https://github.com/pattern-lab/patternlab-node/wiki/Upgrading). The components are listed at the top of the README.
+
+## Helpful Commands
+
+These are some helpful commands you can use on the command line for working with Pattern Lab.
+
+### List all of the available commands
+
+To list all available commands type:
+
+    grunt pl-help
+
+### Generate Pattern Lab
+
+To generate the front-end for Pattern Lab type:
+
+    grunt pl-build
+
+### Watch for changes and re-generate Pattern Lab
+
+To watch for changes, re-generate the front-end, and server it via a BrowserSync server,  type:
+
+    grunt pl-serve
+
+BrowserSync should open [http://localhost:3000](http://localhost:3000) in your browser.
+
+### Install a StarterKit
+
+To install a specific StarterKit from GitHub type:
+
+    npm install [starterkit-vendor/starterkit-name]
+
+    grunt patternlab:starterkit-load --kit=[starterkit-name]

package.json

@@ -1,20 +1,19 @@
 {
   "name": "edition-node-grunt",
-  "description": "The grunt wrapper around patternlab-node core.",
-  "version": "0.1.0",
+  "description": "The grunt wrapper around patternlab-node core, providing tasks to interact with the core library and move supporting frontend assets.",
+  "version": "1.0.0",
   "main": "./core/lib/patternlab.js",
   "dependencies": {
     "bs-html-injector": "^3.0.0",
     "grunt": "~1.0.1",
     "grunt-browser-sync": "^2.2.0",
     "grunt-contrib-watch": "^1.0.0",
     "grunt-contrib-copy": "^1.0.0",
-    "patternlab-node": "pattern-lab/patternlab-node#dev-2.0-core",
-    "matchdep": "^1.0.0",
-    "mustache": "^2.2.0",
-    "handlebars": "^4.0.5",
-    "underscore": "^1.8.3",
-    "twig": "^0.9.5"
+    "minimist": "^1.2.0",
+    "patternlab-node": "pattern-lab/patternlab-node#v2.0.0-alpha",
+    "styleguidekit-assets-default": "pattern-lab/styleguidekit-assets-default#feature-panels",
+    "styleguidekit-mustache-default": "pattern-lab/styleguidekit-mustache-default#feature-panels",
+    "matchdep": "^1.0.0"
   },
   "keywords": [
     "Pattern Lab",

patternlab-config.json

@@ -4,6 +4,7 @@
       "root": "./source/",
       "patterns" : "./source/_patterns/",
       "data" : "./source/_data/",
+      "meta": "./source/_meta/",
       "annotations" : "./source/_annotations/",
       "styleguide" : "./node_modules/styleguidekit-assets-default/dist/",
       "patternlabFiles" : "./node_modules/styleguidekit-mustache-default/views/",
@@ -29,6 +30,7 @@
     "pages"
   ],
   "defaultPattern": "all",
+  "cleanPublic" : true,
   "patternExtension": "mustache",
   "ignored-extensions" : ["scss", "DS_Store", "less"],
   "ignored-directories" : ["scss"],
@@ -61,5 +63,6 @@
   "patternExportPatternPartials": [],
   "patternExportDirectory": "./pattern_exports/",
   "baseurl" : "",
-  "cacheBust": true
+  "cacheBust": true,
+  "starterkitSubDir": "dist"
 }