Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

fuse-box-cli

0.0.2 • Public • Published

fuse-box-cli

npm

Fusebox is a nice piece of software, i really like it! But sadly there is no easy way for providing options.
For this reason i created this module.

Features

  • Works with zero configuration! (Just like FuseBox)
  • Nice formatted help
  • Powerfull options api, thanks to yargs

Examples

Zero configuration

fuse.js:

const { FuseBox, Sparky } = require('fuse-box')
const { options } = require('fuse-box-cli')
 
Sparky.task('clean:dist', () => console.log('Cleaning...'))
Sparky.task('default', ['clean:dist'], () => console.log('Default ran!'))

Now running the script it will output something like this:

D:\Programming\Projects\some-project> node fuse -h
Usage: fuse <task> [options]

Tasks:
  clean:dist
* default      The default task

Options:
  --help, -h  Show help                                                [boolean]

Simple init

fuse.js:

const { FuseBox, Sparky } = require('fuse-box')
const { options } = require('fuse-box-cli')
  .init({
    taskDescriptions: {
      'clean:dist': 'Cleans the dist folder'
    },
    options: {
      alert: {
        desc: 'Alerts something!',
        type: 'boolean',
        default: false
      }
    }
  })
 
if (options.alert) {
  console.log('ALLLLEEERRRT! ALLLEEEEERRRTTT!')
  process.exit(0)
}
 
Sparky.task('clean:dist', () => console.log('Cleaning...'))
Sparky.task('default', ['clean:dist'], () => console.log('Default ran!'))

Now running the script it will output something like this:

D:\Programming\Projects\some-project> node fuse --alert
ALLLLEEERRRT! ALLLEEEEERRRTTT!

or

D:\Programming\Projects\some-project> node fuse -h
Usage: fuse <task> [options]

Tasks:
  clean:dist   Cleans the dist folder
* default      The default task

Options:
  --help, -h  Show help                                                [boolean]
  --alert     Alerts something!                       [boolean] [default: false]

Install

npm i fuse-box-cli

DownloadsWeekly Downloads

0

Version

0.0.2

License

MIT

Last publish

Collaborators

  • avatar