dush-options v1.0.1

dush-options

Adds .option, .enable and .disable methods to your dush application

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
  • dushOptions
  • .option
  • .enable
  • .disable
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install dush-options --save

or install using yarn

$ yarn add dush-options

Usage

For more use-cases see the tests

const dushOptions = require('dush-options')

API

dushOptions

A plugin for dush/minibase/base that adds .option, .enable and .disable methods to your app. You can pass options to be merged with app.options

Params

• options {Object}: optional, initial options to set to app.options property
• returns {Function}: a plugin function, pass it to .use method of dush/minibase/base

Example

var dush = require('dush')
var options = require('dush-options')

var app = dush()

// some initial options
var opts = { foo: 'bar' }

app.use(options(opts))

console.log(app.options) // => { foo: 'bar' }

console.log(app.option()) // => { foo: 'bar' }
console.log(app.option) // => function

console.log(app.enable) // => function
console.log(app.disable) // => function

.option

Set or get an option(s). Support dot notation syntax too. If there are no arguments it returns app.options. If key is string and no value argument, it gets that property from the app.options object - using get-value, so app.option('foo.bar.qux'). If key is object it is merged with app.options using mixin-deep. If both key and value is given then it sets value to key property, using set-value library.

Params

• key {String|Object}: path to some option property, e.g. a.b.c
• value {any}: if key is string, any value to set to key property
• returns {Object}: clone of the modified app.options object, or some key value

Example

var app = dush()
app.use(options({ initial: 'props' }))

console.log(app.options) // => { initial: 'props' }
console.log(app.option()) // => { initial: 'props' }

app.option({ foo: 'bar' })
console.log(app.options)
// => { initial: 'props', foo: 'bar' }

app.option('qux', 123)
console.log(app.options)
// => { initial: 'props', foo: 'bar', qux: 123 }

app.option('aa.bb.cc', 'dd')
console.log(app.options)
// => {
//  initial: 'props',
//  foo: 'bar',
//  qux: 123,
//  aa: { bb: { cc: 'dd' } }
// }

console.log(app.option('aa.bb')) // => { cc: 'dd' }
console.log(app.option('aa')) // => { bb: { cc: 'dd' }
console.log(app.option('foo')) // => 'bar'

.enable

Enables a key to have true value. It is simply just a shortcut for app.option('foo', true).

Params

• key {String}: a path to property to enable
• returns {Object}: always self for chaining

Example

app.use(options())
console.log(app.options) // => {}

app.enable('foo')
console.log(app.options) // => { foo: true }

app.enable('qux.baz')
console.log(app.options) // => { foo: true, qux: { baz: true } }

.disable

Disable a key to have false value. It is simply just a shortcut for app.option('zzz', false).

Params

• key {String}: a path to property to disable
• returns {Object}: always self for chaining

Example

app.use(options())
console.log(app.options) // => {}

app.enable('foo')
console.log(app.options) // => { foo: true }

app.disable('foo')
console.log(app.options) // => { foo: false }

app.enable('qux.baz')
console.log(app.options.qux) // => { baz: true }

app.disable('qux.baz')
console.log(app.options.qux) // => { baz: false }

Related

• base-options: Adds a few options methods to base-methods, like option, enable and disable. See the readme for the full API. | homepage
• base-plugins: Upgrade's plugin support in base applications to allow plugins to be called any time after init. | homepage
• base: Framework for rapidly creating high quality node.js applications, using plugins like building blocks | homepage
• dush-no-chaining: A plugin that removes the emitter methods chaining support for dush, base, minibase or anything based on them | 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 ~260 bytes, extensible through plugins. | homepage
• minibase-create-plugin: Utility for minibase and base that helps you create plugins | homepage
• minibase-is-registered: Plugin for minibase and base, that adds isRegistered method to your application to detect if plugin is already registered and… more | homepage
• minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… 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 02, 2017.
Project scaffolded using charlike cli.