Git Product home page Git Product logo

clibuilder's Introduction

CLI Builder

unstable NPM version NPM downloads Build status Coverage Status

Building CLI based on Command Pattern.

clibuilder-testutil contains test utilities to help you test against your application.

Usage

// bin.ts
import { Cli } from 'clibuilder'

import { commandA, commandB } from './commands'

const cli = new Cli('yourcli', '1.0.0', [commandA, commandB])
cli.parse(process.argv)

// commands.ts
import { CommandSpec } from 'clibuilder'

export const commandA = {
  name: 'echo',
  // `args` is the parsed minimist args.
  // `argv` is the raw argv.
  run(args, argv) {
    this.ui.info(argv)
  }
} as CommandSpec

You can override the display mechanism:

import { Cli, PlainPresenter } from 'clibuilder'

class YourPresenter extends PlainPresenter { ... }

const presenterFactory = {
  createCliPresenter(options) { return new YourPresenter(options) },
  createCommandPresenter(options) { return new YourPresenter(options) }
}

const cli = new Cli('yourcli', '1.0.0', [], { presenterFactory })

cli.parse(process.argv)

Contribute

# right after fork
npm install

# begin making changes
npm run watch

clibuilder's People

Contributors

unional avatar greenkeeper[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.