minibase-create-plugin

Utility for minibase and base that helps you create plugins

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

Creates a plugin for Base and MiniBase, that uses the minibase-is-registered under the hood to provide more stable and friendly API for plugins.

Params

• name {String}: name of the plugin, passed to .isRegistered
• fn {Function}: plugin function, passed to .use method, so called immediately
• returns {Function}: plugin function that should be passed to .use method

Example

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

var called = 0

var plugin = createPlugin('foo-bar', function (self) {
  called++
  self.foo = 'bar'
  self.define('qux', function quxMethod () {})
  self.define('abc', function abc () {})
})

minibase.use(plugin)
minibase.use(plugin)

console.log(minibase.foo) // => 'bar'
console.log(minibase.qux) // => Function: qux
console.log(minibase.abc) // => Function: abc
console.log(minibase.registered) // => { 'foo-bar': ['qux', 'abc'] }

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

Related

• minibase-assert: Plugin for minibase and base, that adds assertion methods - most of assert-kindof methods and built-ins… more | homepage
• minibase-better-define: Plugin for base and minibase that overrides the core .define method to be more better. | homepage
• minibase-is-registered: Plugin for minibase and base, that adds isRegistered method to your application to detect if plugin… more | homepage
• minibase-visit: Plugin for minibase and base, that adds .visit method to your application to visit a method… more | homepage
• minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most… 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.

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

License

Copyright © 2016, Charlike Mike Reagent. Released under the MIT license.

This file was generated by verb-generate-readme, v0.2.0, on November 17, 2016.