commands - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

lib/commands.js

@@ -140,3 +140,3 @@ /**
    Commands.toCamelCase = function(input) {
-      return input.toLowerCase().replace(/[^a-z0-9]+(.)/, function(all, camelLetter) {
+      return input.toLowerCase().replace(/[^a-z0-9]+(.)/g, function(all, camelLetter) {
          return camelLetter.toUpperCase();
@@ -143,0 +143,0 @@ });

package.json

 {
    "name":              "commands",
    "description":       "Command line arguments reader",
-   "version":           "0.0.2",
+   "version":           "0.0.3",
    "author":            "Steve King <[e-mail]>",
@@ -6,0 +6,0 @@ "contributors":      [ { "name": "Steve King", "email": "[e-mail]" } ],

README.md

@@ -1,4 +0,54 @@
-commands.js
-===========
+Overview
+========
 
-Command line arguments processor for node.js
+Simplify access to command line arguments in node apps, and query string or hash parsing in the browser environment.
+
+Installation
+============
+
+If using in node, installation via npm is as simple as `npm install commands.js` or just clone this repo and include the `lib/commands.js` script.
+
+When using in the browser, include the `libs/commands.js` script using `<script src="/path/to/commands.js"></script>`
+
+API
+===
+
+`Commands.get( key [, defaultValue] )` get the value of a named argument, or when that argument wasn't supplied get the supplied default value.
+
+`Commands.exists( key )` get a boolean flag for whether a named argument was supplied
+
+
+Usage - node.js
+===============
+
+Include Commands with require, then read command line arguments in camel case:
+
+    var Commands = require('commands.js');
+    console.log( Commands.get('someArg') );  // outputs "foo"
+    console.log( Commands.get('someUnknownArg', 'defaultValue') );  // outputs "defaultValue"
+    console.log( Commands.exists('someUnknownArg') );  // outputs false
+    console.log( Commands.get('bar') );  // outputs true
+    console.log( Commands.get('baz') );   // outputs false
+    
+    > node script.js -some-arg "foo" --bar --no-baz
+
+Command line arguments can be sent either with a hyphen prefix for naming an argument where the next argument is the value of that argument (in this case "-some-arg" is converted to "someArg" and has the value "foo"). A double hyphen prefix is used to denote a flag, so here bar is true and baz is false because "--no-" is used as flag negation.
+
+Usage - browser
+===============
+
+Including Commands as a script tag then makes available a global variable called "commands" that has the same API as in node however the data source is the query string and hash segments of the URL. Unlike in the node environment, evaluation of the arguments takes place every time they are queried to allow for changes in the hash of the page.
+
+    console.log( commands.get('someArg') );  // outputs "foo"
+    console.log( commands.get('someUnknownArg', 'defaultValue') );  // outputs "defaultValue"
+    console.log( commands.exists('someUnknownArg') );  // outputs false
+    console.log( commands.get('bar') );  // outputs true
+    console.log( commands.get('baz') );   // outputs false
+    
+    location.href = 'somepage.html?someArg=foo&--bar&#--no-baz'
+
+Here both the query string and hash are being used although it can be either or neither, if there are entities in the URL that are being used as options (ie: prefixed with a double hyphen) then they will still need a trailing ampersand to make the URL conform to the W3C spec.
+
+
+    
+    

test/test.js

 
 var c = require('../lib/commands');
 
-c.get('foo');
+console.log(c.get('foo'));
+console.log(c.get('foo', 'bar'));
 
 console.log(c._args);

No alert changes

Improved metrics

Total package byte prevSize

7738

51.76%

Lines of code

135

0.75%

Number of lines in readme file

55

1275%

No dependency changes