v1.0.0 - pattern lab - node

Pattern Lab Node v1.0.0

Version 1.0.0 is here! It's hard to believe, but it's time to tag this project. With styleModifiers and patternParameters a couple releases ago, Pattern Lab Node has really come up to snuff compared to the original Pattern Lab PHP system. Exciting work continues even as I write this on multiple other advancements, but I intend to fork this version and maintain it as the purest subset of original functionality.

Depending on the pace of patternEngine work and reorganizing the file system structure, we might be seeing 2.0.0 sooner than I imagined.

What's in a number? I'll be trying to follow semver quite closely, as multiple users from companies and agencies are using the library (which, by the way, is an impossibly humbling experience).

CHANGELOG

• FIX: Resolve issue with not hiding underscored patterns.
• THX: Thanks @ivancamilov for reporting this regression.
• FIX: Fix misapplied error input class
• THX: Thanks @johngerome for the pull request!
• ADD: Added a note in the README during installation to run with elevated privileges
• THX: Thanks @RichardBray for the heads up
• ADD: Added a Prerequisites section to the README
• ADD: Added unit tests for pattern states and pseudopatterns
• CHG: Changed pseudopattern generation to use config.patterns.source directory instead of hardcode
• CHG: Explicitly sorting patterns by name prior to building the UI
• ADD: Added ability to specify link.* urls inside data objects
• CHG: Incremented version to 1.0.0. Achieved near-parity with PL PHP v1!
• THX: Thanks to each and every person who cared about Pattern Lab Node! - Brian

Special thanks to @bradfrost and @dmolsen for encouragement, support, guidance, and motivation throughout the project.

UNIT TESTS/ASSERTIONS

14 more unit tests/assertions were added with this release.

UPGRADE INSTRUCTIONS

Assuming you are on v0.15.X, one should be able to update package.json for either grunt or gulp configurations and run npm update.

ROADMAP

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

❤️ from Brian - Follow me @bmuenzenmeyer

v0.15.1 - pattern lab - node

Pattern Lab Node v0.15.1

Version 0.15.1 is here with more robust to styleModifiers. It's a maintenance release and only needed if you heavily utilize styleModifiers + patternParameters within partials.

CHANGELOG

• FIX: Resolve issue with styleModifiers not being replaced when the partial has spaces in it.
• ADD: Support multiple styleModifier classes using the | pipe syntax
• FIX: Resolve issue with styleModifiers not being applied correctly when mixed with pattern parameters
• THX: Thanks @theorise for the issue reports!

UNIT TESTS

7 more unit tests were added with this release.

UPGRADE INSTRUCTIONS

Assuming you are on v0.15.X, one should be able to update package.json for either grunt or gulp configurations and run npm update.

ROADMAP

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

❤️ from @bmuenzenmeyer

v0.15.0 - pattern lab - node

Pattern Lab Node v0.15.0

Version 0.15.0 is here with support for Node 4.X and 5.X

I've been able to confirm patternlab working on node 4 and 5 using updated dependencies, and following I am tabulating on the wiki. Special shoutout to @tjunnone for the excellent npm-check-updates package which made this process much easier overall.

CHANGELOG

• CHG: Updated package.json devDependencies for Node 4.X and 5.X support.
• CHG: Updated package.gulp.json devDependencies for Node 4.X and 5.X support.

UNIT TESTS

0 more unit tests were added with this release. Travis CI was updated with two additional configurations, however.

UPGRADE INSTRUCTIONS

Assuming you are on v0.14.X, one should be able to update package.json for either grunt or gulp configurations and run npm update. For the paranoid like me, I like to blow away node_modules and run npm install. Let me know if you experience problems.

ROADMAP

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

v1.0.0

• ADD: Restructure filesystem to better align concerns and support upgrades
  • ADD: meta patterns missing?
• FINISH: Add More Unit Tests
• FIX: Look to see if example pattern vendor js needs to be updated
• MAYBE: adding multi-compiler functionality

❤️ from @bmuenzenmeyer

v0.14.0 - pattern lab - node

Pattern Lab Node v0.14.0

Version 0.14.0 lands with two major features!

PATTERN STYLE MODIFIERS

Style Modifiers allow you to create a base pattern that you can easily modify by adding a class name to the pattern partial. Read more about them here, including support with pattern parameters. Below is the gist.

The basic syntax is this:

{{> atoms-message:error }}

This works by using a reserved mustache variable of sorts called {{ styleModifier }} applied to the atoms-message mustache file itself:

<div class="message {{ styleModifier }}">{{ message }}</div>

Once rendered, it looks like this:

<div>
    <div class="message error"></div>
</div>

STYLE GUIDE EXCLUDES

Exclude whole pattern types from the "All patterns" styleguide by adding entries to config.json. This is quite useful to make speedier. Pattern Lab Node ships with the following:

"styleGuideExcludes": [
    "templates",
    "pages"
]

CHANGELOG

• ADD: Support for style modifiers
• ADD: Support for styleGuideExcludes
• THX: Thanks to @bramsmulders for the styleGuideExcludes pull request and @illepic for the original headsup
• FIX: Fix an issue where listitem blocks would only render if the pattern containing the block had a partial within it

UNIT TESTS

19 more unit tests were added with this release

UPGRADE INSTRUCTIONS

Assuming you are on v0.13.X, one should be safe following the upgrade instructions. Note the additional config entry inside `config.json.

ROADMAP

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

v1.0.0

• ADD: Restructure filesystem to better align concerns and support upgrades
  • ADD: meta patterns missing?
• FINISH: Add More Unit Tests
• FIX: Look to see if example pattern vendor js needs to be updated
• MAYBE: adding multi-compiler functionality

❤️ from @bmuenzenmeyer

v0.13.1 - pattern lab - node

Pattern Lab Node v0.13.1

CHANGELOG

• FIX: Allow verbose partials for list items
• THX: Thanks @e2tha-e
• ADD: Added some remarks about possible problems with Node v4.X

UPGRADE INSTRUCTIONS

This is a small maintenance release - you can likely skip it if not using verbose partial syntax.

Assuming you are on v0.13.0, one should be safe following the upgrade instructions.

Roadmap

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

❤️ from @bmuenzenmeyer

v0.13.0 - pattern lab - node

Pattern Lab Node v0.13.0

CHANGELOG

• FIX: Cleanup an old file and an incorrect entry in the .gitignore file
• CHG: Change order of pattern addition and ~variant pattern addition so they build naturally in the menu.
• THX: Thanks @e2tha-e for the flurry of pull requests!
• CHG: Update data merge function to prioritize handle pattern~variant.json files
• THX: Thanks @e2tha-e for finding, fixing, and unit testing the data merge issue.
• ADD: Support for recursive partial inclusion
• THX: Thanks @e2tha-e for making pattern inclusion a lot more robust. Great work!!!
• FIX: Improvements to style guide menu generation and capitalization.

UPGRADE INSTRUCTIONS

Assuming you are on v0.12.X, one should be safe following the upgrade instructions, in addition to overwriting these files when complete if you want some new capitalization goodness:

• /source/_patternlab-files/styleguide.mustache
• /source/_patternlab-files/viewall.mustache

Roadmap

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

❤️ from @bmuenzenmeyer

v0.12.0 - pattern lab - node

Pattern Lab Node v0.12.0

Choose Your Adventure - Vanilla, Grunt or Gulp!

Pattern Lab Node now comes with a Grunt or Gulp configuration that should help everyone either make the switch or do what's best for them. The default on download is still grunt, however.

CHANGELOG

• ADD: Gulp support arrives with an optional configuration
• ADD: Instructions how to install and run with Gulp
• DEL: Deleted the sass modules from package.json files
• CHG: Commented out all sass tasks in Grunt and Gulp files
• CHG: Changed static web server provider to BrowserSync
• CHG: Replaced the Style Guide toolbar Auto-Reload and Page Follow with a link to the BrowserSync UI
• THX: Thanks @oscar-g for the initial work on the gulpfile!
• ADD: An alternative, more verbose syntax for pattern partial inclusion
• THX: Thanks @e2tha-e for the thoughtful addition with unit test coverage

UPGRADE INSTRUCTIONS

Assuming you are on v0.11.X, one should be safe following the upgrade instructions, in addition to overwriting this file when complete:

• source/_patternlab-files/partials/ishControls.mustache

Roadmap

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

v0.11.0 - pattern lab - node

Pattern Lab Node v0.11.0

This release features full support for listitems, something missing since the beginning of the port but allows users to repeat items much easier. Enjoy!

CHANGELOG

• ADD: Ignore pattern directories that start with an underscore.
• ADD: Support for lists with the listItems variable
• FIX: Resolved issue where pattern parameter data bled into global data object
• ADD: Support a fluid viewport

UPGRADE INSTRUCTIONS

Like v0.10.X, normally one could be safe following the upgrade instructions, but this time we've changed some source/_patternlab-files/ directory files too. I have opened an issue to make this process smoother in the future. For now, you should be able to upgrade using the follow process:

1. Backup your source/ directory and config.json
2. Overwrite all of builder/ and public/ as normal
3. Refer to this pull request if you need help, but you'll essentially need to:
   • Add "baseurl" : "" to config.json
   • Overwrite source/_patternlab-files/pattern-header-footer/footer.html
   • Overwrite source/_patternlab-files/styleguide.mustache
   • Overwrite source/_patternlab-files/viewall.mustache

Roadmap

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

v0.10.1 - pattern lab - node

Pattern Lab Node v0.10.1

This is a small maintenance release that fixes a small bug with pattern parameter lineage. Many more unit tests were created to cover some recent functionality - though coverage is not complete yet.

CHANGELOG

• ADD: Added more unit tests for recently more-modular code
• FIX: Lineage was not working for patterns with pattern parameters

UPGRADE INSTRUCTIONS

Like v0.10.0, normally one could be safe following the upgrade instructions, but this time we've changed some source/_patternlab-files/ directory files too. I have opened an issue to make this process smoother in the future. For now, you should be able to upgrade using the follow process:

1. Backup your source/ directory and config.json
2. Overwrite all of builder/ and public/ as normal
3. Refer to this pull request if you need help, but you'll essentially need to:
   • Add "baseurl" : "" to config.json
   • Overwrite source/_patternlab-files/pattern-header-footer/footer.html
   • Overwrite source/_patternlab-files/styleguide.mustache
   • Overwrite source/_patternlab-files/viewall.mustache

Roadmap

Worth noting too is a roadmap that provides some clearer understanding of where the project is going in the next few releases.

v0.10.0 - pattern lab - node

Pattern Lab Node v0.10.0

A busy time here again - with an uptick in interest in the project and renewed focus from me. Your humble port maintainer wants to get to v1.0.0 like no-other!

CHANGELOG

• ADD: Added support for pattern parameters! Resolves #88
• FIX: Data inheritance is now working as advertised. Resolves #127. This turned out to be a MAJOR thing, as I realized the home-page was not passing down any of its json data to partials.
• CHG: Refactored a lot of code out of patternlab.js and into separate files. Doing so should make everything dryer, more unit testable, and easier to understand I hope.
• ADD: Added proper styling for the homepage-emergency alert that is displayed for demo purposes
• ADD: Added a new comment organism, the sticky comment, to ship an example of pattern parameters
• CHG: Start some JS linting of the project. I don't quite agree with a lot of it, so am trying to set some smart configurations
• CHG: Wrapped some build messages in the patternlab.config.debug flag
• FIX: Allow users to set a base url path. Resolves #125 (testing in the wild requested)
• THX: Thanks @scottnath for the proposed base url solution and @jkbyln for discussion on the topic too!

UPGRADE INSTRUCTIONS

Normally one could be safe following the upgrade instructions, but this time we've changed some source/_patternlab-files/ directory files too. I have opened an issue to make this process smoother in the future. For now, you should be able to upgrade using the follow process:

1. Backup your source/ directory and config.json
2. Overwrite all of builder/ and public/ as normal
3. Refer to this pull request if you need help, but you'll essentially need to:
   • Add "baseurl" : "" to config.json
   • Overwrite source/_patternlab-files/pattern-header-footer/footer.html
   • Overwrite source/_patternlab-files/styleguide.mustache
   • Overwrite source/_patternlab-files/viewall.mustache

Sorry for the inconvenience. I know this isn't ideal, but it's far from impossible. Perhaps if you don't need pattern parameter support or the base url you may choose to postpone an upgrade.

I put a lot of hours into this one - essentially rewriting the entire engine -hope you like what you see!