project-name-generator - npm Package Compare versions

Comparing version 2.1.3 to 2.1.4

package.json

 {
   "name": "project-name-generator",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "Generate a random, unique, heroku-like name for your app/project/server etc. e.g. \"resonant-silence\"",
   "main": "src/generator.js",
   "scripts": {
-    "test": "./node_modules/mocha/bin/mocha **/*.spec.js"
+    "test": "mocha spec/**/*.spec.js"
   },
@@ -32,3 +32,4 @@ "repository": {
   "dependencies": {
-    "lodash": "^4.14.2"
+    "commander": "^2.11.0",
+    "lodash": "^4.17.4"
   },
@@ -35,0 +36,0 @@ "bin": {

README.md

@@ -7,6 +7,6 @@ # Project Name Generator
 
-##Install
+## Install
 `npm install project-name-generator --save`
 
-##Quick Start
+## Quick Start
 ```javascript
@@ -31,3 +31,32 @@ var generate = require('project-name-generator');
 
-##API
+## Quickstart CLI
+This package contains a cli script.  You can pull in the package globally using npm
+`npm install -g project-name-generator`
+
+Call from your command line
+```
+project-name-generator
+{ raw: [ 'spry', 'bath' ],
+  dashed: 'spry-bath',
+  spaced: 'spry bath' }
+```
+
+For CLI options 
+```
+project-name-generator -h
+
+Usage: project-name-generator [options]
+
+
+Options:
+
+  -V, --version          output the version number
+  -w, --words [num]      number of words [2]
+  -n, --numbers          use numbers
+  -a, --alliterative     use alliterative
+  -o, --output [output]  output type [raw|dashed|spaced]
+  -h, --help             output usage information
+```
+
+## API
 The module returns single method `generate(options)`
@@ -77,3 +106,3 @@
 
-##Tests
+## Tests
 To run tests locally:
@@ -86,5 +115,7 @@ ```
 
-The library has been tested with Node.js 4.2.6
+The library has been tested with Node.js 6.11.0
 
-##Build Status
-![Build status](https://codeship.com/projects/c049a9a0-7fa1-0132-a98e-66b1976afe6a/status?branch=master)
+## Status
+[ ![Build Status for aceakash/project-name-generator](https://codeship.com/projects/261b5340-4472-0134-6925-4ed1b3e90ffc/status?branch=master)](https://codeship.com/projects/168462)
+
+![How up-to-date are dependencies?](https://david-dm.org/aceakash/project-name-generator.svg)

src/generator-bin.js

@@ -1,56 +0,24 @@
-#! /usr/bin/env node
+#!/usr/bin/env node
 
-var generate = require('project-name-generator');
+const generate = require('./generator')
+const program = require('commander')
 
-main(process.argv.slice(2));
+program
+    .version('1.0.0')
+    .option('-w, --words [num]', 'number of words [2]', 2)
+    .option('-n, --numbers', 'use numbers')
+    .option('-a, --alliterative', 'use alliterative')
+    .option('-o, --output [output]', 'output type [raw|dashed|spaced]', /^(raw|dashed|spaced)$/i)
+    .parse(process.argv)
 
-function main(args){
-	var words = 2;
-	var number = false;
-	var dashed = false;
-	var raw = false;
-	var spaced = false;
-  var alliterative = false;
-	for (x=0; x<args.length; x++){
-		switch(args[x]){
-			case "-w":
-			case "--word":
-			case "--words":
-				words = parseInt(args[++x])
-				break;
-			case "-n":
-			case "--number":
-			case "--numbers":
-				number = true;
-				break;
-			case "-d":
-			case "--dashed":
-				dashed = true;
-				break;
-			case "-r":
-			case "--raw":
-				raw = true;
-				break;
-			case "-s":
-			case "--spaced":
-				spaced = true;
-				break;
-      case "-a":
-      case "--alliterative":
-        alliterative = true;
-        break;
-		}
-	}
+let project_name = generate({words: program.words, number: program.numbers, alliterative: program.alliterative});
 
-	var project_name = generate({words: words, number: number, alliterative: alliterative});
-
-	if (dashed){
-		console.log(project_name.dashed);
-	} else if (raw) {
-		console.log(project_name.raw);
-	} else if (spaced) {
-		console.log(project_name.spaced);
-	} else {
-		console.log(project_name);
-	}
-}
+if (program.output == "dashed"){
+    console.log(project_name.dashed);
+} else if (program.output == "raw") {
+    console.log(project_name.raw);
+} else if (program.output == "spaced") {
+    console.log(project_name.spaced);
+} else {
+    console.log(project_name);
+}

src/generator.js

@@ -1,4 +0,4 @@
-var _ = require('lodash'),
-  nouns = require('../src/nouns'),
-  adjectives = require('../src/adjectives');
+const _ = require('lodash');
+const nouns = require('./nouns');
+const adjectives = require('./adjectives');
 
@@ -5,0 +5,0 @@

No alert changes

Improved metrics

Total package byte prevSize

39818

increased by1.47%

Number of lines in readme file

118

increased by35.63%

Worsened metrics

Dependency count

2

increased by100%

Lines of code

2401

decreased by-1.32%

Dependency changes

• + Addedcommander@^2.11.0

• + Addedcommander@2.20.3(transitive)

• Updatedlodash@^4.17.4