@theme-tools/plugin-pattern-lab-php NPM

Pattern Lab Plugin for Theme Tools

Theme core plugins let you easily pass in configuration and get a set of Gulp-ready task functions back that have sensible defaults and work well together.

Getting Started

Requirements

Gulp 4 installed with npm install --save gulp@4

Install

npm install @theme-tools/plugin-pattern-lab-php --save

Configure

The config that is passed in is merged with config.default.js.

cp node_modules/@theme-tools/plugin-pattern-lab-php/config.default.js config.pattern-lab.js

Setup

Add this to your gulpfile.js:

const gulp = require('gulp');
const config = {};
config.pl = require('./config.pattern-lab.js');
const plTasks = require('@theme-tools/plugin-pattern-lab-php')(config.pl);

gulp.task('pl', plTasks.compile);
gulp.task('watch:pl', plTasks.watch);

Details

Tasks

These tasks are methods inside plTasks from the above code example. You can run them anyway you can run a function, though they are often ran via Gulp. All tasks take a callback function as the first and only parameter that will run when the task is done - exactly how gulp.task(), gulp.parallel(), and gulp.series() want.

`plTasks.compile()` - Compile Pattern Lab

Compiles Pattern Lab. Basically runs php pattern-lab/core/console --generate for you and notifies you of errors using a OS Native Notification.

`plTasks.watch()` - Watch Pattern Lab

Watch and Compile Pattern Lab.

Configuration

All configuration is deep merged with config.default.js.

`configFile`

Type: String Default: pattern-lab/config/config.yml

The configuration lifted from this file is where the plugin gets most of it's information such as: the sourceDir to determine which folder to watch, the path to core/console, and a few other options.

`watchedExtensions`

Type: Array<String>

Default:

[
  'twig',
  'json',
  'yaml',
  'yml',
  'md',
  'jpg',
  'jpeg',
  'png'
]

These file extensions are watched inside the sourceDir found in configFile and trigger the compile afterwards.

`extraWatches`

Type: Array<String> Default: []

Extra paths to watch that would trigger a compile.

`twigNamespaces`

Type: Object Default: {}

Allows auto-discovery of Twig files. Requires Pattern Lab plugin plugin-twig-namespaces. Can also work with Drupal, which requires Component Libraries Drupal module. Here's a typical full config:

const config = {
  configFile: 'pattern-lab/config/config.yml',
  twigNamespaces: {
    drupalThemeFile: './theme.info.yml', // optional
    sets: [
      {
        namespace: 'atoms',
        paths: ['pattern-lab/source/_patterns/01-atoms'],
      }, {
        namespace: 'molecules',
        paths: ['pattern-lab/source/_patterns/02-molecules'],
      }, {
        namespace: 'organisms',
        paths: ['pattern-lab/source/_patterns/03-organisms'],
      }, {
        namespace: 'templates',
        paths: ['pattern-lab/source/_patterns/04-templates'],
      }, {
        namespace: 'pages',
        paths: ['pattern-lab/source/_patterns/05-pages'],
      },
    ],
  },
};

For each set, it will find all Twig files nested at any depth under each item in paths, then set the namespace to look in there. Or more specifically, it will write the yaml config needed in Pattern Lab config for the plugin-twig-namespaces plugin to know of those Twig Namespaces, and if drupalThemeFile is set it will write the config needed for the Drupal module Component Libraries to know where to look for the files.

Why this helps

Given this basic file structure:

atoms/
- 01-buttons/
  - button.twig

To include the button, before you would have to write:

{% include '@atoms/01-buttons/button.twig' %}

And after using this, you could write:

{% include '@atoms/button.twig' %}

This will run before compile() each time, is very fast, and will result in your Pattern Lab config file and Drupal theme info file being altered, so commit those.