Skip to content

Latest commit

 

History

History
258 lines (191 loc) · 10.8 KB

.verb.md

File metadata and controls

258 lines (191 loc) · 10.8 KB
Raw

{%= name %} [![npm version][npmv-img]][npmv-url] [![github tags][ghtag-img]][ghtag-url] [![mit license][license-img]][license-url]

{%= description %}

You might also be interested in [mitt][] - a 200 bytes event emitter. It has strict policy to stay exactly below 200b with no compromises, so has lack of support for few things and that's why dush exists.

Quality 👌

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] code style commitizen friendly greenkeeper friendly [![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 semantic releases [![linux build][circle-img]][circle-url] [![windows build][appveyor-img]][appveyor-url] [![code coverage][codecov-img]][codecov-url] nyc coverage

Support 👏

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

tunnckoCore support code mentor paypal donate {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]

Highlights ✨

  • Microscopic: Around ~400 bytes gzip + minify, including the UMD wrapper.
  • Functional: Methods don't rely on this context.
  • Modern: Work on latest JavaScript versions, but on Node.js 0.10 too.
  • Extensible: Through simple plugins, for more customizations.
  • Compatibility: Almost like Node's EventEmitter.
  • Compliant: Can .emit events with multiple params.
  • Chaining: Support all methods to be chainable.
  • Useful: A wildcard '*' event type listens to all events.
  • Friendly: Plays well with [browserify][], [webpack][] and browser users.
  • Bundled: Available as ES6 Module, CommonJS and UMD.
  • Meaning: Hear it. It just means shower in Bulgarian.
  • Clean: Does not mess with DOM or anything.

Plugins

  • [dush-router][] - Simple regex-based router with Express-like routing, for browser and nodejs
  • [dush-promise][] - Makes dush a Deferred promise, centralized error handling
  • [dush-methods][] - Adds .define and .delegate methods for defining non-enumerables
  • [dush-options][] - Adds .option method and app.options property
  • dush-plugins - Upgrades the current plugin system with support for smart plugins
  • [dush-tap-report][] - Produces TAP report, based on events such as pass, fail, start and finish
  • [dush-better-use][] - Adds support for named plugins and better error handling
  • [dush-no-chaining][] - Removes the support for chaining methods

Table of Contents

Install

Install with npm

$ npm install {%= name %} --save

or install using yarn

$ yarn add {%= name %}

or using unpkg CDN

<script src="https://unpkg.com/dush/dist/dush.umd.js"></script>

Note: Don't use Unpkg's short-hand endpoint https://unpkg.com/dush, since it points to CommonJS bundle.

Usage

Modern importing, using [rollup][] or [webpack][] bundler

import dush from 'dush'

Node.js require as CommonJS module

var dush = require('dush')

Old school in browsers, available at global scope

<script>
  var emitter = dush()
</script>

API

{%= apidocs('src/index.js') %}

{% if (verb.related && verb.related.list && verb.related.list.length) { %}

Related

{%= related(verb.related.list, {words: 20}) %} {% } %}

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

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

  1. Please DO NOT edit README.md, [CHANGELOG.md][changelogmd-url] 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

{%= includeEither('authors', 'author') %}

License

{%= copyright({ start: 2015, 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