Skip to content

Pattern Lab Node Core 2.7.1

Compare
Choose a tag to compare
@bmuenzenmeyer bmuenzenmeyer released this 14 Jan 05:46
· 3102 commits to master since this release

Pattern Lab Node v2.7.1

See the 2.7.1-alpha release notes

For the full release of 2.7.1 - @tburny delivered a slew of bug fixes to incremental builds that bring it into a much more polished, dev-ready state. I highly suggest upgrading to 2.7.1 as soon as possible to realize major performance improvements.

@tburny has also accepted an invite to become an official core contributor to the Pattern Lab Node project. Congratulations, and thank you.

Incremental Builds!

For speeding up Pattern Lab, a new feature called incremental builds has been added in Patternlab Node 2.7.0. Instead of rebuilding the whole Pattern Lab tree, only changed patterns (and files including these) will be rebuilt.

  • Also an export to GraphViz has been added.
  • Pattern Lab will now print which patterns have been built yet, so correctness of the build can be verified.

Enabling/Disabling Incremental Builds

The feature is enabled automatically when building Pattern Lab with the cleanPublic option set to false on the patternlab-config.json file found within editions.

Enabling/Disabling GraphViz Export

Setting the exportToGraphViz configuration option to true will export a graph showing which patterns include other patterns to public/dependencyGraph.dot. You can generate an SVG file via dot -Tsvg dependencyGraph.dot -o dependencyGraph.svg and open dependencyGraph.svg in your browser or favourite SVG viewer.
Here's a sample file!

Possible Issues

  • Pattern Lab remembers which patterns already have been compiled via the public/dependencyGraph.json file, which might eventually become out of sync. A quick fix is to clean the public directory. Deleting the file is not enough, because Pattern Lab will detect that the source files were not modified after the template output files in public.
  • patternDependencyGraph.json has an internal version. During Pattern Lab upgrades, the structure might change, which will trigger a full rebuild and a warning is shown.
  • When changing a Markdown file, the pattern is not recompiled.

Reporting Problems

Please report any problems and ask questions to @tburny or the Pattern Lab team. Thanks!

Sample Output

3.2.1. 🚀 >>>>>>>>>>>>>>>>>>>>>🎯 💣

image

CHANGELOG

UPGRADE INSTRUCTIONS

Follow the standard upgrade instructions.

EDITIONS

It's now suggested to use an edition with Pattern Lab Node. Editions package up core, shared frontend assets, and a means to communicate with the API.

UNIT TESTS/ASSERTIONS

102 unit tests/assertions were added this release wow for a total of 485

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.


The Pattern Lab Node Team