ChangeLog

The changelog has been moved to the repository

Releases prior to those covered in the above file are included below.

v3.0.0-alpha.6

January 16th, 2018

• 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

v3.0.0-alpha.5

November 15th, 2017

• 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

v3.0.0-alpha.4

October 24th, 2017

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

v3.0.0-alpha.3

October 20th, 2017

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/pattern-lab/patternlab-node/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

v2.12.0

October 1st, 2017

Hacktoberfest!

• ADD: Add Stale Bot | @bmuenzenmeyer, Hacktoberfest!
• ADD: Add a version / upgrade check | @gillesdemey, Hacktoberfest!
• ADD: Pass theme from patternlab-config.json to client | @bmuenzenmeyer, Hacktoberfest!
• CHG: Update contribution guidelines | @prateekiiest, Hacktoberfest!
• FIX: New data_loader.js module loadFile method loads the wrong file | @phawxby, Hacktoberfest!

v2.11.1

September 19th, 2017

• FIX: Data from listItems are not passed through in the loop | @bmuenzenmeyer, with report from @bramsmulders

v2.11.0

September 11th, 2017

• ADD: Use js-yaml to parse json, yaml, and yml config files | @fillerwriter
• CHG: Attempt to parse the JSON to see if it is already well formed | @cjpete
• FIX: Fix verbosePartial property | @gergan

v2.10.0

September 1st, 2017

• ADD: Title is now read from the markdown file, overrides file name | @jdagerot
• ADD: Extra pattern frontmatter added to output | @jdagerot
• ADD: Add Code of Conduct | @bmuenzenmeyer, with thanks to all the work Coraline Ada Ehmke does. | Thread
• FIX: Fixing URL in Readme | @EvanLovely @iansoper

v2.9.3

May 19th, 2017

• FIX: Multiple pattern parameters down a render tree cause issues | @bmuenzenmeyer
  • Shoutout to @c1rrus for finally putting the starterkit-mustache-acidtest to good use.

v2.9.2

April 26th, 2017

• FIX: Fix an order of operations problem between data links and pattern processing along with a rather awesome unit test, the first of its kind directly on patternlab.js | @bmuenzenmeyer

v2.9.1

March 21st, 2017

• CHG: Revert JSON parsing to stock implementation | @bmuenzenmeyer
• CHG: Improved README | @bmuenzenmeyer

v2.8.0

March 2nd, 2017

• ADD: Option of excluding sub pattern types from the styleguide | @AndrewLeedham
• ADD: Accept either case of styleguideExcludes | @bmuenzenmeyer
• ADD: Expose getSupportedTemplateExtensions | @bmuenzenmeyer
• CHG: Backported 3.0 improvement to plugin installation, supporting options right on patternlab-config.json | @bmuenzenmeyer
• CHG: Use path.sep to match omitted directories | @carlosliu
• FIX: Race condition when loading starter kits | @tburny

v2.7.2

January 14th, 2017

• ADD: chalk must be a dependency | @bmuenzenmeyer

v2.7.1

January 13th, 2017

• ADD: Hide "All" nav item if JSON flag is set | @tommcc
  • Requires a new version of styleguide-assets-default
• ADD: add .npmignore file to exclude test/ and a few other files | @bmuenzenmeyer
• FIX: Fix batch of pattenGraph bugs | @tburny
• FIX: Updating an individual pattern breaks viewall page rendering | @tburny
• CHG: Updated repo badge to svg | @amilajack

v2.7.1-alpha

December 19th, 2016

• ADD: Implement Build Algorithm for Only Changed/Affected Patterns | @tburny
• ADD: Add test cases for @block-partial issue in Handlebars engine | @teehemkay
• ADD: Expose the pattern engines as a property of the patternlab object | @bleathem
• ADD: Add chalk and use it to make the build and engine loading process prettier | @geoffp
• FIX: Default plugins array if none found | @giuseppepaul
• FIX: Fix link to help wanted and up for grabs issues | @scottgruber
• CHG: Finish #565 by replacing our lo-tech color solution found within core/lib/utilities.js | @bmuenzenmeyer

v2.6.2

November 12th, 2016

• FIX: Fix relativeDepth check | @tommcc
• FIX: View All is not working on some patterns | @bmuenzenmeyer

v2.6.1

November 4th, 2016

Hacktoberfest!

• ADD: Add tap support for unit tests | @dbradf
• ADD: Added patternlab-pattern-before-data-merge event | @DavidEmanuelsen
• ADD: Allow engines to control how output files' code is formatted | @geoffp
• FIX: Fix hidden pattern references across all engines | @geoffp
  • SYNTAX CHANGE
    • This means that the previous workaround to include a hidden pattern: {{> atoms-_icon }} may now be directly included: {{> atoms-icon }}
• CHG: Better Handle Errors Thrown When Looking for a Deleted/Missing Pattern | @bmuenzenmeyer
• CHG: Convert lineage_hunter_tests.js to use tap/tape | @bmuenzenmeyer
• CHG: Convert list_item_hunter_tests.js to use tap/tape | @bmuenzenmeyer
• CHG: Convert markdown_parser_tests.js to use tap/tape | @bmuenzenmeyer
• CHG: Convert object_factory_tests.js to use tap/tape | @bmuenzenmeyer
• CHG: Convert parameter_hunter_tests.js to use tap/tape to use tap/tape | @bmuenzenmeyer
• CHG: Convert pattern_assembler_tests.js to use tap/tape | @bmuenzenmeyer
• CHG: Convert pattern_engines_tests.js to use tap/tape | @bmuenzenmeyer
• CHG: Convert patternlab_tests.js to use tap/tape | @bmuenzenmeyer
• CHG: Convert pseudopattern_hunter_tests.js to use tap/tape | @bmuenzenmeyer
• CHG: Convert style_modifier_hunter_tests.js to use tap/tape | @bmuenzenmeyer
• CHG: Convert ui_builder_tests.js to use tap/tape | @bmuenzenmeyer
• CHG: Convert engine_handlebars_tests.js to use tape | @alexbenic
• CHG: Convert engine_mustache_tests.js to use tape | @alexbenic
• CHG: Convert engine_twig_tests.js to use tape | @alexbenic
• CHG: Convert engine_underscore_tests.js to use tape | @alexbenic
• CHG: Add proper jsdoc comments to core/lib/starterkit_manager.js | @spezzino
• CHG: Add proper jsdoc comments to core/lib/pattern_exporter.js | @spezzino
• CHG: Add proper jsdoc comments to core/lib/style_modifier_hunter.js | @spezzino
• CHG: Add proper jsdoc comments to core/lib/plugin_manager.js | @spezzino
• DEL: Removed Node 5 from Travis builds per my understanding of https://github.com/nodejs/LTS | @bmuenzenmeyer
• DEL: Removed nodeunit as a devDependency | @bmuenzenmeyer
• DEL: Grunt no longer needed as a devDependency | @bmuenzenmeyer

v2.6.0-alpha

September 27th, 2016

• ADD: Basic support for frontend and backend plugins | @bmuenzenmeyer
  • Wiki: https://github.com/pattern-lab/patternlab-node/wiki/Creating-Plugins
  • First Plugin / Reference Plugin: Plugin Node Tab
• ADD: Add ability to beautify code pane output | @gael-boyenval
• FIX: defaultPattern is not rendering on styleguide view | @bmuenzenmeyer
• FIX: styleModifiers are not included in pseudo patterns | @bmuenzenmeyer
• FIX: Alter postinstall to support editions being installed as dependencies | @bmuenzenmeyer
• CHG: Make listStarterkits return an array of repo objects | @raphaelokon
• CHG: Make the absence of source/_data/listitems.json a warning instead of an error | @bmuenzenmeyer

v2.5.1

September 2nd, 2016

• REFIX: StyleModifier included patterns pollute other pattern inclusions | @bmuenzenmeyer
• FIX: blank page display with deep included patterns | @bmuenzenmeyer

v2.5.0

August 31st, 2016

• FIX: Allow pattern includes and data within pattern meta/head and meta/foot | @bmuenzenmeyer
• FIX: Pattern Type View All not working | @bmuenzenmeyer
• FIX: Typo in README | @jeremykenedy
• ADD: Add warning about too-deep-nested patterns | @bmuenzenmeyer
• FIX: StyleModifier included patterns pollute other pattern inclusions | @bmuenzenmeyer
• FIX: Pseudo-Pattern links 404 on the styleguide | @bmuenzenmeyer

v2.4.4

August 25th, 2016

• FIX: Attempt to single-thread pattern lab builds and clean up between them | @bmuenzenmeyer
• CHG: Support patternengine name rather than file extension in the template tab | @geoffp

v2.4.3

WIP on dev not yet released

• FIX: Fix regression with styleguideExcludes not rendering on the menu | @bmuenzenmeyer
• FIX: Fix unstable file watches by making file writes synchronous | @bmuenzenmeyer
• FIX: Tests for Underscore, Handlebars, and Twig fail | @bmuenzenmeyer
• ADD: Added all patternengines as part of travis pre-install | @bmuenzenmeyer
• FIX: Pattern Links in "view all" ignore configured outputFilePaths | @geoffp

v2.4.2

August 17th, 2016

• FIX: Better handle missing outputfile suffixes | @bmuenzenmeyer

v2.4.1

August 16th, 2016

• FIX: loadstarterkit failed with "TypeError: Path must be a string. | @nilshartmann
• FIX: Cannot navigate using data.links - again | @bmuenzenmeyer

v2.4.0

August 15th, 2016

• ADD: Implement npm postinstall script that loads installed starterkit right away | @bmuenzenmeyer
• ADD: Hide underscored directories from the navigation altogether | @e2tha-e
• CHG: Rewrote ui_builder.js for more unit-testable, more maintainable structure. | @bmuenzenmeyer
  • Implement SubType Documentation
  • Known Issues: Subtype View all is not at the end of the menu
  • Please report any issues you see with Pattern Lab frontend after upgrading.
• FIX: Pattern markdown files with no description text render raw text into description field | @bmuenzenmeyer - includes js-yaml dependency for more robust annotation and frontmatter yaml parsing. Paves the way for full yaml support soon!
• FIX: Cachebuster not outputting on view-all pages | @bmuenzenmeyer, reported by @brianjhanson
• FIX: Error Parsing link.patterns inside .json | @bmuenzenmeyer
• CHG: Rename findPartial to getPartial | @e2tha-e
• ADD: Added an underscore unit test | @geoffp
• ADD: Missing user-editable header / footer error handling | @geoffp
• FIX: Remove dead code and correct upgrade instructions | @bmuenzenmeyer, reported by @josketres

v2.3.0

Jul 25th, 2016

• FIX: Allow Pattern Groups (atoms, molecules, etc...) to not be Prefixed with Two Integers and a Hyphen | @bmuenzenmeyer
• ADD: Parse _data/*.json files into a single data object, excluding listitems.json | @stevemartin
• ADD: Configurable output file suffixes | @bmuenzenmeyer
• FIX: Remove a typo | @e2tha-e

v2.2.1

July 18th, 2016

• ADD: Parse _annotations/*.md files into a single annotations array | @stevemartin
• FIX: styleguideExcludes excludes pattern folders from navigation | @geoffp

v2.2.0

July 13th, 2016

• ADD: Initial support for Pattern Subtype Documentation Markdown | @bmuenzenmeyer
  • Does not yet display on main styleguide screen
• FIX: Fix issue with annotations not parsing correctly if already valid json | @bmuenzenmeyer
• DEL: Remove an unused dependency | @bmuenzenmeyer

v2.1.1

July 6th, 2016

• CHG: Markdown & frontmatter parsing improvements | @bmuenzenmeyer
  • Parses markdown even when no frontmatter exists
  • No longer attempts to strip quotes from frontmatter values
  • Unit test coverage

v2.1.0

July 3rd, 2016

• ADD: More shields for the README | @bmuenzenmeyer
• CHG: Refactored frontmatter / markdown parser into a shared library | @bmuenzenmeyer
• ADD: Parse patternState out of pattern.md frontmatter | @bmuenzenmeyer
• WARN: Added deprecation warning of old patternStates configuration | @bmuenzenmeyer
• ADD: Broke out patternengine-node-mustache tests into own file in attempt to fix better cover a fix for #377 | @bmuenzenmeyer

v2.0.1

June 26th, 2016

• DEL: Removed the media query hunter as not on spec | @james-nash

v2.0.0

June 21st, 2016

• ADD: Better error handling around JSON | @bmuenzenmeyer
• ADD: Support patternBreadcrumb as object | @bmuenzenmeyer

v2.0.0-alpha2

June 20th, 2016

• 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 and defaultShowPatternInfo config options | @bmuenzenmeyer

v2.0.0-alpha - relevant pull request

June 11th, 2016

• ADD: Template rendering extracted into Pattern Engines | @geoffp
  • Mustache Engine | @geoffp
  • Handlebars Engine | @geoffp
  • Underscore Engine | @geoffp
  • Twig Engine | @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

v1.3.0

April 16th, 2016

• CHG: Improvements to paramtoJson | @e2tha-e
• 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

v1.2.2

April 4th, 2016

• FIX: Underscored Patterns are being built on the UI | @bmuenzenmeyer

v1.2.1

March 27th, 2016

• FIX: Remove extra '>' from body tag | @tannerhodges
• FIX: fix documentation links in the header bar | @stevedesmond-ca

v1.2.0

March 11th, 2016

• 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 and public directory (with all subdirectories and files) | @zacanger
• ADD: Add js directory to watch:all grunt task | @bmuenzenmeyer

v1.1.3

February 26th, 2016

• ADD: Support for Pattern Type View All Pages

v1.1.2

February 22nd, 2016

• ADD: BrowserSync still happens on the outer frame after full refresh on pattern
• FIX: Update destination of fonts to public.fonts
• ADD: Better regex and tests for pattern parameter parsing

v1.1.1

February 15th, 2016

• FIX: Alternate Patterns Are Added to the End of Styleguide and not Inline with their Parent Pattern

v1.1.0

February 8th, 2016

• ADD: Implement support for fuzzy pattern partials
• FIX: Patterns incorrectly inheriting styleModifier when it has not been set
• FIX: Fuzzy partial matching should prefer exact match
• FIX: gulpfile: style.css not copied after clean install & browser-sync watching wrong css directory
• ADD: Support Flexible Pattern Lab Filesystem
  • FIX: Config Paths only work with ./ prefix
• ADD: Become require()-able by allowing to become a dependency
• FIX: Parameter submission broken
• FIX: Bug fix #171 - pattern links inside base data object

v1.0.0

December 8th, 2015

• ADD: Document pl node features on patternlab.io
• ADD: Consider support for pattern links inside base data object
• FIX: Hiding patterns not working
• FINISH: Add More Unit Tests
• FIX: Look to see if example pattern vendor js needs to be updated
• FIX: ctrl+shift+0 does not set viewport to 320px per documentation
• ADD: Add note about running some installation commands with admin rights
• DEL: Remove https://github.com/pattern-lab/patternlab-node/blob/master/public/data/annotations.js from initial installs.

v0.15.1

November 25th, 2015

• 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

v0.15.0

November 12th, 2015

• SUPPORT: Node v4.X and v5.X
• CLOSE: PSA: Pattern Lab Node may have trouble installing on Windows with Node 4.X
• FIX: Failed at the [email protected] install script 'node-gyp rebuild'

v0.14.0

• ADD: Support for style modifiers
• ADD: Support for styleGuideExcludes
• FIX: ListItems blocks are only parsed when they contain a partial themselves

v0.13.1

October 14th, 2015

• FIX: Allow verbose partials for list items

v0.13.0

October 6th, 2015

• FIX: Pattern directories with spaces do not display anything after first word
• CHG: Update property priority during of object merge function
• ADD: Support for recursive partial inclusion
• FIX: Improve capitalization across generated menu and styleguide

v0.12.0

September 20th, 2015

• ADD: Gulp support
• ADD: Reinvestigate page-follow
• FIX: Support the auto-reload and page follow options as part of BrowserSync support
• ADD: Allow more flexible Mustache partial syntax

v0.11.0

August 25th, 2015

• ADD: Support List Item Data
• ADD: Support for ignoring _directories
• ADD: Support a fluid viewport
• FIX: Found pattern parameter data bleeding into global data object

v0.10.1

August 9th, 2015

• CHECK FOR ANY OTHER MAJOR GAPS TO PL PHP V1
• BUG: Lineage not working for patterns with pattern parameters
• ADD: Unit test coverage of some of the newer features / newly modular code

Prior to v0.10.1 releases