Mega PR: Merging Drupal Pattern Lab Fork Back Into Main Pattern Lab PHP Core

[sghoweri]

Placeholder Mega PR per the awesome conversation @EvanLovely and I had earlier today.

This folds in the past 5 months worth of maintenance and enhancement updates made to the Drupal Pattern Lab working group's ongoing Pattern Lab PHP Core fork as part of the new exciting updates @bradfrost posted about earlier this week!

Changelog

• ADD: Allow Pattern Lab to follow pattern symlinks | @sghoweri
• FIX: Remove extra character from InstallerUtil so dev branch isn't broken - addresses Parse Error when creating new project with developer edition #123 and Fix parse error in InstallerUtil.php #87 | @sghoweri, @aleksip and @EvanLovely
• FIX: Updating global data to use yml or yaml which addresses Default data files only support .yaml extension, while pattern-specific data file allow .yml #93 and Ensure YAML data files can use yml extension too #96 | @EvanLovely
• FIX: Regenerate deleted publicDir / regenerate styleguidekit if index.html missing | @EvanLovely and @sghoweri
• FIX: Replace possible dots in pattern names with dashes | @aleksip and @evanmwillhite
• FIX: Don't overwrite nameClean if it has already been set | @aleksip
• FIX: Fix long broken lineage functionality when using Twig namespaces (ie. Drupal 8 friendly paths) which closes out Fix for Pattern Lab Pattern Viewer Not Displaying Namespaced Lineage Twig Paths #105 | @sghoweri and @aleksip
• CHORE: Merge Pattern Lab dev work @dmolsen helped with back in July of 2016 into master which should address existing issues / PRs relating to broken View All links in the navigation, including BUGFIX: Fix 'View All' links in navigation #107 and BUGFIX: Fix nested View All page #102 | @dmolsen and @sghoweri

---

Next Up (Fast Follows)

Bug Fixes & Maintainance

• FIX: Fix mixup when storing pattern suboptions (@todo: double check this is still needed)
• FIX: Fix lineage url (@todo: double check this is still needed)
• FIX: Fix addressing incorrect pattern states
• FIX: Update zippy library which should also address Starter kit fails to extract #118
• FIX: Fix Psuedo Patterns if template lives in separate location'
• FIX: Additional fix for lineages in PL when using custom Twig namespaces
• CHORE / FIX: Use DIRECTORY_SEPERATOR for getStyleguideKitPath

Better Installation / Setup Process

• ADD: Find composer.json in starterkit
• ADD: Add install script hook to composer extras

Better Markdown Docs

• ADD: Compile templates embedded in Markdown files (ie. turbo-charged docs) which would close out Turbo-charge Markdown Docs by Enabling Pattern Engine Templates To Be Used #104
• ADD: Allow markdown files to specify which pattern it should be associated with (ex. README.md)

Pattern Lab Customization / Configuration

• ADD: Expose patternPartial name to templates
• ADD: Expose ishViewportRange to Styleguidekit which addresses Expose ishViewportRange configuration entry #111
• ADD: Expose idle timeout duration in config
• ADD: Add ability to add / remove / change pattern data rules
• ADD: Support digits at the start of psuedo pattern filenames
• ADD: Add ability to strip pattern name category prefixes from menu

---

Soon After (@todo: finish reviewing remaining open issues following next release)

• ADD: Add schema support + examples to Pattern Lab (spoiler: really exciting work is in the pipeline!)
• FIX: Pseudo pattern jsons starting with digits gives PHP warnings which DPL: Reference The Correct Template In Psuedo Patterns If JSON File and Template Live in Different Folders #128 might help address (if not, it might help tackle this other issue)
• ADD: Tackle making Pattern Lab more configurable and customizable
  • Make Pattern Lab Configurable via a .patternlabrc vs patternlab-config.json and ./config/config.yml
  • Allow patterns to be reordered at the data layer (via JSON, YAML, or Markdown)
• ADD: Work on decoupling patterns and data (including external references). NOTE: Schema work might help with this
  • Propose: {{XXX}} and ref->XXX in any data files
• Github Roadmap with @EvanLovely and @bmuenzenmeyer - including the mega epic of consolidating PL's code base while still supporting integrations w/ PHP and Node based templates, Drupal integration, etc

TODOs

• remove references to Drupal Pattern Lab in composer.json
• add changelog summary of updates this group of bug fixes and enhancements includes
• cross reference and close out existing duplicate and/or redundant from these updates
• identify fast follow-on PRs to get out the door ASAP

[sghoweri]

@EvanLovely @aleksip could one of you guys check this out when you get a chance?

I know we're going to need do another pass through reviewing the existing issue queue after this goes out the door to make sure we're not missing anything however this should be pretty darn close otherwise. LMK!

[EvanLovely]

🎉