[Patternlibrary GUI v0.0.1]

Patternlibrary - Options and configuration


Configuration

on instanciation :

const PL = new Patternlibrary(options);

with config method:

const PL = new Patternlibrary();

// ...

PL.config(options);

on initialisation :

const PL = new Patternlibrary();

// ...

PL.run(options);

section in package.json file:

{
  "name": "my-package",
  "version": "1.2.3",

  // ...
  
  "patternlibrary": {
  
    "root"    : "src/pages",
    "partials": "src/components",
    
    // ...

  }

}

a separate .patternlibrary.rc file in your project root:

{
  "root"    : "src/pages",
  "partials": "src/components",

  // ...

}


Options

For a reference of all options applied, you can also take a look at the lib/config/defaults.js file inside Patternlibrary's source/module folder.

Basics

This basic set of options is similar to the one set for the 'Panini' module used by the 'Zurb Foundation' project.


Special options


Middleware options


Sub-modules' options

You can also set some module specific options.
But use them with caution! They strongly influence Patternlibrary's functionality. Some really critical options are overruled by hard-coded settings.