Comparing version 0.2.0 to 0.2.1
{ | ||
"name": "rejoinder", | ||
"version": "0.2.0", | ||
"version": "0.2.1", | ||
"description": "A generator of smart, pretty, and organized output for Node/JS scripts in the terminal", | ||
@@ -5,0 +5,0 @@ "repository": { |
@@ -12,3 +12,4 @@ [![npm version](https://badge.fury.io/js/rejoinder.svg)](https://badge.fury.io/js/rejoinder) | ||
for executing shell commands. It leverages colors and the like using the [colors package](https://www.npmjs.com/package/colors) | ||
and makes life easier when executing CLI instructions with [shelljs](https://www.npmjs.com/package/shelljs). | ||
and makes life easier when executing CLI instructions with [shelljs](https://www.npmjs.com/package/shelljs). ShellJS and | ||
any CLI extensions are not required, however! Check out `lib/Echo/EmitStrategy` if you're curious :) | ||
@@ -33,19 +34,33 @@ Super awesome when paired with [inquirer](https://www.npmjs.com/package/inquirer) and/or [commander](https://www.npmjs.com/package/commander)! | ||
## Usage | ||
## Usage and Examples | ||
```javascript | ||
var echo = require('rejoinder').echo; | ||
echo.now('output this very important warning to the console with pretty colors'.formatAsWarning()); | ||
echo.beVerbose = true; | ||
echo.ifVerbose('Some debug message'); | ||
echo('some other message'.formatAsWarning()); | ||
``` | ||
echo.ifVerbose('Some debug message will appear'); | ||
echo.beVerbose = false; | ||
echo.ifVerbose('Some debug message will not appear!'); | ||
## Examples (run it and see it) | ||
echo.if(somethingistrue, 'I spit only the truth!'.formatAsSuccess()); | ||
Checkout the `examples/` folder for code and interface examples. | ||
echo.now('all', 'my', 'methods', 'are', 'also', 'variadic!'); | ||
echo.if(true, 'even', 'this', 'one :)'); | ||
```shell | ||
node examples/pizza.js | ||
node examples/runner.js | ||
# etc... | ||
echo.separator = '-'; | ||
echo.now('changed', 'the', 'game!'); | ||
echo.separator = ' '; | ||
echo.prefix = 'Big:Boy:Time:'; | ||
echo.usingPredicate(function(str){ return `"${str}"`; }, 'the', 'time', 'for', 'fun and games is', 'over!'); | ||
echo.withPrefix('~>', function() | ||
{ | ||
echo.now('or'); | ||
echo.now('is', 'it? I wonder.'); | ||
echo.withPostfix('NO', 'Wait!'); | ||
echo.withPostfix.action("Don't make me bring Execute into this..."); | ||
}); | ||
``` | ||
@@ -67,3 +82,3 @@ | ||
* 0.2.0 Initial working release, unit tested | ||
* 0.1.x Rapid Iteration) | ||
* 0.2.0 Initial working release; unit tested; semver versioning semantics are obeyed from this point forward | ||
* 0.1.x Rapid iteration |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
45160
82
0
14