commander 7.1.0 → 7.2.0

package/CHANGELOG.md

@@ -8,6 +8,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 <!-- markdownlint-disable MD024 -->
 <!-- markdownlint-disable MD004 -->
 
+## [7.2.0] (2021-03-26)
+
+### Added
+
+- TypeScript typing for `parent` property on `Command` ([#1475])
+- TypeScript typing for `.attributeName()` on `Option` ([#1483])
+- support information in package ([#1477])
+
+### Changed
+
+- improvements to error messages, README, and tests
+- update dependencies
+
 ## [7.1.0] (2021-02-15)
 
 ### Added
@@ -402,10 +415,12 @@ to expand `-fb` to `-f -b` rather than `-f b`.
 [#1453]: https://github.com/tj/commander.js/pull/1453
 [#1454]: https://github.com/tj/commander.js/pull/1454
 [#1464]: https://github.com/tj/commander.js/pull/1464
-
-
+[#1475]: https://github.com/tj/commander.js/pull/1475
+[#1477]: https://github.com/tj/commander.js/pull/1477
+[#1483]: https://github.com/tj/commander.js/pull/1483
 
 [Unreleased]: https://github.com/tj/commander.js/compare/master...develop
+[7.2.0]: https://github.com/tj/commander.js/compare/v7.1.0...v7.2.0
 [7.1.0]: https://github.com/tj/commander.js/compare/v7.0.0...v7.1.0
 [7.0.0]: https://github.com/tj/commander.js/compare/v6.2.1...v7.0.0
 [7.0.0-2]: https://github.com/tj/commander.js/compare/v7.0.0-1...v7.0.0-2

package/Readme.md

@@ -711,7 +711,7 @@ an option for a different purpose in subcommands.
 
 Example file: [positional-options.js](./examples/positional-options.js)
 
-With positional options, the `-b` is a program option in the first line and a subcommand option in the second:
+With positional options, the `-b` is a program option in the first line and a subcommand option in the second line:
 
 ```sh
 program -b subcommand
@@ -725,7 +725,7 @@ To use pass through options in a subcommand, the program needs to enable positio
 
 Example file: [pass-through-options.js](./examples/pass-through-options.js)
 
-With pass through options, the `--port=80` is a program option in the line and passed through as a command-argument in the second:
+With pass through options, the `--port=80` is a program option in the first line and passed through as a command-argument in the second line:
 
 ```sh
 program --port=80 arg

package/index.js

@@ -1172,7 +1172,7 @@ class Command extends EventEmitter {
   passThroughOptions(passThrough = true) {
     this._passThroughOptions = !!passThrough;
     if (!!this.parent && passThrough && !this.parent._enablePositionalOptions) {
-      throw new Error('passThroughOptions can not be used without turning on enablePositionOptions for parent command(s)');
+      throw new Error('passThroughOptions can not be used without turning on enablePositionalOptions for parent command(s)');
     }
     return this;
   };

package/package-support.json

@@ -0,0 +1,16 @@
+{
+  "versions": [
+    {
+      "version": "*",
+      "target": {
+        "node": "supported"
+      },
+      "response": {
+        "type": "time-permitting"
+      },
+      "backing": {
+        "npm-funding": true
+      }
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commander",
-  "version": "7.1.0",
+  "version": "7.2.0",
   "description": "the complete solution for node.js command-line programs",
   "keywords": [
     "commander",
@@ -20,9 +20,9 @@
   },
   "scripts": {
     "lint": "eslint index.js esm.mjs \"tests/**/*.js\"",
-    "typescript-lint": "eslint typings/*.ts",
+    "typescript-lint": "eslint typings/*.ts tests/*.ts",
     "test": "jest && npm run test-typings",
-    "test-esm": "node --experimental-modules ./tests/esm-test.mjs",
+    "test-esm": "node --experimental-modules ./tests/esm-imports-test.mjs",
     "test-typings": "tsd",
     "typescript-checkJS": "tsc --allowJS --checkJS index.js --noEmit",
     "test-all": "npm run test && npm run lint && npm run typescript-lint && npm run typescript-checkJS && npm run test-esm"
@@ -31,7 +31,8 @@
   "files": [
     "index.js",
     "esm.mjs",
-    "typings/index.d.ts"
+    "typings/index.d.ts",
+    "package-support.json"
   ],
   "type": "commonjs",
   "dependencies": {},
@@ -45,14 +46,23 @@
     "eslint-plugin-jest": "^24.1.3",
     "jest": "^26.6.3",
     "standard": "^16.0.3",
+    "ts-jest": "^26.5.1",
     "tsd": "^0.14.0",
     "typescript": "^4.1.2"
   },
   "types": "typings/index.d.ts",
   "jest": {
-    "collectCoverage": true
+    "testEnvironment": "node",
+    "collectCoverage": true,
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+    "testPathIgnorePatterns": [
+      "/node_modules/"
+    ]
   },
   "engines": {
     "node": ">= 10"
-  }
+  },
+  "support": true
 }

package/typings/index.d.ts

@@ -78,6 +78,12 @@ declare namespace commander {
      * Return option name.
      */
     name(): string;
+
+    /**
+     * Return option name, in a camelcase format that can be used
+     * as a object attribute key.
+     */
+    attributeName(): string;
   }
   type OptionConstructor = new (flags: string, description?: string) => Option;
 
@@ -156,8 +162,8 @@ declare namespace commander {
 
   interface Command {
     args: string[];
-
     commands: Command[];
+    parent: Command | null;
 
     /**
      * Set the program version to `str`.