dush-better-use v1.1.1

dush-better-use

Adds support for named plugins and better error handling, by overriding the default .use method

You might also be interested in 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 :clap:

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
  • betterUse
  • .use
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install dush-better-use --save

or install using yarn

$ yarn add dush-better-use

Usage

For more use-cases see the tests

const dushBetterUse = require('dush-better-use')

API

betterUse

Overrides the default dush/minibase/base .use method to support named plugins and to have better error handling. It also adds/registers the minibase-is-registered plugin if not included already, so you will have .isRegistered method too. This plugin emits error event if something fail in plugin, instead of throwing.

Params

• opts {Object}: no options currently
• returns {Function}: a plugin function that should be passed to .use method

Example

var dush = require('dush')
var betterUse = require('dush-better-use')

var app = dush()
app.use(betterUse())

.use

Calls fn plugin immediately once, if name is string it registers it as "named" plugin so you can find its name at app.registered cache. It also emits error event if plugin fn throws.

Params

• name {String|Function}: name of the plugin or fn plugin function
• fn {Function|Object}: a plugin function, called immedately; or options object
• options {Object}: direclty passed as 2nd argument to fn
• returns {Object}: self "app" for chaining

Example

var called = 0

function plugin (app) {
  app.foo = 123
  called++
}

app.use('foobar', plugin)
app.use('foobar', plugin)
app.use('foobar', plugin)

console.log(called) // => 1
console.log(app.foo) // => 123
console.log(app.registered) // => { 'foobar': true }

// if something fails in a plugin
// it emits `error` event
app.once('error', (err) => {
  console.log('ERR!', err.toString()) // => Error: sadly error
})
app.use((app) => {
  throw new Error('sadly error')
})

Related

• 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-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-create-plugin: Utility helper for creating dush/minibase plugins more easily. Plugins created with this may partially work for base too | 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-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

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