@coffeekraken/s-code-formatter

{{#> layout-readme }}

SBuilder

This package expose a simple SBuilder class that is meant to be extended for each builder you want to create.

For now, this class is the main one used in builders like:

• @coffeekraken/s-favicon-builder
• @coffeekraken/s-images-builder
• @coffeekraken/s-markdown-builder
• @coffeekraken/s-postcss-builder
• @coffeekraken/s-sitemap-builder
• @coffeekraken/s-static-builder
• @coffeekraken/s-typescript-builder

Features

This simple base class gives you some features like:

• Specify a @coffeekraken/s-interface interface
• Expose a build method that accepts a params object which reflect your interface
• Let you define a _build method that will be called with your resolved params object

Usage

Here's a simple example of a custom builder:

import SBuilder from '@coffeekraken/s-builder';
import SPromise from '@coffeekraken/s-promise';
class MyBuilder extends SBuilder {
    constructor(settings = {}) {
        super(settings);
    }
    _build(params, settings) {
        return new SPromise(({ resolve, reject, emit }) => {
            // compilation logic
        });
    }
}

{{/ layout-readme }}