README.md

produce - WIP

A multi-rule multi-purpose source/target agnostic configurable transformer

This module and documentation is still considered work-in-progress. Only no config example is added below for a preview

Usage Examples

As a module

Check produce-example-multihash. This is the current definitive example with concept outline.

Command line use

No Configuration

Install required plugins and it will automatically use them to produce output/serve content

Example: https://github.com/aularon/produce-example-no-conf

Micro Configuration

Very similar to No Config, plus you can set per-plugin settings in package.json

Example: https://github.com/aularon/produce-example-micro-conf

Next

Simple conf

less: less | add_header_note(preview) | yuicompressor(dist) > css
pug,jade: pug | add_header_note(preview) > html
js: babel | add_header_note(preview) | closure > js

Advanced conf

{
  rules: [
    {
      source: /\.(pug|jade)$/,
      via: [
        'pug',
        {
          processor: 'add_header_note',
          modes: ['serve']
        },
      ],
      target: 'css'
    }
  ]
}

Terminology

• Source.read(input)
• Target.write(output)

CLI

proudce sourceDir targetDir # fs source and fs target
proudce sourceDir # fs source and http target