rejoinder - npm Package Compare versions

Comparing version 0.1.2 to 0.2.0

package.json

 {
   "name": "rejoinder",
-  "version": "0.1.2",
-  "description": "A generator of smart, pretty, and organized output for Node/JS scripts, replacing console.*",
+  "version": "0.2.0",
+  "description": "A generator of smart, pretty, and organized output for Node/JS scripts in the terminal",
   "repository": {
@@ -9,12 +9,9 @@ "type": "git",
   },
-  "main": "rejoinder.js",
+  "main": "lib/rejoinder.js",
   "author": "Xunnamius",
   "license": "ISC",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "./node_modules/.bin/mocha --harmony --recursive --reporter spec ./tests",
+    "docs": "documentation -f md -o API.md"
   },
-  "dependencies": {
-    "colors": "^1.1.2",
-    "shelljs": "^0.3.0"
-  },
   "keywords": [
@@ -30,3 +27,13 @@ "echo",
     "verbose"
-  ]
+  ],
+  "optionalDependencies": {
+    "shelljs": "^0.3.0",
+    "colors": "^1.1.2"
+  },
+  "devDependencies": {
+    "chai": "^3.4.1",
+    "mocha": "^2.3.4",
+    "sinon": "^1.17.2"
+  },
+  "engines" : { "node" : "^5" }
 }

README.md

@@ -10,5 +10,5 @@ [![npm version](https://badge.fury.io/js/rejoinder.svg)](https://badge.fury.io/js/rejoinder)
 
-Rejoinder is a generator of smart, pretty, and organized output for Node/JS scripts, replacing several of the console.* utilities.
-It leverages colors and the like using the [colors package](https://www.npmjs.com/package/colors). Makes life easier when executing CLI instructions
-with [shelljs](https://www.npmjs.com/package/shelljs) using specialized methods.
+Rejoinder is a generator of smart, pretty, and organized output on the console for Node/JS scripts, with optimizations
+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).
 
@@ -19,5 +19,5 @@ Super awesome when paired with [inquirer](https://www.npmjs.com/package/inquirer) and/or [commander](https://www.npmjs.com/package/commander)!
 
-## Documentation
+**Note that rejoinder requires Node.js version 5.x and, until rest parameters are shipped by default, use of [the --harmony flag](https://nodejs.org/en/docs/es6/#which-features-are-behind-the-es_staging-flag)!**
 
-### Installation
+## Installation
 
@@ -28,9 +28,18 @@ ```shell
 
+If you want support from shelljs (required to use `Execute`), install that too:
+
+```shell
+npm install shelljs
+```
+
+## Usage
+
 ```javascript
-var echo = require("rejoinder");
-echo.ifDebug('Some debug message');
-echo('some other message'.formatAsError());
+var echo = require('rejoinder').echo;
+echo.beVerbose = true;
+echo.ifVerbose('Some debug message');
+echo('some other message'.formatAsWarning());
 ```
 
-### Examples (run it and see it)
+## Examples (run it and see it)
 
@@ -45,3 +54,17 @@ Checkout the `examples/` folder for code and interface examples.
 
-### Methods
-(coming soon)
+## Documentation
+See [API.md](API.md)
+
+## Tests
+
+  npm test
+
+## Contributing
+
+In lieu of a formal styleguide, take care to maintain the existing coding style.
+Add unit tests for any new or changed functionality. Lint and test your code.
+
+## Release History
+
+* 0.2.0 Initial working release, unit tested
+* 0.1.x Rapid Iteration)

New alerts

Major refactor

Supply chain risk

Package 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

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

44388

increased by1799.36%

Number of package files

17

increased by142.86%

Lines of code

980

increased by16233.33%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

67

increased by52.27%

Worsened metrics

Dev dependency count

3

increased byInfinity%

Dependency changes

• - Removedcolors@^1.1.2

• - Removedshelljs@^0.3.0