sushi 2.1.0 → 3.0.0

package/Readme.md

@@ -1,182 +0,0 @@
-# sushi
-
-[![Build Status](https://travis-ci.org/vdemedes/sushi.svg?branch=master)](https://travis-ci.org/vdemedes/sushi)
-[![Coverage Status](https://coveralls.io/repos/github/vdemedes/sushi/badge.svg?branch=master)](https://coveralls.io/github/vdemedes/sushi?branch=master)
-
-Express-like framework for CLI apps.
-
-<h1 align="center">
-	<br>
-	<img width="300" src="media/header.png">
-	<br>
-	<br>
-	<br>
-</h1>
-
-
-## Installation
-
-```
-$ npm install sushi --save
-```
-
-
-## Usage
-
-*myapp.js*:
-
-```js
-const sushi = require('sushi');
-
-const app = sushi();
-
-app.command('start', function () {
-  console.log('start command');
-});
-
-app.command('stop', function () {
-  console.log('stop command');
-});
-
-app.command('index', function () {
-  console.log('index command');
-});
-
-app.run();
-```
-
-Output:
-
-```
-$ node myapp.js start
-start command
-
-$ node myapp.js stop
-stop command
-
-$ node myapp.js
-index command
-```
-
-
-## Getting Started
-
-- [Arguments](#arguments)
-- [Index command](#index-command)
-- [Middleware](#middleware)
-- [Error handling](#error-handling)
-
-### Arguments
-
-Program arguments are parsed using [minimist](https://npmjs.org/package/minimist).
-Command can access arguments via `req.args`:
-
-```js
-app.command('start', function (req) {
-  var name = req.args._[0];
-  var delay = req.args.delay;
-
-  console.log('start', name, 'with', delay, 'delay');
-});
-```
-
-```
-$ node myapp.js start my-process --delay 500ms
-start my-process with 500ms delay
-```
-
-You can also customize the way `minimist` parses arguments by passing `args` options (see [minimist](https://www.npmjs.com/package/minimist#var-argv-parseargs-args-opts)):
-
-```js
-const app = sushi({
-	args: {
-		boolean: ['verbose']
-	}
-});
-```
-
-### Index command
-
-Index command is executed when other commands don't match the arguments:
-
-```js
-app.command('index', function () {
-  console.log('index command');
-});
-```
-
-```
-$ node myapp.js
-index command
-
-$ node myapp.js hello
-```
-
-### Middleware
-
-Middleware is a function, that modifies the context or arguments before target command is executed.
-
-```js
-app.use(function (req, next) {
-  req.context.ok = true;
-
-  // call `next()` when done
-  next();
-});
-
-app.command('start', function (req) {
-  req.context.ok === true; // true
-
-  console.log('start command');
-});
-```
-
-Middleware can also abort execution:
-
-```js
-app.use(function (req, next) {
-  var err = new Error('Fatal error');
-  next(err);
-});
-
-app.command('start', function (req) {
-  // won't be executed
-});
-
-app.on('error', function (err) {
-  // err is the Error instance from middleware
-  err.message === 'Fatal error'; // true
-});
-```
-
-### Error handling
-
-When one of the middleware or command itself throws an error,
-`error` event is emitted:
-
-```js
-app.on('error', function (err) {
-	// err is the Error instance
-});
-```
-
-You can use it to display a friendly error message, report it, etc.
-
-
-## List of middleware
-
-Here's the list of middleware you can use with Sushi:
-
-- [help](https://github.com/vdemedes/sushi-help) - help messages
-
-
-## Tests
-
-```
-$ npm test
-```
-
-
-## License
-
-MIT © [Vadym Demedes](http://vadimdemedes.com)

package/index.js

@@ -1,116 +0,0 @@
-'use strict';
-
-/**
- * Dependencies
- */
-
-var EventEmitter = require('events').EventEmitter;
-var setImmediate = require('set-immediate-shim');
-var inherits = require('util').inherits;
-var minimist = require('minimist');
-var each = require('each-series');
-
-
-/**
- * Sushi
- */
-
-function Sushi (options) {
-	if (!(this instanceof Sushi)) {
-		return new Sushi(options);
-	}
-
-	if (!options) {
-		options = {};
-	}
-
-	// custom data for each command
-	this.commandOptions = {};
-
-	this.middleware = [];
-	this.commands = {};
-	this.options = options;
-
-	EventEmitter.call(this);
-}
-
-inherits(Sushi, EventEmitter);
-
-Sushi.prototype.use = function (fn) {
-	this.middleware.push(fn);
-
-	return this;
-};
-
-Sushi.prototype.command = function (name, options, fn) {
-	if (typeof options === 'function') {
-		fn = options;
-		options = {};
-	}
-
-	this.commands[name] = fn;
-	this.commandOptions[name] = options;
-
-	return this;
-};
-
-Sushi.prototype.run = function (argv) {
-	var self = this;
-
-	if (!argv) {
-		argv = process.argv.slice(2);
-	}
-
-	var args = minimist(argv, this.options.args);
-	var name = args._[0] || 'index';
-
-	if (!this.commands[name]) {
-		name = 'index';
-	}
-
-	if (name !== 'index') {
-		args._.shift();
-	}
-
-	var command = this.commands[name] || null;
-	var options = this.commandOptions[name] || {};
-
-	var req = {
-		command: command,
-		options: options,
-		context: {},
-		argv: argv,
-		args: args,
-		name: name
-	};
-
-	var middleware = [].slice.call(this.middleware);
-	middleware.push(exec);
-
-	each(middleware, function (fn, i, next) {
-		setImmediate(function () {
-			fn.call(self, req, next);
-		});
-	}, function (err) {
-		if (err) {
-			self.emit('error', err);
-		}
-	});
-};
-
-
-/**
- * Middleware
- */
-
-function exec (req, next) {
-	req.command(req);
-	next();
-}
-
-
-/**
- * Expose module
- */
-
-module.exports = Sushi;