capitano - npm Package Compare versions

Comparing version 1.4.0 to 1.5.0

build/capitano.js

@@ -17,2 +17,4 @@ var Command, Option, Signature, _;
 
+exports.utils = require('./utils');
+
 exports.command = function(options) {
@@ -19,0 +21,0 @@ var command;

package.json

 {
   "name": "capitano",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Powerful, non opitionated command line parser for serious applications",
@@ -5,0 +5,0 @@ "main": "build/capitano.js",

README.md

@@ -209,2 +209,21 @@ Capitano
 
+## capitano.utils
+
+A collection of handy utilities for working with Capitano.
+
+### capitano.utils.getStdin(callback)
+
+Read from stdin. This function is used when you specify a stdin parameter, such as `<|foo>`.
+
+You'll most often use the stdin parameter syntax, but this function is publicly available in case you need more control.
+
+Example:
+
+```coffee
+capitano = require('capitano')
+
+capitano.utils.getStdin (data) ->
+	console.log("We got #{data} from stdin")
+```
+
 Classes
@@ -400,2 +419,6 @@ -------
 
+### 1.5.0
+
+- Expose internal utils object as `capitano.utils`.
+
 ### 1.4.0
@@ -402,0 +425,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

131661

increased by0.46%

Lines of code

722

increased by0.14%

Number of lines in readme file

491

increased by4.91%

No dependency changes