Releases: pattern-lab/patternlab-node
v2.0.0-alpha.2 - pattern lab - node
Pattern Lab Node v2.0.0 ALPHA 2
CHANGELOG
- CHG: Added callback hooks to build and buildPatterns methods
- CHG: More explicitly deleting
paths.public.patterns/
when told to do so - ADD: Support a clean option when loading starterkits | @bmuenzenmeyer - note, this feature seems a bit buggy. feedback welcome
- FIX: Support expanding link.patterPartial links inside listitems.json | @bmuenzenmeyer
- DEL: Remove baseUrl | @bmuenzenmeyer
- ADD: Core spec enhancements:
defaultPattern
anddefaultShowPatternInfo
config options | @bmuenzenmeyer
View the complete changelog.
UNIT TESTS/ASSERTIONS
1 unit test was removed this release - plus more for engines that are not included yet
UPGRADE INSTRUCTIONS
Follow the standard upgrade instructions to migrate from 1.X to 2.X, which no requires an edition.
ROADMAP
Keep an eye on the roadmap for a clearer understanding of where the project is going in the next few releases.
Brian
Tell me on Twitter what you are building with Pattern Lab Node!
v2.0.0-alpha - pattern lab - node
Pattern Lab Node v2.0.0 ALPHA
It's here! PL/Node 2.0.0
Bigger, stronger, faster
? More like, smaller, smarter, modular
!
- PL/Node 2.0.0 makes major departures from its simple origins as a fork of PL/PHP. Now it plays catch up in major ways with its big brother, boasting integration with the shared frontend styleguidekit-assets also PL/PHP uses.
- Editions are now created to separate the task runners from this core library.
- I cannot begin to thank @geoffp enough for all the work he's put into pattern-engines, finally seeing the light of day. You are true friend and open source hero.
- Next up will be focusing on the grunt edition, polishing up the rest of the engines beyond the mustache one, and reconciling any stale issues and PRs. Thank you to everyone who has suffered through my development process over the years!
I will re-release 2.0.0
with any major bug fixes, hopefully by sometime next weekend.
CHANGELOG
- ADD: Template rendering extracted into Pattern Engines | @geoffp
- ADD: Patterns engines are searched for alongside core and the consumer (usually an edition) | @geoffp
- CHG: Improved pattern object, with a better constructor and engine interface| @geoffp
- CHG: Moved utility functions into their own file | @geoffp
- CHG: Refactor UI builder into its own file | @geoffp
- DEL: Removed all styleguide code | @bmuenzenmeyer
- DEL: Removed all
public/
code | @bmuenzenmeyer - DEL: Removed all
source/
code | @bmuenzenmeyer - DEL: Removed gulp and grunt CLI tasks in favor of editions| @bmuenzenmeyer
- CHG: Massive Refactor from pattern.key to pattern.patternPartial to align with styleguide-assets-default | @bmuenzenmeyer
- CHG: Refactor UI navigation to align with styleguide-assets-default | @bmuenzenmeyer
- CHG: Refactor lineage to align with styleguide-assets-default | @bmuenzenmeyer
- CHG: Refactor patternName to align with styleguide-assets-default | @bmuenzenmeyer
- CHG: Refactor expected location of meta patterns to align with stylguide-assets-default | @bmuenzenmeyer
- ADD: Enhance annotations to support
.md
| @bmuenzenmeyer - ADD: Support
.md
pattern descriptions | @bmuenzenmeyer - ADD: Support starterkits | @bmuenzenmeyer
- ADD: Support pattern breadcrumbs | @bmuenzenmeyer
- ADD: Better error handling around expected files / engines | @bmuenzenmeyer & @geoffp
- CHG: Hopefully improve cross-platform support by always using Node API for pathing | @bmuenzenmeyer & @geoffp
- FIX: countless bugs! | @bmuenzenmeyer & @geoffp
- FIX: View all pages are not completely rendered | reported on 1.X by @hinok - fixed manually
View the complete changelog.
UNIT TESTS/ASSERTIONS
78 more unit tests / assertions were added this release - plus more for engines that are not included yet
UPGRADE INSTRUCTIONS
Follow the standard upgrade instructions to migrate from 1.X to 2.X, which no requires an edition.
ROADMAP
Keep an eye on the roadmap for a clearer understanding of where the project is going in the next few releases.
Brian
Tell me on Twitter what you are building with Pattern Lab Node!
v1.3.0 - pattern lab - node
Pattern Lab Node v1.3.0
CHANGELOG
- CHG: Improvements to paramtoJson | @e2tha-e
- NOTE Could cause performance degradations on large pattern libraries until #277 is live.
- ADD: Test to show support for #145 - Support HTML entities within pattern parameters | @james-nash
- FIX: Pattern States Should Always Inherit to Consuming Patterns, Not Just When The Consuming Pattern Has a State | @bmuenzenmeyer via Jesse
View the complete changelog.
UNIT TESTS/ASSERTIONS
6 more unit tests / assertions were added this release
UPGRADE INSTRUCTIONS
Assuming you are on v1.2.2, one should be able to follow the standard upgrade instructions.
ROADMAP
Keep an eye on the roadmap for a clearer understanding of where the project is going in the next few releases.
Brian
Tell me on Twitter what you are building with Pattern Lab Node!
v1.2.2 - pattern lab - node
Pattern Lab Node v1.2.2
CHANGELOG
View the complete changelog.
UNIT TESTS/ASSERTIONS
0 more unit tests / assertions were added this release
UPGRADE INSTRUCTIONS
Assuming you are on v1.2.1, one should be able to follow the standard upgrade instructions.
ROADMAP
Keep an eye on the roadmap for a clearer understanding of where the project is going in the next few releases.
Brian
Tell me on Twitter what you are building with Pattern Lab Node!
v1.2.1 - pattern lab - node
Pattern Lab Node v1.2.1
Pattern Lab Node v1.2.1 is a tiny release highlighting some polish from the community. Thanks for the keen eyes!
CHANGELOG
- FIX: Remove extra '>' from body tag | @tannerhodges
- FIX: fix documentation links in the header bar | @SteveDesmond-ca
View the complete changelog.
UNIT TESTS/ASSERTIONS
0 more unit tests / assertions were added this release
UPGRADE INSTRUCTIONS
Assuming you are on v1.2.0, one should be able to follow the standard upgrade instructions.
ROADMAP
Keep an eye on the roadmap for a clearer understanding of where the project is going in the next few releases.
Brian
Tell me on Twitter what you are building with Pattern Lab Node!
v1.2.0 - pattern lab - node
Pattern Lab Node v1.2.0
Pattern Lab Node v1.2.0 bottles up a ton of the momentum the project has had of late into a grab bag of cool. I thank everyone that made it possible. Let's dive in.
CHANGELOG
- DEL: Remove CHANGELOG in favor of Wiki | @bmuenzenmeyer
- FIX: Whitespace is not consistent across files | @geoffp & @bmuenzenmeyer
- FIX: BrowserSync still happens on the outer frame after full refresh on pattern | @geoffp
- CHG: More robust pattern parameter to json conversion | @e2tha-e
- ADD: Added meta patterns | @bmuenzenmeyer
- ADD: Added cacheBuster support | @bmuenzenmeyer
- CHG: Restructure filesystem to better align concerns and support upgrades | @bmuenzenmeyer
- ADD: Support for configuring a default pattern in config.json | @geoffp
- CHG: Namespacing config settings | @bmuenzenmeyer
- ADD: Implement pattern state lowest common denominator | @bmuenzenmeyer
- CHG:
.gitignore
changes:Thumbs.db
andpublic
directory (with all subdirectories and files) | @zacanger - ADD: Add js directory to watch:all grunt task | @bmuenzenmeyer
View the complete changelog
Special thanks to @geoffp for spearheading the code cleanup efforts, and for improving BrowserSync performance (mainly on gulp).
Meta Patterns are a significant addition that should make managing assets around patterns more DRY.
A functional gap was also closed with pattern states in that they now do inherit the lowest common denominator as does PHP.
UNIT TESTS/ASSERTIONS
6 more unit tests / assertions were added this release
UPGRADE INSTRUCTIONS
Assuming you are on v1.1.3, one should be able to follow the standard upgrade instructions. I feel embarrassed to call these instructions standard, as they are also rather heavy-handed and a lot to ask users to endure for new behavior. This release was the last signpost planted in 1.X land - our journey continues into 2.X land.
ROADMAP
Keep an eye on the roadmap for a clearer understanding of where the project is going in the next few releases.
Especially this guy 👀
Brian
Tell me on Twitter what you are building with Pattern Lab Node!
v1.1.3 - pattern lab - node
Pattern Lab Node v1.1.3
Pattern Lab Node v1.1.3 closes a gap with PL PHP v1 - allowing Pattern Types like Atoms & Molecules to have their own "View All" page similar to their subtypes.
CHANGELOG
- FIX: Added pattern type view all pages to the navigation, which users view all 'Atoms/Molecules/Organisms' etc. Note, this logic is not extended to Templates and Pages. Feedback is welcome as to whether those are useful too.
- THX: Thanks to @gael-boyenval for originally pointing out the omission.
- FIX: Update destination of copied fonts
- THX: Thanks @ryanatty for the keen eye
- FIX: Better pattern parameter parsing regex, with unit tests
- THX: Thanks @e2tha-e for the improvements, as always
UNIT TESTS/ASSERTIONS
8 more unit tests / assertions were added this release thanks to @e2tha-e
UPGRADE INSTRUCTIONS
Assuming you are on v1.1.2, one should be able to follow the standard upgrade instructions
ROADMAP
Keep an eye on the roadmap for a clearer understanding of where the project is going in the next few releases.
Brian
Tell me on Twitter what you are building with Pattern Lab Node!
v1.1.2 - pattern lab - node
Pattern Lab Node v1.1.2
Pattern Lab Node v1.1.2 packs a punch with improved support for BrowserSync page reloads and injections - because our tools should work harder for us.
CHANGELOG
- FIX: Greatly improved the browsersync configuration, so that it only fires on the iframe, preventing users from losing their scroll position. Also lightened up the styling and made it less obtrusive.
- THX: Thanks to @geoffp for taking the lead on this issue.
- THX: This release also marks the first with @geoffp's more official involvement with the project as a core contributor. His work on the
pattern_engines
branch and configurable paths have and will continue to make Pattern Lab Node better. - FIX: Replace
eval()
with a smarterJSON.parse()
call within theparameter_hunter.js
- THX: Thanks to @e2tha-e for taking the high road!
UNIT TESTS/ASSERTIONS
No additions in unit test coverage.
UPGRADE INSTRUCTIONS
Assuming you are on v1.1.1, one should be able to follow the standard 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 Brian - Tell me on Twitter what you are building with Pattern Lab Node!
v1.1.1 - pattern lab - node
Pattern Lab Node v1.1.1
Pattern Lab Node v1.1.1 is a small release, but a notable one, in that it's the first contribution done on the clock at Roydan as part of their new open source initiative. Thank you to them for donating my time.
CHANGELOG
FIX: Fixed issue where alternate patterns are added to end of styleguide instead of inline with their parent pattern.
UNIT TESTS/ASSERTIONS
No additions in unit test coverage.
UPGRADE INSTRUCTIONS
Assuming you are on v1.1.0, one should be able to follow the standard 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 Brian - Tell me on Twitter what you are building with Pattern Lab Node!
And 👏 to Roydan for donating my time to the project.
v1.1.0 - pattern lab - node
Pattern Lab Node v1.1.0
Pattern Lab Node 1.1.0 is here, not to be outdone by v1.0.0!
In terms of relative change, it's bigger than v1.0.0 in fact, with a good mix of fixes, enhancements, and a lot of work put into the shipped grunt/gulp harness you've almost undoubtedly customized already. Switching to configurable paths and making the core library require()-able is a huge win, opening the doors to running Pattern Lab Node as an npm dependency. If you've ever had to struggle through an upgrade, I suggest you check this out, as it should greatly lessen future maintenance costs and allow us to do some other cool stuff soon!
Reference examples of a parent projects running Pattern Lab Node as a dependency can be found here:
I want to take special note to @geoffp and @EvanLovely who were integral in crafting the major paths and require() work this release. Pattern Lab Node is a more reliable, more maintainable tool now.
Thank you
View the full version diff here.
CHANGELOG
- FIX: Fixed issue where partials containing styleModifiers with integers were not found correctly under all circumstances
- FIX: Fixed issue where excluded patterns were still rendered on the Pattern Lab site. Now they do not directly get rendered via the menu, view all links, or the styleguide, but are accessible for inclusion as pattern partials, and can be accessed via lineage.
- THX: Thanks @theorise for reporting these issues.
- THX: Thanks @dmolsen for input on desired behavior.
- FIX: Fixed issue where style modifier partials within list item blocks where not uniquely being applied. this seems like a regression. added a unit test with fix
- ADD: Added fuzzy pattern matching support based on patternType-substring(patternName) to align with PL PHP
- FIX: Fixed issue with gulpfile not copying style.css and watching the wrong directory
- THX: Thanks @robinsonaaron for the issue and pull request!
- FIX: Prefer exact pattern key match over fuzzy matches inside getpatternbykey()
- THX: Thanks @EvanLovely for the suggestion
- ADD: Make all paths configurable
- THX: HUGE Thanks to @geoffp and @EvanLovely for their thoughts, time, and talent to make this a reality!
- FIX: Fix issue where absolute paths in the config path object would not resolve
- THX: Thanks to @geoffp and @EvanLovely for reporting, fixing and testing the issue in the dev branch.
- FIX: Typo in gulp instructions in README.
- THX: Thanks @simonknittel for the watchful eyes
- CHG: Changed locations of ./public/styleguide to ./core/styleguide to make ./public/ a cleaner distribution directory
- CHG: Removed scss files and config from project. This is in preparation for including the default asset repo in the future
- FIX: Fix issue where partials were not being sent to Mustache during pattern parameter parsing.
- THX: Thanks to @e2tha-e for reporting this issue.
- ADD: Now patterns and pseudopatterns can be linked from global or file data.json
- THX: Thanks @kylewelsby for the thoughtful enhancement
UNIT TESTS/ASSERTIONS
20 more unit tests/assertions were added with this release.
UPGRADE INSTRUCTIONS
Assuming you are on v1.0.0, one should be able to follow the standard upgrade instructions along with the following addenda:
Major changes have occurred in the shipped Gruntfile
|Gulpfile
. It's recommended to take the new versions's file and manually merge any customizations you have. The good news is configurable paths make for a ton more flexibility into the future.
-
Add the following to the
config.json
:"paths" : { "source" : { "root": "./source/", "patterns" : "./source/_patterns/", "data" : "./source/_data/", "styleguide" : "./core/styleguide/", "patternlabFiles" : "./source/_patternlab-files/", "js" : "./source/js", "images" : "./source/images", "fonts" : "./source/fonts", "css" : "./source/css/" },
-
All
.scss
files have been removed from the filesystem andGruntfile
|Gulpfile
. They caused confusion of sorts and added complexity for little benefit, as the styleguide doesn't change significantly and the shipped pattern styling is not intended to be used. With the roadmap point to other kits, for patterns and the styleguide, this feels like good preparation and aligned with the theme of this release to be about future-consumption.
All this change may warrant some to consider this a major upgrade, but the API hasn't really changed, just the shipped harness around patternlab.js.
If you are worried about upgrading, your best bet might be to start anew just this once.
ROADMAP
Keep an eye on the roadmap for a clearer understanding of where the project is going in the next few releases.
❤️ from Brian - Tell me on Twitter what you are building with Pattern Lab Node!