Coder Social home page Coder Social logo

node-minibase / minibase-is-registered Goto Github PK

View Code? Open in Web Editor NEW
3.0 2.0 0.0 114 KB

Plugin for MiniBase and Base, that adds isRegistered method to your application to detect if plugin is already registered and returns true if the given value is a base instance and a named plugin is already registered on the instance.

License: MIT License

JavaScript 100.00%
dush dushplugin minibaseplugin minibase is-registered registered check utils

minibase-is-registered's Introduction

minibase-is-registered npm version github tags mit license

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.

code climate code style commitizen friendly greenkeeper friendly dependencies

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).

following semver semantic releases linux build windows build code coverage nyc coverage

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

tunnckoCore support code mentor paypal donate NPM monthly downloads npm total downloads

Table of Contents

(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

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())

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

Related

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

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.

minibase-is-registered's People

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

minibase-is-registered's Issues

An in-range update of dush-methods is breaking the build 🚨

Version 1.0.2 of dush-methods just got published.

Branch Build failing 🚨
Dependency dush-methods
Current Version 1.0.1
Type dependency

This version is covered by your current version range and after updating it in your project the build failed.

As dush-methods is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪


Status Details
  • ci/circleci CircleCI is running your tests Details

  • continuous-integration/appveyor/branch Waiting for AppVeyor build to complete Details

  • continuous-integration/travis-ci/push The Travis CI build failed Details

Commits

The new version differs by 4 commits .

  • be2a0e1 chore(release): 1.0.2
  • 577aead fix(ci): move to CircleCI instead of TravisCI
  • a62e109 docs(readme): update
  • 721553e fix(index.js): add isRegistered check

See the full diff.

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.


Your Greenkeeper Bot 🌴

An in-range update of nyc is breaking the build 🚨

Version 10.3.0 of nyc just got published.

Branch Build failing 🚨
Dependency nyc
Current Version 10.2.2
Type devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As nyc is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Status Details - ❌ **ci/circleci** CircleCI is running your tests [Details](https://circleci.com/gh/node-minibase/minibase-is-registered/15?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-build-link),- ❌ **continuous-integration/appveyor/branch** Waiting for AppVeyor build to complete [Details](https://ci.appveyor.com/project/tunnckoCore/minibase-is-registered/build/1.0.60),- ❌ **continuous-integration/travis-ci/push** The Travis CI build failed [Details](https://travis-ci.org/node-minibase/minibase-is-registered/builds/227085864?utm_source=github_status&utm_medium=notification)

Commits

The new version differs by 4 commits ahead by 4, behind by 2.

  • 55e826d chore(release): 10.3.0
  • 89dc7a6 chore: explicit update of istanbul dependnecies (#562)
  • 1887d1c feat: add support for --no-clean, to disable deleting raw coverage output (#558)
  • ff73b18 fix: source-maps were not being cached in the parent process when --all was being used (#556)

false

See the full diff

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.


Your Greenkeeper Bot 🌴

An in-range update of minibase is breaking the build 🚨

Version 0.4.4 of minibase just got published.

Branch Build failing 🚨
Dependency minibase
Current Version 0.4.3
Type devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As minibase is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪


Status Details
  • continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

  • coverage/coveralls First build on greenkeeper/minibase-0.4.4 at 100.0% Details

Commits

The new version differs by 2 commits .

  • 76cb25f chore(release): 0.4.4
  • af929e8 fix(node): support node >= 0.10.0

See the full diff.

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.


Your Greenkeeper Bot 🌴

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.