https://github.com/tunnckocore/dush-better-use

Adds support for named plugins and better error handling, by overriding the default `.use` method
https://github.com/tunnckocore/dush-better-use
baseplugin dush dushplugin error-handling minibaseplugin named-plugins override plugins use
Last synced: 7 months ago
JSON representation
Adds support for named plugins and better error handling, by overriding the default `.use` method
Host: GitHub
URL: https://github.com/tunnckocore/dush-better-use
Owner: tunnckoCore
License: mit
Created: 2017-04-01T18:24:46.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2023-01-12T05:46:10.000Z (almost 3 years ago)
Last Synced: 2025-04-02T18:55:23.795Z (9 months ago)
Topics: baseplugin, dush, dushplugin, error-handling, minibaseplugin, named-plugins, override, plugins, use
Language: JavaScript
Size: 494 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 12
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project

README

          # dush-better-use [![npm version][npmv-img]][npmv-url] [![github tags][ghtag-img]][ghtag-url] [![mit license][license-img]][license-url]

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

You might also be interested in [dush](https://github.com/tunnckocore/dush#readme).

## Quality 👌

> By using [commitizen][czfriendly-url] and [conventional commit messages][conventional-messages-url], 

maintaining meaningful [ChangeLog][changelogmd-url] 

and commit history based on [global conventions][conventions-url], 

following [StandardJS][standard-url] 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] 

[![code style][standard-img]][standard-url] 

[![commitizen friendly][czfriendly-img]][czfriendly-url] 

[![greenkeeper friendly][gkfriendly-img]][gkfriendly-url] 

[![dependencies][daviddm-deps-img]][daviddm-deps-url] 

## Stability 💯

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

[![following semver][following-semver-img]][following-semver-url] 

[![semantic releases][strelease-img]][strelease-url] 

[![linux build][circle-img]][circle-url] 

[![windows build][appveyor-img]][appveyor-url] 

[![code coverage][codecov-img]][codecov-url] 

[![nyc coverage][istanbulcov-img]][istanbulcov-url] 

## Support :clap:

> If you have any problems, consider opening [an issue][open-issue-url],

ping me on twitter ([@tunnckoCore][tunnckocore-twitter-url]),

join the [support chat][supportchat-url] room

or queue a [live session][codementor-url] 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][paypalme-url] at PayPal,

since this is [OPEN Open Source][opensource-project-url] project made

with love at [Sofia, Bulgaria][bulgaria-url] 🇧🇬.

[![tunnckoCore support][supportchat-img]][supportchat-url] 

[![code mentor][codementor-img]][codementor-url] 

[![paypal donate][paypalme-img]][paypalme-url] 

[![NPM monthly downloads](https://img.shields.io/npm/dm/dush-better-use.svg?style=flat)](https://npmjs.org/package/dush-better-use) 

[![npm total downloads][downloads-img]][downloads-url] 

## Table of Contents

- [Install](#install)

- [Usage](#usage)

- [API](#api)

  * [betterUse](#betteruse)

  * [.use](#use)

- [Related](#related)

- [Contributing](#contributing)

- [Building docs](#building-docs)

- [Running tests](#running-tests)

- [Author](#author)

- [License](#license)

_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_

## Install

Install with [npm](https://www.npmjs.com/)

```

$ npm install dush-better-use --save

```

or install using [yarn](https://yarnpkg.com)

```

$ yarn add dush-better-use

```

## Usage

> For more use-cases see the [tests](test.js)

```js

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

```

## API

### [betterUse](index.js#L37)

> 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**

```js

var dush = require('dush')

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

var app = dush()

app.use(betterUse())

```

### [.use](index.js#L89)

> 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**

```js

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](https://www.npmjs.com/package/dush-methods): Plugin for `dush` and anything based on it. It adds helper `.define` and `.delegate` methods | [homepage](https://github.com/tunnckocore/dush-methods#readme "Plugin for `dush` and anything based on it. It adds helper `.define` and `.delegate` methods")

- [dush-no-chaining](https://www.npmjs.com/package/dush-no-chaining): A plugin that removes the emitter methods chaining support for `dush`, `base`, `minibase` or anything based on them | [homepage](https://github.com/tunnckocore/dush-no-chaining#readme "A plugin that removes the emitter methods chaining support for `dush`, `base`, `minibase` or anything based on them")

- [dush-options](https://www.npmjs.com/package/dush-options): Adds `.option`, `.enable` and `.disable` methods to your `dush` application | [homepage](https://github.com/tunnckocore/dush-options#readme "Adds `.option`, `.enable` and `.disable` methods to your `dush` application")

- [dush-promise](https://www.npmjs.com/package/dush-promise): Plugin for `dush` that makes it a Deferred promise and adds `.resolve`, `.reject`, `.than` and `.catch` methods for more better… [more](https://github.com/tunnckocore/dush-promise#readme) | [homepage](https://github.com/tunnckocore/dush-promise#readme "Plugin for `dush` that makes it a Deferred promise and adds `.resolve`, `.reject`, `.than` and `.catch` methods for more better error handling experience")

- [dush-router](https://www.npmjs.com/package/dush-router): A simple regex-based router for `dush`, `base`, `minibase` and anything based on them. Works on Browser and Node.js | [homepage](https://github.com/tunnckocore/dush-router#readme "A simple regex-based router for `dush`, `base`, `minibase` and anything based on them. Works on Browser and Node.js")

- [dush-tap-report](https://www.npmjs.com/package/dush-tap-report): A simple TAP report producer based on event system. A plugin for `dush` event emitter or anything based on it | [homepage](https://github.com/tunnckocore/dush-tap-report#readme "A simple TAP report producer based on event system. A plugin for `dush` event emitter or anything based on it")

- [dush](https://www.npmjs.com/package/dush): Microscopic & functional event emitter in ~350 bytes, extensible through plugins | [homepage](https://github.com/tunnckocore/dush#readme "Microscopic & functional event emitter in ~350 bytes, extensible through plugins")

- [minibase-create-plugin](https://www.npmjs.com/package/minibase-create-plugin): Utility helper for creating [dush][]/[minibase][] plugins more easily. Plugins created with this _may_ partially work for [base][] too | [homepage](https://github.com/node-minibase/minibase-create-plugin#readme "Utility helper for creating [dush][]/[minibase][] plugins more easily. Plugins created with this _may_ partially work for [base][] too")

- [minibase-is-registered](https://www.npmjs.com/package/minibase-is-registered): Plugin for [dush][], [minibase][] and [base][], that adds `isRegistered` method to your application to detect if plugin is already registered… [more](https://github.com/node-minibase/minibase-is-registered#readme) | [homepage](https://github.com/node-minibase/minibase-is-registered#readme "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")

- [minibase-visit](https://www.npmjs.com/package/minibase-visit): Plugin for [minibase][] and [base][], that adds `.visit` method to your application to visit a method over the items in… [more](https://github.com/node-minibase/minibase-visit#readme) | [homepage](https://github.com/node-minibase/minibase-visit#readme "Plugin for [minibase][] and [base][], that adds `.visit` method to your application to visit a method over the items in an object, or map visit over the objects in an array. Using using [collection-visit][] package.")

## Contributing

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][codementor-url] too.

**In short:** If you want to contribute to that project, please follow these things

1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md][changelogmd-url] and [.verb.md](.verb.md) files. See ["Building docs"](#building-docs) section.

2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#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](.verb.md)._

## Running tests

Clone repository and run the following in that cloned directory

```

$ npm install && npm test

```

## Author

**Charlike Mike Reagent**

+ [github/tunnckoCore](https://github.com/tunnckoCore)

+ [twitter/tunnckoCore](https://twitter.com/tunnckoCore)

+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)

## License

Copyright © 2017, [Charlike Mike Reagent](https://i.am.charlike.online). Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on April 03, 2017._  

_Project scaffolded using [charlike][] cli._

[base]: https://github.com/node-base/base

[charlike]: https://github.com/tunnckocore/charlike

[commitizen]: https://github.com/commitizen/cz-cli

[dush]: https://github.com/tunnckocore/dush

[minibase-is-registered]: https://github.com/node-minibase/minibase-is-registered

[minibase]: https://github.com/node-minibase/minibase

[standard-version]: https://github.com/conventional-changelog/standard-version

[verb-generate-readme]: https://github.com/verbose/verb-generate-readme

[verb]: https://github.com/verbose/verb

[license-url]: https://github.com/tunnckoCore/dush-better-use/blob/master/LICENSE

[license-img]: https://img.shields.io/npm/l/dush-better-use.svg

[downloads-url]: https://www.npmjs.com/package/dush-better-use

[downloads-img]: https://img.shields.io/npm/dt/dush-better-use.svg

[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/dush-better-use

[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/dush-better-use.svg

[circle-url]: https://circleci.com/gh/tunnckoCore/dush-better-use

[circle-img]: https://img.shields.io/circleci/project/github/tunnckoCore/dush-better-use/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/dush-better-use

[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/dush-better-use/master.svg?label=windows

[codecov-url]: https://codecov.io/gh/tunnckoCore/dush-better-use

[codecov-img]: https://img.shields.io/codecov/c/github/tunnckoCore/dush-better-use/master.svg?label=codecov

[daviddm-deps-url]: https://david-dm.org/tunnckoCore/dush-better-use

[daviddm-deps-img]: https://img.shields.io/david/tunnckoCore/dush-better-use.svg

[daviddm-devdeps-url]: https://david-dm.org/tunnckoCore/dush-better-use?type=dev

[daviddm-devdeps-img]: https://img.shields.io/david/dev/tunnckoCore/dush-better-use.svg

[ghtag-url]: https://github.com/tunnckoCore/dush-better-use/tags

[ghtag-img]: https://img.shields.io/github/tag/tunnckoCore/dush-better-use.svg?label=github%20tag

[npmv-url]: https://www.npmjs.com/package/dush-better-use

[npmv-img]: https://img.shields.io/npm/v/dush-better-use.svg?label=npm%20version

[standard-url]: https://github.com/feross/standard

[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

[paypalme-url]: https://www.paypal.me/tunnckoCore

[paypalme-img]: https://img.shields.io/badge/paypal-donate-brightgreen.svg

[czfriendly-url]: http://commitizen.github.io/cz-cli

[czfriendly-img]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg

[gkfriendly-url]: https://greenkeeper.io/

[gkfriendly-img]: https://img.shields.io/badge/greenkeeper-friendly-brightgreen.svg

[codementor-url]: https://www.codementor.io/tunnckocore?utm_source=github&utm_medium=button&utm_term=tunnckocore&utm_campaign=github

[codementor-img]: https://img.shields.io/badge/code%20mentor-live%20session-brightgreen.svg

[istanbulcov-url]: https://twitter.com/tunnckoCore/status/841768516965568512

[istanbulcov-img]: https://img.shields.io/badge/istanbul-400%25-brightgreen.svg

[following-semver-url]: http://semver.org

[following-semver-img]: https://img.shields.io/badge/following-semver-brightgreen.svg

[strelease-url]: https://github.com/conventional-changelog/standard-version

[strelease-img]: https://img.shields.io/badge/using-standard%20version-brightgreen.svg

[supportchat-url]: https://gitter.im/tunnckoCore/support

[supportchat-img]: https://img.shields.io/gitter/room/tunnckoCore/support.svg

[bulgaria-url]: https://www.google.bg/search?q=Sofia%2C+Bulgaria "One of the top 10 best places for start-up business in the world, especially in IT technologies"

[changelogmd-url]: https://github.com/tunnckoCore/dush-better-use/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/tunnckoCore/dush-better-use/issues/new

[contributing-url]: https://github.com/tunnckoCore/dush-better-use/blob/master/CONTRIBUTING.md

[absolute-coverage-url]: https://github.com/tunnckoCore/dush-better-use/blob/master/package.json

[collection-visit]: https://github.com/jonschlinkert/collection-visit
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/tunnckocore/dush-better-use

Awesome Lists containing this project

README
