Change async command example to use CLI.done()

Author: Ronen Babayoff

README.md

@@ -79,9 +79,8 @@ Here is an example async [ls](https://github.com/practicalmeteor/meteor-mcli/blo
 var child_process = Npm.require('child_process');
 
 // When you register your command as an async one,
-// your command will be called with a done function as a 2nd argument
-// which you need to call when your command has completed.
-var lsCommand = function(options, done) {
+// you need to call CLI.done() when your command has completed.
+var lsCommand = function(options) {
 
   var ls = child_process.spawn("ls");
 
@@ -98,9 +97,8 @@ var lsCommand = function(options, done) {
   // You need to wait on a child process's close event, and not on it's exit event,
   // to make sure it has exited and all it's output has been delivered to you.
   ls.on("close", function(code, signal){
-    // Call done() to let CLI know your command has completed and it can exit.
-    // You can also call CLI.done() instead
-    done();
+    // Calling CLI.done() will let CLI know your command has completed and it can exit.
+    CLI.done();
   });
 };
 

starter-mcli-app/.meteor/versions

@@ -16,7 +16,7 @@ minimongo@1.0.6
 mongo@1.0.11
 ordered-dict@1.0.2
 practicalmeteor:chai@1.9.2_3
-practicalmeteor:loglevel@1.1.0_3
+practicalmeteor:loglevel@1.2.0_1
 practicalmeteor:mcli@1.1.4
 practicalmeteor:underscore.string@2.3.3_3
 random@1.0.2

starter-mcli-app/server/LsCommand.js

@@ -1,11 +1,13 @@
 // Example of an async command that spawns an ls child process,
-// waits for it to exit, and then calls done
+// waits for it to exit, and then calls CLI.done()
 
 var log = loglevel.createLogger('ls', 'debug');
 
 var child_process = Npm.require('child_process');
 
-var lsCommand = function(options, done) {
+// When you register your command as an async one,
+// you need to call CLI.done() when your command has completed.
+var lsCommand = function(options) {
 
   log.debug('spawning ls');
   var ls = child_process.spawn("ls");
@@ -21,11 +23,14 @@ var lsCommand = function(options, done) {
     process.stderr.write(data);
   });
 
+  // You need to wait on a child process's close event, and not on it's exit event,
+  // to make sure it has exited and all it's output has been delivered to you.
   ls.on("close", function(code, signal){
-    // Or, you can call CLI.done() instead
     log.debug('ls closed');
-    done();
+    // Calling CLI.done() will let CLI know your command has completed and it can exit.
+    CLI.done();
   });
 };
 
+// When registering an async command, pass in true as the last argument.
 CLI.registerCommand('ls', lsCommand, {}, true);