{%= name %} [![npm version][npmv-img]][npmv-url] [![github tags][ghtag-img]][ghtag-url] [![mit license][license-img]][license-url]
{%= description %}
You might want to use this utility to create plugins for [minibase][] or [base][], even for the miscroscopic event emitter [dush][].
By using commitizen and [conventional commit messages][conventional-messages-url], maintaining meaningful [ChangeLog][changelogmd-url] and commit history based on [global conventions][conventions-url], following StandardJS code style through [ESLint][eslint-url] and having always up-to-date dependencies through integrations like [GreenKeeper][gk-integration-url] and [David-DM][daviddm-url] service, this package has top quality.
[![code climate][codeclimate-img]][codeclimate-url]
By following [Semantic Versioning][semver-url] through [standard-version][] releasing tool, this package is very stable and its tests are passing both on [Windows (AppVeyor)][appveyor-ci-url] and [Linux (CircleCI)][circle-ci-url] with results from 100% to [400%][absolute-coverage-url] test coverage, reported respectively by [CodeCov][codecov-coverage-url] and [nyc (istanbul)][nyc-istanbul-url].
If you have any problems, consider opening [an issue][open-issue-url], ping me on twitter ([@tunnckoCore][tunnckocore-twitter-url]), 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][opensource-project-url] project made with love at Sofia, Bulgaria 🇧🇬.
Install with npm
$ npm install {%= name %} --save
or install using yarn
$ yarn add {%= name %}
For more use-cases see the tests
const {%= varname %} = require('{%= name %}'){%= apidocs('index.js') %}
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'{% if (verb.related && verb.related.list && verb.related.list.length) { %}
{%= related(verb.related.list, {words: 20}) %} {% } %}
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue][open-issue-url].
Please read the [contributing guidelines][contributing-url] 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
- Please DO NOT edit README.md, [CHANGELOG.md][changelogmd-url] and .verb.md files. See "Building docs" section.
- Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
- Always use
npm run committo commit changes instead ofgit commit, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy. - 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! :)
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.
Clone repository and run the following in that cloned directory
$ npm install && npm test
{%= includeEither('authors', 'author') %}
{%= copyright({ start: 2016, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= licenseStatement %}
{%= include('footer') %}
Project scaffolded using [charlike][] cli.
{%= reflinks(verb.reflinks) %}
[license-url]: https://github.com/{%= repository %}/blob/master/LICENSE [license-img]: https://img.shields.io/npm/l/{%= name %}.svg
[downloads-url]: https://www.npmjs.com/package/{%= name %} [downloads-img]: https://img.shields.io/npm/dt/{%= name %}.svg
[codeclimate-url]: https://codeclimate.com/github/{%= repository %} [codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg
[circle-url]: https://circleci.com/gh/{%= repository %} [circle-img]: https://img.shields.io/circleci/project/github/{%= repository %}/master.svg?label=linux
[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %} [appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows
[codecov-url]: https://codecov.io/gh/{%= repository %} [codecov-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg?label=codecov
[daviddm-deps-url]: https://david-dm.org/{%= repository %} [daviddm-deps-img]: https://img.shields.io/david/{%= repository %}.svg
[daviddm-devdeps-url]: https://david-dm.org/{%= repository %}?type=dev [daviddm-devdeps-img]: https://img.shields.io/david/dev/{%= repository %}.svg
[ghtag-url]: https://github.com/{%= repository %}/tags [ghtag-img]: https://img.shields.io/github/tag/{%= repository %}.svg?label=github%20tag
[npmv-url]: https://www.npmjs.com/package/{%= name %} [npmv-img]: https://img.shields.io/npm/v/{%= name %}.svg?label=npm%20version
[changelogmd-url]: https://github.com/{%= repository %}/blob/master/CHANGELOG.md [conventions-url]: https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md [tunnckocore-twitter-url]: https://twitter.com/tunnckoCore [opensource-project-url]: http://openopensource.org [nyc-istanbul-url]: https://istanbul.js.org [circle-ci-url]: https://circleci.com [appveyor-ci-url]: https://appveyor.com [codecov-coverage-url]: https://codecov.io [semver-url]: http://semver.org [eslint-url]: http://eslint.org [conventional-messages-url]: https://github.com/conventional-changelog/conventional-changelog [gk-integration-url]: https://github.com/integration/greenkeeper [daviddm-url]: https://david-dm.org [open-issue-url]: https://github.com/{%= repository %}/issues/new [contributing-url]: https://github.com/{%= repository %}/blob/master/CONTRIBUTING.md [absolute-coverage-url]: https://github.com/{%= repository %}/blob/master/package.json