Ewl 3345 pattern lab php to node

styleguide/.editorconfig

@@ -0,0 +1,11 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+tab_width = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

styleguide/.eslintrc

@@ -0,0 +1,84 @@
+{
+  "env": {
+    "node": true,
+    "builtin": true,
+    "es6": true
+  },
+  "globals": {},
+  "rules": {
+    "block-scoped-var": 0,
+    "camelcase": 0,
+    "comma-spacing": [1, {"before": false, "after": true}],
+    "consistent-return": 2,
+    "curly": [2, "all"],
+    "dot-notation": [1, { "allowKeywords": true }],
+    "eqeqeq": [2, "allow-null"],
+    "global-strict": [0, "never"],
+    "guard-for-in": 2,
+    "indent": [1, 2, {"SwitchCase": 1, "VariableDeclarator": 1}],
+    "lines-around-comment": [1, {
+      "beforeBlockComment": true,
+      "beforeLineComment": true,
+      "allowBlockStart": true,
+      "allowObjectStart": true,
+      "allowArrayStart": true
+    }],
+    "key-spacing": 0,
+    "keyword-spacing": 1,
+    "new-cap": 0,
+    "no-alert": 2,
+    "no-bitwise": 2,
+    "no-caller": 2,
+    "no-cond-assign": [2, "except-parens"],
+    "no-debugger": 2,
+    "no-dupe-args": 2,
+    "no-dupe-keys": 2,
+    "no-empty": 2,
+    "no-eval": 2,
+    "no-extend-native": 2,
+    "no-extra-bind": 2,
+    "no-extra-parens": 0,
+    "no-extra-semi": 2,
+    "no-func-assign": 2,
+    "no-implied-eval": 2,
+    "no-invalid-regexp": 2,
+    "no-irregular-whitespace": 1,
+    "no-iterator": 2,
+    "no-loop-func": 2,
+    "no-mixed-requires": 0,
+    "no-multi-str": 2,
+    "no-multi-spaces": 1,
+    "no-native-reassign": 2,
+    "no-new": 2,
+    "no-param-reassign": 1,
+    "no-proto": 2,
+    "no-redeclare": 0,
+    "no-script-url": 2,
+    "no-self-assign": 2,
+    "no-self-compare": 2,
+    "no-sequences": 2,
+    "no-shadow": 2,
+    "no-undef": 2,
+    "no-underscore-dangle": 0,
+    "no-unreachable": 1,
+    "no-unused-vars": 1,
+    "no-use-before-define": 1,
+    "no-useless-call": 2,
+    "no-useless-concat": 2,
+    "no-with": 2,
+    "quotes": [0, "single"],
+    "radix": 2,
+    "semi": [0, "never"],
+    "strict": 0,
+    "space-before-blocks": 1,
+    "space-before-function-paren": [1, {
+      "anonymous": "always",
+      "named": "never"
+    }],
+    "space-in-parens": [1, "never"],
+    "space-infix-ops": 1,
+    "valid-typeof": 2,
+    "vars-on-top": 0,
+    "wrap-iife": [2, "inside"]
+  }
+}

styleguide/.github/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing to Patternlab Node
+If you'd like to contribute to Pattern Lab Node, please do so! There is always a lot of ground to cover and something for your wheelhouse.
+
+No pull request is too small. Check out any [up for grabs issues](https://github.com/pattern-lab/patternlab-node/labels/up%20for%20grabs) as a good way to get your feet wet, or add some more unit tests.
+
+## Guidelines
+1. Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier.
+2. _ALWAYS_ submit pull requests 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. If you have a major feature to stabilize over time, talk to @bmuenzenmeyer about making a dedicated `feature-branch`
+3. If you can, add some unit tests using the existing patterns in the `./test` directory
+
+##Coding style
+Two files combine within the project to define and maintain our coding style.
+
+* The `.editorconfig` controls spaces / tabs within supported editors. Check out their [site](http://editorconfig.org/).
+* The `.eslintrc` defines our javascript standards. Some editors will evaluate this real-time - otherwise it's run using `grunt|gulp build`

styleguide/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,12 @@
+<!-- before posting an issue, try chatting on https://gitter.im/pattern-lab/node -->
+<!-- before posting an issue, please check closed issues: https://github.com/pattern-lab/edition-node-gulp/issues?q=is%3Aissue+is%3Aclosed -->
+
+I am using Pattern Lab Node- Gulp Edition `vX.X.X` on `Windows|Mac|Linux`.
+
+##### Expected Behavior
+
+
+##### Actual Behavior
+
+
+##### Steps to Reproduce

styleguide/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+<!-- **Please read the contribution guidelines first, and target the `dev` branch!** -->
+
+Addresses #
+
+Summary of changes:

styleguide/.gitignore

@@ -0,0 +1,8 @@
+node_modules/
+.DS_Store
+patternlab.json
+.sass-cache/*
+/sass-cache
+Thumbs.db
+.idea/
+public

styleguide/LICENSE

@@ -1,20 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Brad Frost, http://bradfrostweb.com & Dave Olsen, http://dmolsen.com
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2016 Pattern Lab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

styleguide/README.md

@@ -1,93 +1,103 @@
-![license](https://img.shields.io/github/license/pattern-lab/edition-php-twig-standard.svg)
-[![Packagist](https://img.shields.io/packagist/v/pattern-lab/edition-twig-standard.svg)](https://packagist.org/packages/pattern-lab/edition-mustache-webdesignday) [![Gitter](https://img.shields.io/gitter/room/pattern-lab/php.svg)](https://gitter.im/pattern-lab/php)
-
-# Pattern Lab Standard Edition for Twig
-
-The Standard Edition for Twig gives developers and designers a clean and stable base from which to develop a Twig-based pattern library.
-
-## Packaged Components
-
-The Standard Edition for Twig comes with the following components:
-
-* `pattern-lab/core`: [GitHub](https://github.com/pattern-lab/patternlab-php-core), [Packagist](https://packagist.org/packages/pattern-lab/core)
-* `pattern-lab/patternengine-twig`: [documentation](https://github.com/pattern-lab/patternengine-php-twig#twig-patternengine-for-pattern-lab-php), [GitHub](https://github.com/pattern-lab/patternengine-php-twig), [Packagist](https://packagist.org/packages/pattern-lab/patternengine-twig)
-* `pattern-lab/styleguidekit-assets-default`: [GitHub](https://github.com/pattern-lab/styleguidekit-assets-default), [Packagist](https://packagist.org/packages/pattern-lab/styleguidekit-assets-default)
-* `pattern-lab/styleguidekit-twig-default`: [GitHub](https://github.com/pattern-lab/styleguidekit-twig-default), [Packagist](https://packagist.org/packages/pattern-lab/styleguidekit-twig-default)
-
-## Installing
-
-There are two methods for downloading and installing the Standard Edition for Twig:
-
-* [Download a pre-built project](#download-a-pre-built-package)
-* [Use Composer to create a project](#use-composer-to-create-a-project)
-
-### Download a pre-built project
-
-The fastest way to get started with the Standard Edition for Twig is to [download the pre-built version](https://github.com/pattern-lab/edition-php-twig-standard/releases) from the [releases page](https://github.com/pattern-lab/edition-php-twig-standard/releases). The pre-built project comes with the [Base StarterKit for Twig](https://github.com/pattern-lab/starterkit-twig-base) installed by default.
-
-**Please note:** Pattern Lab uses [Composer](https://getcomposer.org/) to manage project dependencies. To upgrade the Standard Edition for Twig or to install plug-ins you'll need to [install Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx). We recommend that you [install it globally](https://getcomposer.org/doc/00-intro.md#globally).
-
-### Use Composer to create a project
-
-Pattern Lab uses [Composer](https://getcomposer.org/) to manage project dependencies.
-
-#### 1. Install Composer
-
-Please follow the directions for [installing Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) on the Composer website. We recommend you [install it globally](https://getcomposer.org/doc/00-intro.md#globally).
-
-#### 2. Install the Standard Edition for Twig
-
-Use Composer's [`create-project` command](https://getcomposer.org/doc/03-cli.md#create-project) to install the Standard Edition for Twig into a location of your choosing. In Terminal type:
-
-    cd install/location/
-    composer create-project pattern-lab/edition-twig-standard your-project-name && cd $_
-
-This will install the Standard Edition for Twig into a directory called `your-project-name` in `install/location/`. During the set-up process you will be asked to install an appropriate StarterKit. You will be automatically dropped into the project directory after the process is finished.
-
-## Updating Pattern Lab
-
-To update Pattern Lab please refer to each component's GitHub repository. 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:
-
-    php core/console --help
-
-To list the options for a particular command type:
-
-    php core/console --help --[command]
-
-### Generate Pattern Lab
-
-To generate the front-end for Pattern Lab type:
-
-    php core/console --generate
-
-### Watch for changes and re-generate Pattern Lab
-
-To watch for changes and re-generate the front-end for Pattern Lab type:
-
-    php core/console --watch
-
-### Start a server to view Pattern Lab
-
-You can use PHP's built-in web server to review your Pattern Lab project in a browser. In a seperate window type:
-
-    php core/console --server
-
-Then open [http://localhost:8080](http://localhost:8080) in your browser.
-
-### Install a StarterKit
-
-To install a near-empty StarterKit as a starting point for your project type:
-
-    php core/console --starterkit --init
-
-To install a specific StarterKit from GitHub type:
-
-    php core/console --starterkit --install <starterkit-vendor/starterkit-name>
+# Pattern Lab Node - Gulp Edition
+
+The Gulp wrapper around [Pattern Lab Node Core](https://github.com/pattern-lab/patternlab-node) providing tasks to interact with the core library and move supporting frontend assets.
+
+## Packaged Components
+
+The Gulp 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
+
+The Pattern Lab Node - Gulp Edition uses [Node](https://nodejs.org) for core processing, [npm](https://www.npmjs.com/) to manage project dependencies, and [gulp.js](http://gulpjs.com/) to run tasks and interface with the core library. Node version 4 or higher suffices. You can follow the directions for [installing Node](https://nodejs.org/en/download/) on the Node website if you haven't done so already. Installation of Node will include npm.
+
+It's also highly recommended that you [install gulp](hhttps://github.com/gulpjs/gulp/blob/4.0/docs/getting-started.md) globally.
+
+> Note: The Gulp Edition of Pattern Lab uses Gulp 4, which may require a new global install of the Gulp command line interface. Follow the [gulp upgrade instructions](https://github.com/pattern-lab/edition-node-gulp/wiki/Updating-to-Gulp-4) if you already have gulp installed and need to upgrade. Gulp 4 is in alpha, but brings many benefits to the table and is relatively stable. You can alternatively [run with local gulp instead of global gulp](https://github.com/pattern-lab/patternlab-node/wiki/Running-with-Local-Gulp-Instead-of-Global-Gulp), but commands are a bit more verbose. The rest of this documentation assumes a global install.
+
+## Installing
+
+There are two methods for downloading and installing the Gulp 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 Gulp 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 [Base Starterkit for Mustache](https://github.com/pattern-lab/starterkit-mustache-base) installed by default.
+
+**Please note:** Pattern Lab Node uses [npm](https://www.npmjs.com/) to manage project dependencies. To upgrade the Gulp 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 Gulp Edition's dependencies for you. To accomplish this:
+
+* download or `git 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 Gulp 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 Gulp Edition into a location of your choosing. In Terminal type:
+
+    cd install/location/
+    npm install edition-node-gulp
+
+This will install the Gulp Edition into a directory called `node_modules` in `install/location/`.
+
+## Getting Started
+
+The Pattern Lab Node - Gulp Edition ships with a [base experience](https://github.com/pattern-lab/starterkit-mustache-base) which serves as clean place to start from scratch with Pattern Lab. But if you want to get rolling with a starterkit of your own, or use the [demo starterkit](https://github.com/pattern-lab/starterkit-mustache-demo) like the one on [demo.patternlab.io](http://demo.patternlab.io), you can do so automatically at time of `npm install` by adding your starterkit to the `package.json` file.
+
+You can also [work with starterkits using the command line](https://github.com/pattern-lab/patternlab-node/wiki/Importing-Starterkits).
+
+## 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.
+
+> Reminder: These commands assume a global installation of gulp 4.X, instead of a local installation. Depending on your preference, you may need to [upgrade your global version of gulp](https://github.com/pattern-lab/edition-node-gulp/wiki/Updating-to-Gulp-4) or [run with local gulp](https://github.com/pattern-lab/patternlab-node/wiki/Running-with-Local-Gulp-Instead-of-Global-Gulp).
+
+### List all of the available commands
+
+To list all available commands type:
+
+    gulp patternlab:help
+
+### Generate Pattern Lab
+
+To generate the front-end for Pattern Lab type:
+
+    gulp patternlab: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:
+
+    gulp patternlab: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]
+
+    gulp patternlab:loadstarterkit --kit=[starterkit-name]

styleguide/build.config.json

@@ -50,7 +50,7 @@
     "files": [
       "source/assets/icons/svg/*.svg"
     ],
-    "min"  : "public/assets/icons/svg/", 
+    "min"  : "public/assets/icons/svg/",
     "dest" : "public/assets/icons/"
   },
   "images": {
@@ -73,4 +73,4 @@
       "source/_data/*.json"
     ]
   }
-}
+}