commander 2.19.0 → 2.20.0

package/CHANGELOG.md

@@ -1,4 +1,16 @@
 
+2.20.0 / 2019-04-02
+==================
+
+  * fix: resolve symbolic links completely when hunting for subcommands (#935)
+  * Update index.d.ts (#930)
+  * Update Readme.md (#924)
+  * Remove --save option as it isn't required anymore (#918)
+  * Add link to the license file (#900)
+  * Added example of receiving args from options (#858)
+  * Added missing semicolon (#882)
+  * Add extension to .eslintrc (#876)
+
 2.19.0 / 2018-10-02
 ==================
 

package/Readme.md

@@ -13,7 +13,7 @@
 
 ## Installation
 
-    $ npm install commander --save
+    $ npm install commander
 
 ## Option parsing
 
@@ -65,6 +65,17 @@ if (program.sauce) console.log('  with sauce');
 else console.log(' without sauce');
 ```
 
+To get string arguments from options you will need to use angle brackets <> for required inputs or square brackets [] for optional inputs. 
+
+e.g. ```.option('-m --myarg [myVar]', 'my super cool description')```
+
+Then to access the input if it was passed in.
+
+e.g. ```var myInput = program.myarg```
+
+**NOTE**: If you pass a argument without using brackets the example above will return true and not the value passed in.
+
+
 ## Version option
 
 Calling the `version` implicitly adds the `-V` and `--version` options to the command.
@@ -414,4 +425,4 @@ More Demos can be found in the [examples](https://github.com/tj/commander.js/tre
 
 ## License
 
-MIT
+[MIT](https://github.com/tj/commander.js/blob/master/LICENSE)

package/index.js

@@ -527,14 +527,11 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
 
   // In case of globally installed, get the base dir where executable
   //  subcommand file should be located at
-  var baseDir,
-    link = fs.lstatSync(f).isSymbolicLink() ? fs.readlinkSync(f) : f;
+  var baseDir;
 
-  // when symbolink is relative path
-  if (link !== f && link.charAt(0) !== '/') {
-    link = path.join(dirname(f), link);
-  }
-  baseDir = dirname(link);
+  var resolvedLink = fs.realpathSync(f);
+
+  baseDir = dirname(resolvedLink);
 
   // prefer local `./<bin>` to bin in the $PATH
   var localBin = path.join(baseDir, bin);
@@ -664,7 +661,7 @@ Command.prototype.parseArgs = function(args, unknown) {
       this.unknownOption(unknown[0]);
     }
     if (this.commands.length === 0 &&
-        this._args.filter(function(a) { return a.required }).length === 0) {
+        this._args.filter(function(a) { return a.required; }).length === 0) {
       this.emit('command:*');
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commander",
-  "version": "2.19.0",
+  "version": "2.20.0",
   "description": "the complete solution for node.js command-line programs",
   "keywords": [
     "commander",

package/typings/index.d.ts

@@ -226,9 +226,10 @@ declare namespace local {
      * Set the description to `str`.
      *
      * @param {string} str
+     * @param {{[argName: string]: string}} argsDescription
      * @return {(Command | string)}
      */
-    description(str: string): Command;
+    description(str: string, argsDescription?: {[argName: string]: string}): Command;
     description(): string;
 
     /**