Proper command design

README.md

@@ -41,29 +41,31 @@ police flatiron/plates
 police -l ~/octonode
 police -l ~/octonode/package.json
 
-# To continue checking even though errors are encountered
+# To continue checking even though errors are encountered (Doesnt work with -l)
 police -f
 police -u flatiron -f
 
-# To edit and update missing keywords in package.json
-police -k
-police octonode -k
-police -u flatiron -k
-police flatiron/plates -k
+# To edit all the fields in package.json (Doesnt work with -l)
+police -e
 
-# To edit and update dependencies in package.json
-police -p
-police octonode -p
-police -u flatiron -p
-police flatiron/plates -p
-police -l ~/octonode -p
+# To add the missing fields to package.json (Doesnt work with -l)
+police -a
+
+# To update dependencies in package.json
+police -t
+```
+
+Given below are some ideal commands to help you.
+
+```sh
+# An ideal police command for github user for the first time on a module
+police -f -e -t
 
 # An ideal police command for github user
-police -f -k -p
-police -u flatiron -f -k -p
+police -f -a -t
 
 # An ideal police command locally
-police -l ~/octonode -p
+police -l ~/octonode -t
 ```
 
 The token which we acquied during auth will be stored in `$HOME/.policeconf`. If you want to use another config file

lib/police.js

@@ -78,17 +78,24 @@ police.start = function (argv, callback) {
     }
 
     /*
-     * Set keywords parameter
+     * Set add parameter
      */
-    if (argv.keywords || argv.k) {
-      police.keywords = true;
+    if (argv.add || argv.a) {
+      police.add = true;
     }
 
     /*
-     * Set packages parameter
+     * Set edit parameter
      */
-    if (argv.packages || argv.p) {
-      police.packages = true;
+    if (argv.edit || argv.e) {
+      police.edit = true;
+    }
+
+    /*
+     * Set update parameter
+     */
+    if (argv.update || argv.t) {
+      police.update = true;
     }
 
     /*

lib/police/ask.js

@@ -14,12 +14,12 @@ var path = require('path')
   , police = require('../police');
 
 /*
- * Properties of keywords
+ * Properties of fields
  */
 var prop = [];
 
 /*
- * Github data for keywords
+ * Github data for fields
  */
 var gh = {};
 
@@ -48,14 +48,14 @@ ask.properties = function (pkg, gh) {
 }
 
 /*
- * The main function which asks keywords and writes them
+ * The main function which asks fields and writes them
  */
-ask.keywords = function (pkg, fields, callback) {
+ask.fields = function (pkg, fields, callback) {
   ask.release(function () {
     if (!pkg.dependencies) pkg.dependencies = {};
     if (!pkg.devDependencies) pkg.devDependencies = {};
 
-    if (!pkg.name) {
+    if (!pkg.name || police.edit) {
       prop.push({
         message: 'Module name',
         name: 'name',
@@ -66,7 +66,7 @@ ask.keywords = function (pkg, fields, callback) {
       });
     }
 
-    if (!pkg.version) {
+    if (!pkg.version || police.edit) {
       prop.push({
         message: 'Module version',
         name: 'version',

lib/police/check.js

@@ -65,8 +65,8 @@ check.suggest = function (pkg, callback) {
   } else {
     police.winston.info('  ✗'.red.bold + ' Suggest adding ' + suggestions.join(', '));
   }
-  if (police.keywords) {
-    police.ask.keywords(pkg, fields, callback);
+  if (police.add || police.edit) {
+    police.ask.fields(pkg, fields, callback);
   } else {
     callback();
   }

lib/police/github.js

@@ -85,7 +85,7 @@ github.singleModule = function (name, callback) {
             police.winston.info('  Getting package.json blob ' + blob[0].sha.substr(0,10).magenta);
             github.blob(name, blob[0].sha, function (body) {
               var pkg = JSON.parse(new Buffer(body.content, 'base64').toString('utf8'));
-              if (police.keywords) {
+              if (police.add || police.edit) {
                 var sname = name.split('/');
                 police.ask.properties(pkg, {name: name, repo: sname[1], user: sname[0]});
               }

lib/police/help.js

@@ -55,10 +55,13 @@ help.usage = [
   '',
 
   '  --force, -f          Continue running even if errors are encountered',
-  '  --keywords, -k       Edit & update keywords in package.json',
-  '  --packages, -p       Edit & update packages in package.json ',
+  '  --edit, -e           Edit all the fields in package.json',
+  '  --add, -a            Add missing fields to package.json',
+  '  --update, -t         Update packages in package.json ',
+  '',
   '  --destroy, -d        Destroys exisiting authentication',
   '  --conf [FILE]        Sets the configuraiton file to be used',
+  '',
   '  --version, -v        Displays version',
   '  --help, -h           Displays help and usage',
   ''