minibase-create-plugin

Utility helper for creating dush/minibase or base named or anonymous plugins more easily

You might want to use this utility to create plugins for minibase or base, even for the miscroscopic event emitter dush.

Quality 👌

By using commitizen and conventional commit messages, maintaining meaningful ChangeLog and commit history based on global conventions, following StandardJS code style through ESLint and having always up-to-date dependencies through integrations like GreenKeeper and David-DM service, this package has top quality.

Stability 💯

By following Semantic Versioning through standard-version releasing tool, this package is very stable and its tests are passing both on Windows (AppVeyor) and Linux (CircleCI) with results from 100% to 400% test coverage, reported respectively by CodeCov and nyc (istanbul).

Support 👏

If you have any problems, consider opening an issue, ping me on twitter (@tunnckoCore), join the support chat room or queue a live session on CodeMentor with me. If you don't have any problems, you're using it somewhere or you just enjoy this product, then please consider donating some cash at PayPal, since this is OPEN Open Source project made with love at Sofia, Bulgaria 🇧🇬.

Table of Contents

• Install
• Usage
• API
  • minibaseCreatePlugin
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install minibase-create-plugin --save

or install using yarn

$ yarn add minibase-create-plugin

Usage

For more use-cases see the tests

const minibaseCreatePlugin = require('minibase-create-plugin')

API

minibaseCreatePlugin

A helper function for creating Base/MiniBase plugins. These plugins will be protected by .isRegistered too, so plugin will be called only once. If plugin fail, it will emit error event, because this utility uses dush-better-use under the hood. The plugin options are not merged with the app.options.

Params

• [name] {String|Function}: optional, name of the plugin; or fn plugin
• fn {Function}: a plugin function, called with (app, options) signature, where options is the passed object to the returned function
• returns {Function}: a function that accepts optional options object and returns a function that should be passed to .use method. Options are also merged with the options passed to the second/third argument of .use method, but not with the app.options - they are separate things and that's up to you

Example

var createPlugin = require('minibase-create-plugin')

var dush = require('dush')
var app = dush()

var called = 0
var plugin = createPlugin('zazzy', function (app, options) {
  console.log(app.options) // => undefined
  console.log(options) // => { foo: 'bar', aaa: 123 }
  called++
})

var fn = plugin({ foo: 'bar' })

app.use(fn, { aaa: 123 })
app.use(fn)
app.use(fn, { zz: 'zz' })

// called only once
console.log(called) // => 1

// included at app registered cache
console.log(app.registered) // => { zazzy: true }

This helper function is meant to be used for creating plugin factories more easily. For example if you want to create some-foo-bar plugin that adds .foo method to app and based on plugin options to return different things

index.js of some-foo-bar plugin:

var createPlugin = require('minibase-create-plugin')

module.exports.basePlugin = createPlugin('some-foo-bar', function (app, base, options, env) {
  app.define('foo', function (val) {
    return !val && options.foo ? 123 : 'bar'
  })
})

module.exports.minibasePlugin = createPlugin('fooqux', function (app, options) {
  app.define('foo', function () {
    return options.quxie
  })
})

Later use this plugin in dush/minibase or base, by passing it to .use method like this

var Base = require('base')

var plugin = require('some-foo-bar').basePlugin
var base = new Base()

// called only once, no matter
// it is added multiple times
base.use(plugin({ foo: 123 }))
base.use(plugin(), { aa: 'bb' })
base.use(plugin({ foo: 123 }))

console.log(base.foo()) // => 123
console.log(base.foo(555)) // => 'bar'

// added to app registered cache too
console.log(base.registered) // => { 'some-foo-bar': true }

// works for MiniBase/dush too
var Dush = require('dush')
var MiniBase = require('minibase')

var minibase = MiniBase()
var dush = Dush()

var plugin = require('some-foo-bar').minibasePlugin
minibase.use(plugin({ quxie: 555 }))
console.log(minibase.foo()) // => 555

dush.use(plugin({ quxie: 'abc' }))
console.log(dush.foo()) // => 'abc'

Related

• base: Framework for rapidly creating high quality node.js applications, using plugins like building blocks | homepage
• dush-better-use: Adds support for named plugins and better error handling, by overriding the default .use method | homepage
• dush-no-chaining: A plugin that removes the emitter methods chaining support for dush, base, minibase or anything based on them | homepage
• dush-options: Adds .option, .enable and .disable methods to your dush application | homepage
• dush-promise: Plugin for dush that makes it a Deferred promise and adds .resolve, .reject, .than and .catch methods for more better… more | homepage
• dush-router: A simple regex-based router for dush, base, minibase and anything based on them. Works on Browser and Node.js | homepage
• dush-tap-report: A simple TAP report producer based on event system. A plugin for dush event emitter or anything based on it | homepage
• dush: Microscopic & functional event emitter in ~350 bytes, extensible through plugins | homepage
• minibase-is-registered: Plugin for dush, minibase and base, that adds isRegistered method to your application to detect if plugin is already registered… more | homepage
• minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use npm run release, which is standard-version and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb command like that

$ npm install verbose/verb#dev verb-generate-readme --global && verb

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

Charlike Mike Reagent

• github/tunnckoCore
• twitter/tunnckoCore
• codementor/tunnckoCore

License

Copyright © 2016-2017, Charlike Mike Reagent. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.4.3, on April 03, 2017.
Project scaffolded using charlike cli.