minibase-is-registered

Plugin for dush, minibase and base, that adds isRegistered method to your application to detect if plugin is already registered and returns true or false if named plugin is already registered on the instance

You might also be interested in minibase.

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 🇧🇬.

Install
Usage
API
- minibaseIsRegistered
- .isRegistered
Related
Contributing
Building docs
Running tests
Author
License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install minibase-is-registered --save

or install using yarn

$ yarn add minibase-is-registered

Usage

For more use-cases see the tests

const minibaseIsRegistered = require('minibase-is-registered')

API

minibaseIsRegistered

Adds .isRegistered method to your application. That opts option is optional and does nothing. It is just convention each plugin to export function that returns a plugin.

Params

opts {Object}: optional, no options currently
returns {Function}: plugin that can be pass to base/minibase's .use method

Example

var isRegistered = require('minibase-is-registered')

var MiniBase = require('minibase').MiniBase
var app = new MiniBase()
app.use(isRegistered())

// or as Base plugin

var Base = require('base')
var base = new Base()
base.use(isRegistered())

.isRegistered

Checks if given name exists in app.registered cache object, to detect if should call the plugin or not. It also returns false if not a string passed to it.

Params

name {String}: name of the plugin
returns {Boolean}: always boolean true or false

Example

app.use(isRegistered())

var called = 0

function fakePlugin () {
  return function foo (app) {
    if (app.isRegistered('foo')) return
    called = called + 22
  }
}

app.use(fakePlugin())
app.use(fakePlugin())

// the plugin `fakePlugin` is called only once
// if it was called two times `called` will be 44
console.log(called) // => 22

always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… more | homepage
dush-methods: Plugin for dush and anything based on it. It adds helper .define and .delegate methods | 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-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-better-define: Plugin for base and minibase that overrides the core .define method to be more better. | homepage
minibase-control-flow: Plugin for minibase and base that adds control flow methods .serial and .parallel to your application, based on the power… more | homepage
minibase-create-plugin: Utility helper for creating dush/minibase plugins more easily. Plugins created with this may partially work for base too | homepage
minibase-visit: Plugin for minibase and base, that adds .visit method to your application to visit a method over the items in… 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

Please DO NOT edit README.md, CHANGELOG.md 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 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.
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

License

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

node-minibase/minibase-is-registered