Pattern Lab UIKit, CLI, and Core Updates!

# packages updated 
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - [email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]

🐛 Bug Fixes

• fix(plugin): correct spelling error and function locations #998 (@enigmatic @bmuenzenmeyer)
• @pattern-lab/uikit-workshop@null
  • Fix: Don't Auto-flatten UIKit Navigation Folders That Only Contain 1 Item #1058 (@sghoweri)
• @pattern-lab/uikit-workshop@null
  • fix(1060): Fix alignment of pattern state dots #1061 (@dcmouyard @bmuenzenmeyer)
• @pattern-lab/cli@null, @pattern-lab/core@null, @pattern-lab/plugin-tab@null, @pattern-lab/uikit-workshop@null
  • 🔌 #1066 (@enigmatic @bmuenzenmeyer)
• @pattern-lab/cli@null, @pattern-lab/core@null, @pattern-lab/engine-handlebars@null, @pattern-lab/engine-mustache@null, @pattern-lab/live-server@null
  • Feature update dependencies #1059 (@JosefBredereck @enigmatic)
• @pattern-lab/cli@null
  • fix(cli): allow any package to be installed as a starterkit

Let any package be installed as a Patternlab starterkit. (#1067) #1067 (@ringods)

Misc

• [skip travis] chore(release): publish %s (@sghoweri)
• fix: add repo info to root package.json so Auto knows what repo to configure for (@sghoweri)
• chore: ignore .env files + wire up basic automatic Github release notes using Auto when publishing (@sghoweri)

Authors: 6

• Brian Muenzenmeyer (@bmuenzenmeyer)
• Salem Ghoweri (@sghoweri)
• Dan Mouyard (@dcmouyard)
• Matt Couch (@enigmatic)
• Ringo De Smet (@ringods)
• Josef Bredreck (@JosefBredereck)

Pattern Lab UIKit v1.0.4 Released

This is a patch release for Pattern Lab's UIKit which primarily includes updates from #1053 and #1047 to address the following:

1. Updates the Viewport component to use the Pattern Lab defaultPattern config (if it exists) when setting up the iframe URL that initially loads. Fixes #1050 reported by @thethomic

2. Updates the Nav component to display the top level All link by default unless the ishControlsHide['views-all] config option is enabled 😉. Fixes #1048 reported by @coreylafferty

3. Fixes a Pattern query string-related issue where the top most All page doesn't always include the name of that page's "pattern" which the iframe emits the patternLoad event, resulting in that page never getting it's full URL replaced with pattern-specific query string when the page loads (ie. ?p=NAME).

4. Fixes an issue in UIKit's Prism.js logic to correctly fall back to using markup for syntax highlighting when encountering an unsupported templating language. Addresses a recent bug reported by @thethomic on Gitter.

5. Ports over a recent UIkit fix from https://github.com/bolt-design-system/bolt which automatically defaults the viewport resizer to 100% the screen width the very first time PL is opened / if any custom viewport sizes haven't previously been set / when server-side rendering. Addresses one of the issues reported by @cbirdsong on Gitter a couple days ago.

Issues Closed:

• #1050
• #1048

Special thanks to @thethomic, @coreylafferty, @cbirdsong, and @bmuenzenmeyer for their help on this!

Pattern Lab "v3.0.0-beta.3" Released!

Summary of changes:

• Fixed 404 when running pattern lab from a non-root directory #1006
• Added the functionality to separate the patterns from each other by adding the support for a capsulation folder by pattern. Also added tests. #992
• Add cachebuster back to footer data #1010
• Fix issues with multiple inline svgs in live-server injection #1012

 Packages Published:
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - [email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]
 - @pattern-lab/[email protected]

Special thanks to @malcomio, @ringods, @mdmccarley89, @enigmatic, @reubenmoes, and @mariohernandez!

**I know I'm saying v3.0.0-beta.3 but because previous Pattern Lab Node releases were published with package version numbers scattered all over the place, technically we are somewhere between.... v0.03 and v3.1.1 😰...

That said, I'd really like to see us get our package version numbers all on the exact same page (even if that means we are at v4.0.0) -- we'll get there!

Pattern Lab Node v3.0.0-alpha.8

• ✨ Added ability to copy pattern's optional Javascript file. Thanks @raphaelokon !
  • Passing patternPartial to a pattern's render allows for behavior like the following in the meta patterns:

  <body class="{{ bodyClass }} {{ patternPartial }}">

  or

  <script>if ('{{patternPartial}}' === 'pages-splash') { ... }</script>
  

• 🐛 👢 💥 Watched pattern.json not triggering a re-render
• More bug fixes and stability added to watches and events emitted as part of watched files.

🛑 I'll repeat the warning I provided last time. This is alpha software - but we are rapidly approaching a stable state!

Stay on 2.X if you cannot afford the disruption.
Stable gulp edition: https://github.com/pattern-lab/edition-node-gulp/releases/tag/v1.3.4

CHANGELOG 🎯

I am now using standard-version to generate this for me.

Pattern Lab Node Core Alpha 7 and...

CHANGELOG

KNOWN ISSUES: 2, help test!

UPGRADE INSTRUCTIONS ⌨️

Follow the standard upgrade instructions.

INSTALLATION 📦

DIRECT CONSUMPTION

As of Pattern Lab Node 3.X, patternlab-node can run standalone, without the need for task runners like gulp or grunt.

npm install @pattern-lab/patternlab-node

See Usage for more information.
See a complete standalone example of working directly with patternlab-node.

Editions

For users wanting a more pre-packaged experience several editions are available.

• Pattern Lab/Node: Gulp Edition contains info how to get started within a Gulp task running environment.
• Pattern Lab/Node: Grunt Edition contains info how to get started within a Grunt task running environment.
• Pattern Lab/Node: Vanilla Edition contains info how to get started within a pure node environment.
• Pattern Lab/Node: Webpack Edition contains info how to get started within a webpack environment.

  Thanks to the team at Comcast for open-sourcing this stellar work!

UNIT TESTS / ASSERTIONS / CODE COVERAGE 🏗

• 6 unit test(s) / assertion(s) added, for a total of 518 | travis ci
• Increased (+1.2%) to 73.224% | coveralls

ROADMAP 🗺

Keep an eye on the milestones for a clearer understanding of where the project is going in the next few releases.

SUPPORT PATTERN LAB NODE ❤️

I've set up a Patreon account to directly support continued work on the Pattern Lab Node project.

I need help and support to make Pattern Lab Node a sustained success. I devote a lot of free time and would-be sleep to make the project what it is, but nothing compares to hearing back from users. It means the world to me when people find value in Pattern Lab Node. I am ridiculously humbled to hear and see what you all build with it.

If you find yourself here and balk and the idea of supporting open source software monetarily - I understand. Carry on, but please do share what you build - we all learn more together.

• Pattern Lab on Patreon

---

The Pattern Lab Node Team 🚀

• @bmuenzenmeyer Brian Muenzenmeyer, Lead Maintainer | Follow Brian on Twitter
• @geoffp Geoff Pursell, Core Contributor | Follow Geoff on Twitter
• @raphaelokon Raphael Okon, CLI Contributor | Follow Raphael on Twitter
• @tburny, Core Contributor

Pattern Lab Node v3.0.0-alpha.7

This release chases the tail of alpha.6, thanks to some dev time provided by my super awesome employer 🎯

Alpha.6 exposed some flaws with List Items. I believe them to be fixed. Native mustache looping does not appear to be working as illustrated within http://demo.patternlab.io/?p=pages-homepage. I need to yet look at that - but the demo site does not use listItems at all.

I'll repeat the warning I provided last time. This is alpha software - but we are rapidly approaching a stable state!

Stay on 2.X if you cannot afford the disruption.
Stable gulp edition: https://github.com/pattern-lab/edition-node-gulp/releases/tag/v1.3.4

CHANGELOG 🎯

I am now using standard-version to generate this for me.

Pattern Lab Node Core Alpha 6 and...

CHANGELOG

Potentially Breaking Change

Prior to this release, I would accept listitems.number or listItems.number as a valid listItem. Per the documentation we now only support listItems.

UPGRADE INSTRUCTIONS ⌨️

Follow the standard upgrade instructions.

INSTALLATION 📦

DIRECT CONSUMPTION

As of Pattern Lab Node 3.X, patternlab-node can run standalone, without the need for task runners like gulp or grunt.

npm install @pattern-lab/patternlab-node

See Usage for more information.
See a complete standalone example of working directly with patternlab-node.

Editions

For users wanting a more pre-packaged experience several editions are available.

• Pattern Lab/Node: Gulp Edition contains info how to get started within a Gulp task running environment.
• Pattern Lab/Node: Grunt Edition contains info how to get started within a Grunt task running environment.
• Pattern Lab/Node: Vanilla Edition contains info how to get started within a pure node environment.
• Pattern Lab/Node: Webpack Edition contains info how to get started within a webpack environment.

  Thanks to the team at Comcast for open-sourcing this stellar work!

UNIT TESTS / ASSERTIONS / CODE COVERAGE 🏗

• 1 unit test(s) / assertion(s) removed, for a total of 512 | travis ci
• Decreased (-0.1%) to 72.028% | coveralls

ROADMAP 🗺

Keep an eye on the milestones for a clearer understanding of where the project is going in the next few releases.

SUPPORT PATTERN LAB NODE ❤️

I've set up a Patreon account to directly support continued work on the Pattern Lab Node project.

I need help and support to make Pattern Lab Node a sustained success. I devote a lot of free time and would-be sleep to make the project what it is, but nothing compares to hearing back from users. It means the world to me when people find value in Pattern Lab Node. I am ridiculously humbled to hear and see what you all build with it.

If you find yourself here and balk and the idea of supporting open source software monetarily - I understand. Carry on, but please do share what you build - we all learn more together.

• Pattern Lab on Patreon

---

The Pattern Lab Node Team 🚀

• @bmuenzenmeyer Brian Muenzenmeyer, Lead Maintainer | Follow Brian on Twitter
• @geoffp Geoff Pursell, Core Contributor | Follow Geoff on Twitter
• @raphaelokon Raphael Okon, CLI Contributor | Follow Raphael on Twitter
• @tburny, Core Contributor

Pattern Lab Node v3.0.0-alpha.6

This is a big release.

BIG!

It's the first time Pattern Lab Node has supported asynchronous rendering. Why does this matter? Pattern Lab Node was written synchronously, with only Mustache in mind, many years ago. Async rendering allows the entire engine to work with PatternEngines / templating languages that require more processing, or only ever supported Promises. Think, React, Liquid, and even Twig powered by a real PHP engine. This is the culmination of a TON of work spearheaded by @geoffp. I cannot thank him enough for his support through the years.

Async rendering also finally put the last nail in the coffin ⚰️ for my original pattern parameter algorithm, exposing it as flawed and naive. I've fixed that in this release. Please report any bugs you encounter with pattern parameters.

KNOWN ISSUE 🙉 🙊 🙈 List Items Not Working Perfectly

Since I updated the pattern parameter algorithm, it became evident that the list item algorithm suffered from the same flaw. Rather than sit on this release longer, which is causing folks problems and then some, I am opting to release now for feedback and as a stagegate.

Follow #772 for progress.

Stay on 2.X if you cannot afford the disruption.

Stable gulp edition: https://github.com/pattern-lab/edition-node-gulp/releases/tag/v1.3.4

CHANGELOG 🎯

Pattern Lab Node Core Alpha 5 and...

• ADD: First couple of unit tests for the React engine | @geoffp
• CHG: Support Async Rendering | @bmuenzenmeyer
• CHG: Rework Pattern Parameter Algorithm | @bmuenzenmeyer
• CHG: Separate patternlab.js into two files | @bmuenzenmeyer
  • patternlab.js now only contains the class
  • index.js will contain a cleaner public entry point.
• FIX: Fix directory duplication when serving files | @raphaelokon, @danwhite85 for issue report
• FIX: Use patterns created by processMetaPattern for rendering | @danwhite85
• DEL: Remove postinstall.js | @raphaelokon

UPGRADE INSTRUCTIONS ⌨️

Follow the standard upgrade instructions.

INSTALLATION 📦

DIRECT CONSUMPTION

As of Pattern Lab Node 3.X, patternlab-node can run standalone, without the need for task runners like gulp or grunt.

npm install @pattern-lab/patternlab-node

See Usage for more information.
See a complete standalone example of working directly with patternlab-node.

Editions

For users wanting a more pre-packaged experience several editions are available.

• Pattern Lab/Node: Gulp Edition contains info how to get started within a Gulp task running environment.
• Pattern Lab/Node: Grunt Edition contains info how to get started within a Grunt task running environment.
• Pattern Lab/Node: Vanilla Edition contains info how to get started within a pure node environment.
• Pattern Lab/Node: Webpack Edition contains info how to get started within a webpack environment.

  Thanks to the team at Comcast for open-sourcing this stellar work!

UNIT TESTS / ASSERTIONS / CODE COVERAGE 🏗

• 27 unit tests / assertions were added, for a total of 513 | travis ci
• Decreased (-0.4%) to 72.153% | coveralls

ROADMAP 🗺

Keep an eye on the milestones for a clearer understanding of where the project is going in the next few releases.

SUPPORT PATTERN LAB NODE ❤️

I've set up a Patreon account to directly support continued work on the Pattern Lab Node project.

I need help and support to make Pattern Lab Node a sustained success. I devote a lot of free time and would-be sleep to make the project what it is, but nothing compares to hearing back from users. It means the world to me when people find value in Pattern Lab Node. I am ridiculously humbled to hear and see what you all build with it.

If you find yourself here and balk and the idea of supporting open source software monetarily - I understand. Carry on, but please do share what you build - we all learn more together.

• Pattern Lab on Patreon

---

The Pattern Lab Node Team 🚀

• @bmuenzenmeyer Brian Muenzenmeyer, Lead Maintainer | Follow Brian on Twitter
• @geoffp Geoff Pursell, Core Contributor | Follow Geoff on Twitter
• @raphaelokon Raphael Okon, CLI Contributor | Follow Raphael on Twitter
• @tburny, Core Contributor

Pattern Lab Node v3.0.0-alpha.5

CHANGELOG 🎯

Pattern Lab Node Core Alpha 4 and...

• ADD: Add getDefaultConfig function to core | @raphaelokon
• CHG Add jsdoc comments to annotation_exporter | @nielsonm
• CHG Add jsdoc comments to pattern_engines | @nielsonm
• CHG: Alphabetize and set defaults for patternlab-config.json | @bmuenzenmeyer
• CHG: Update link to configuration documentation in README | @raphaelokon
• CHG: Refactor the root Pattern Lab build into a proper class | @geoffp
• CHG: Improve Logging | @bmuenzenmeyer
• FIX: Prevent pseudopatterns polluting their base patterns | @bmuenzenmeyer
• DEL: Remove the callback from build and patternsonly in favor of the promise | @bmuenzenmeyer

UPGRADE INSTRUCTIONS ⌨️

Follow the standard upgrade instructions.

INSTALLATION 📦

DIRECT CONSUMPTION

As of Pattern Lab Node 3.X, patternlab-node can run standalone, without the need for task runners like gulp or grunt.

npm install @pattern-lab/patternlab-node

See Usage for more information.
See a complete standalone example of working directly with patternlab-node.

Editions

For users wanting a more pre-packaged experience several editions are available.

• Pattern Lab/Node: Gulp Edition contains info how to get started within a Gulp task running environment.
• Pattern Lab/Node: Grunt Edition contains info how to get started within a Grunt task running environment.
• Pattern Lab/Node: Vanilla Edition contains info how to get started within a pure node environment.
• Pattern Lab/Node: Webpack Edition contains info how to get started within a webpack environment.

  Thanks to the team at Comcast for open-sourcing this stellar work!

UNIT TESTS / ASSERTIONS / CODE COVERAGE 🏗

• 3 unit tests / assertions were added, for a total of 486 | travis ci
• Increased (+2.04%) to 72.583% | coveralls

ROADMAP 🗺

Keep an eye on the milestones for a clearer understanding of where the project is going in the next few releases.

SUPPORT PATTERN LAB NODE ❤️

I've set up a Patreon account to directly support continued work on the Pattern Lab Node project.

I need help and support to make Pattern Lab Node a sustained success. I devote a lot of free time and would-be sleep to make the project what it is, but nothing compares to hearing back from users. It means the world to me when people find value in Pattern Lab Node. I am ridiculously humbled to hear and see what you all build with it.

If you find yourself here and balk and the idea of supporting open source software monetarily - I understand. Carry on, but please do share what you build - we all learn more together.

• Pattern Lab on Patreon

---

The Pattern Lab Node Team 🚀

• @bmuenzenmeyer Brian Muenzenmeyer, Lead Maintainer | Follow Brian on Twitter
• @geoffp Geoff Pursell, Core Contributor | Follow Geoff on Twitter
• @raphaelokon Raphael Okon, CLI Contributor | Follow Raphael on Twitter
• @tburny, Core Contributor

Pattern Lab Node v3.0.0-alpha.4

It's Hacktoberfest!. Find issues you can help with here and get a free T-Shirt.

CHANGELOG 🎯

Pattern Lab Node Core Alpha 3 and...

• ADD: Adding better traverse for pattern engines | @raphaelokon
• CHG: Change Travis CI to use scoped @pattern-lab PatternEngines | @bmuenzenmeyer

UPGRADE INSTRUCTIONS ⌨️

Follow the standard upgrade instructions.

INSTALLATION 📦

DIRECT CONSUMPTION

As of Pattern Lab Node 3.X, patternlab-node can run standalone, without the need for task runners like gulp or grunt.

npm install @pattern-lab/patternlab-node

See Usage for more information.
See a complete standalone example of working directly with patternlab-node.

Editions

For users wanting a more pre-packaged experience several editions are available.

• Pattern Lab/Node: Gulp Edition contains info how to get started within a Gulp task running environment.
• Pattern Lab/Node: Grunt Edition contains info how to get started within a Grunt task running environment.
• Pattern Lab/Node: Vanilla Edition contains info how to get started within a pure node environment.
• Pattern Lab/Node: Webpack Edition contains info how to get started within a webpack environment.

  Thanks to the team at Comcast for open-sourcing this stellar work!

UNIT TESTS / ASSERTIONS / CODE COVERAGE 🏗

• 0 unit tests / assertions were added, for a total of 483 | travis ci
• Increased (+0.4%) to 70.54% | coveralls

ROADMAP 🗺

Keep an eye on the milestones for a clearer understanding of where the project is going in the next few releases.

SUPPORT PATTERN LAB NODE ❤️

I've set up a Patreon account to directly support continued work on the Pattern Lab Node project.

I need help and support to make Pattern Lab Node a sustained success. I devote a lot of free time and would-be sleep to make the project what it is, but nothing compares to hearing back from users. It means the world to me when people find value in Pattern Lab Node. I am ridiculously humbled to hear and see what you all build with it.

If you find yourself here and balk and the idea of supporting open source software monetarily - I understand. Carry on, but please do share what you build - we all learn more together.

• Pattern Lab on Patreon

---

The Pattern Lab Node Team 🚀

• @bmuenzenmeyer Brian Muenzenmeyer, Lead Maintainer | Follow Brian on Twitter
• @geoffp Geoff Pursell, Core Contributor | Follow Geoff on Twitter
• @raphaelokon Raphael Okon, CLI Contributor | Follow Raphael on Twitter
• @tburny, Core Contributor

Pattern Lab Node v3.0.0-alpha.3

Pattern Lab Node v3.0.0-alpha.3

It's Hacktoberfest!. Find issues you can help with here and get a free T-Shirt.

⚡ ⚡ ⚡ It's finally here - Pattern Lab Node Core 3.0.0! ⚡ ⚡ ⚡

I've been tracking work against #603 and our milestone for quite a while, and now I finally feel like we've reached a point that we can release a preview of what's to come. There is still work to do and I am certain some bugs to work out - but gathering feedback from y'all is a vital next step! There will be a general shakeup (for the better I think( of things in the Edition space - for example. We now also have a coming together of all our development paths - making future work far simpler to orchestrate and get out faster.

Let's address opportunities brought up within #603 and discuss the state of affairs.

It's too hard to use Pattern Lab as a dependency

As of Pattern Lab Node 3.X, patternlab-node can run standalone, without the need for task runners like gulp or grunt.

const config = require('./patternlab-config.json');
const patternlab = require('patternlab-node')(config);


// build, optionally watching or choosing incremental builds
patternlab.build({
  cleanPublic: true,
  watch: true
});

// or build, watch, and then self-host
patternlab.serve({
  cleanPublic: true
});

While much of this API always existed, now core is responsible for copying (and optionally watching) assets, meta files, data, and patterns defined within patternlab-config.json paths. This means that you no longer need gulp, grunt, or any task manager if you dont want to.

Have sass you need to compile? Images you want to optimize? Do it within your existing build chain. Pattern Lab has never endeavored to do that work for you. Pattern Lab now seamlessly integrates into your workflow without having to merge complicated internal tasks.

Want to know what Pattern Lab is doing with assets? Done.

patternlab.serve(...);

patternlab.events.on('patternlab-asset-change', (data) => {
  console.log(data); // {file: 'path/to/file.css', dest: 'path/to/destination'}
});

patternlab.events.on('patternlab-pattern-change', (data) => {
  console.log(data); // {file: 'path/to/file.ext'}
});

patternlab.events.on('patternlab-global-change', (data) => {
  console.log(data); // {file: 'path/to/file.ext'}
});

More events are documented on the wiki. I imagine only more will be added now that we have exposed this to consumers.

Pattern Lab build times are increasingly slow with increasing numbers and complexity of patterns

Incremental builds and complete async building should help realize results. Now that the core work has merged a bit too, I know we can devote more energy to performance.

Staying "up to date" with edition-node-gulp/editon-node-grunt is too difficult

Editions are example pairings of Pattern Lab code as part of the Pattern Lab Ecosystem. They were never intended to be installed as dependencies. They are perfect for pre-packaged experiences, and that is what they will remain. I'm excited to say that we now have robust Editions and a robust core - both capable of meeting users where they need to.

Customizing the Pattern Lab UI is not intuitive or for the casual user

Brad is hard at work making this a reality. Pattern Lab Node Core 3.X will support this work as it evolves.

Pattern Lab Node plugin installation is a bit wonky

Plugin installation now adds additional settings to patternlab-config.json, making it far simpler to configure, disable, or delete a plugin after installation.

CHANGELOG 🎯

BREAKING CHANGES

• ADD: Move watches and source to public asset copying into core | @bmuenzenmeyer
• CHG: Specify template files via configuration | @bmuenzenmeyer
• DEL: Remove patternengine-node-mustache as shipped with core | @bmuenzenmeyer

INTERNAL

• ADD: Config access for pattern engines | @geoffp
• ADD: Alter each engine to spawn its meta patterns if not found | @bmuenzenmeyer
• ADD: Add support for pattern parameter links | @dagjaneiro, Hacktoberfest!\
• ADD: Document the public API | @bmuenzenmeyer
• ADD: More helpful json/yaml error messages | @phawxby
• feat(package): Add default theme config to patternlab-config.json #731 | @bmuenzenmeyer
• CHG: Change var to const or let | @benhalverson
• CHG: Improvement to plugin installation, supporting options right on patternlab-config.json | @bmuenzenmeyer
• CHG: Defer pattern engine load to the caller | @bmuenzenmeyer
• CHG: Replace common utils | @raphaelokon
• CHG: Remove excessive logs when bootstrapping core | @bmuenzenmeyer
• CHG: Allow engines to support multple extensions | @bmuenzenmeyer
• FIX: Fix broken lineage unit test(s) | @kingofzeal
• DEL: Finally remove deprecated pattern states logic from patternlab-config.json in favor of markdown | @benhalverson

TOOLING / META

• ADD: Add code coverage output to npm test | @benhalverson @raphaelokon
• ADD: Added coveralls support | @kingofzeal
• ADD: [Add coveralls badge to README)[https://github.com//pull/729] | @bmuenzenmeyer
• ADD: Add an .nvmrc file | @bmuenzenmeyer
• ADD: Add package-lock.json support | @bmuenzenmeyer, Hacktoberfest!
• CHG: Pin all dependencies | @ms10398, Hacktoberfest!
• ADD: Add branching scheme to contribution guidelines | @tburny
• CHG: Improved README and again | @bmuenzenmeyer

KNOWN ISSUES

• Pseudo-Patterns do not work in PL 2.11.0 and above

UPGRADE INSTRUCTIONS ⌨️

Follow the standard upgrade instructions.

INSTALLATION 📦

DIRECT CONSUMPTION

As of Pattern Lab Node 3.X, patternlab-node can run standalone, without the need for task runners like gulp or grunt.

npm install @pattern-lab/patternlab-node

See Usage for more information.

Editions

For users wanting a more pre-packaged experience several editions are available.

• Pattern Lab/Node: Gulp Edition contains info how to get started within a Gulp task running environment.
• Pattern Lab/Node: Grunt Edition contains info how to get started within a Grunt task running environment.
• Pattern Lab/Node: Vanilla Edition contains info how to get started within a pure node environment.
• Pattern Lab/Node: Webpack Edition contains info how to get started within a webpack environment.

  Thanks to the team at Comcast for open-sourcing this stellar work!

UNIT TESTS / ASSERTIONS / CODE COVERAGE 🏗

• 13 unit tests / assertions were removed, for a total of 483 | travis ci
• Decreased (-1.8%) to 70.17% | coveralls

ROADMAP 🗺

Keep an eye on the milestones for a clearer understanding of where the project is going in the next few releases.

SUPPORT PATTERN LAB NODE ❤️

I've set up a Patreon account to directly support continued work on the Pattern Lab Node project.

I need help and support to make Pattern Lab Node a sustained success. I devote a lot of free time and would-be sleep to make the projec...

Pattern Lab Node 3.0.0-alpha.2

See https://github.com/pattern-lab/patternlab-node/releases/tag/v3.0.0-alpha.3