utility-maker

Make your utilities library.

TOC

• Installation
• Quick Start
• Feature
• API
• Versioning
• Copyright and License

Installation

npm install --save utility-maker

Quick Start

Mixin JSON:

// util/index.js
const utilMaker = require('utility-maker');
const third = require('./third_party');
const overrides = require('./override');
const mixin = require('./mixin');
 
const util = utilMaker()
    .mixin(third)
    .mixin(overrides, {override: true})
    .mixin(mixin)
    .done();
 
module.exports = util;

Or mixin files:

// util/index.js
const utilMaker = require('utility-maker');
const baseDir = Path.resolve(__dirname);
const util = utilMaker()
    .load([
        'third_party',
        'mixin',
    ], {baseDir})
    .load([
        'override',
    ], {baseDir, override: true})
    .done();
 
module.exports = util;

Examples:

// util/mixin.js
module.exports = {
    version: 1,
    test: () => console.log('test'),
};

Feature

• Check duplicated keys when merge utils
• Allow to override util
• Separate utilities into many files for better code reading
• Chainable APIs. Very simple usage

API

[TODO] The specifications of API, and details not mentioned in README, would be referenced at API document.

Versioning

The versioning follows the rules of SemVer 2.0.0.

BUT, anything may have BREAKING CHANGES at ANY TIME when major version is zero (0.y.z), which is for initial development and the public API should be considered unstable.

When it is unstable, the version of installed package should be prefixed ~.

For more information on SemVer, please visit http://semver.org/.

Copyright and License

Copyright (c) 2016 ADoyle. The project is licensed under the Apache License Version 2.0.

See the LICENSE file for the specific language governing permissions and limitations under the License.

See the NOTICE file distributed with this work for additional information regarding copyright ownership.