commander - npm Package Compare versions

Comparing version 4.0.0-1 to 4.0.0

CHANGELOG.md

@@ -10,15 +10,11 @@ # Changelog
 
-## [4.0.0-1] Prerelease (2019-10-08)
+## [4.0.0] (2019-11-02)
 
 ### Added
 
-* support for declaring required options with `.requiredOptions()` ([#1071])
-
-## [4.0.0-0] Prerelease (2019-10-01)
-
-### Added
-
 * automatically wrap and indent help descriptions for options and commands ([#1051])
 * `.exitOverride()` allows override of calls to `process.exit` for additional error handling and to keep program running ([#1040])
-* dev: work in progress GitHub Actions support ([#1027])
+* support for declaring required options with `.requiredOptions()` ([#1071])
+* GitHub Actions support ([#1027])
+* translation links in README
 
@@ -29,3 +25,3 @@ ### Changed
 * call default subcommand even when there are unknown options ([#1047])
-* *Breaking* Commander is only officially supported on Node 8 and above ([#1053])
+* *Breaking* Commander is only officially supported on Node 8 and above, and requires Node 6 ([#1053])
 
@@ -39,3 +35,12 @@ ### Fixed
 * removed deprecated `customFds` option from call to `child_process.spawn` ([#1052])
+* rework TypeScript declarations to bring all types into imported namespace ([#1081])
 
+## [4.0.0-1] Prerelease (2019-10-08)
+
+(Released in 4.0.0)
+
+## [4.0.0-0] Prerelease (2019-10-01)
+
+(Released in 4.0.0)
+
 ## [2.20.1] (2019-09-29)
@@ -77,3 +82,3 @@
 
-## 3.0.0 / 2019-08-08
+## [3.0.0] / 2019-08-08
 
@@ -504,4 +509,6 @@ * Add option to specify executable file name ([#999])
 [#1071]: https://github.com/tj/commander.js/pull/1071
+[#1081]: https://github.com/tj/commander.js/pull/1081
 
 [Unreleased]: https://github.com/tj/commander.js/compare/master...develop
+[4.0.0]: https://github.com/tj/commander.js/compare/v3.0.2..v4.0.0
 [4.0.0-1]: https://github.com/tj/commander.js/compare/v4.0.0-0..v4.0.0-1
@@ -511,2 +518,3 @@ [4.0.0-0]: https://github.com/tj/commander.js/compare/v3.0.2...v4.0.0-0
 [3.0.1]: https://github.com/tj/commander.js/compare/v3.0.0...v3.0.1
+[3.0.0]: https://github.com/tj/commander.js/compare/v2.20.1...v3.0.0
 [2.20.1]: https://github.com/tj/commander.js/compare/v2.20.0...v2.20.1

package.json

 {
   "name": "commander",
-  "version": "4.0.0-1",
+  "version": "4.0.0",
   "description": "the complete solution for node.js command-line programs",
@@ -38,3 +38,6 @@ "keywords": [
   },
-  "typings": "typings/index.d.ts"
+  "typings": "typings/index.d.ts",
+  "engines": {
+    "node": ">= 6"
+  }
 }

Readme.md

@@ -10,2 +10,4 @@ # Commander.js
 
+Read this in other languages: English | [简体中文](./Readme_zh-CN.md)
+
 - [Commander.js](#commanderjs)
@@ -40,2 +42,3 @@ - [Installation](#installation)
   - [Support](#support)
+    - [Commander for enterprise](#commander-for-enterprise)
 
@@ -654,4 +657,6 @@ ## Installation
 
-[Professionally supported commander is now available](https://tidelift.com/subscription/pkg/npm-commander?utm_source=npm-commander&utm_medium=referral&utm_campaign=readme)
+### Commander for enterprise
 
-Tidelift gives software development teams a single source for purchasing and maintaining their software, with professional grade assurances from the experts who know it best, while seamlessly integrating with existing tools.
+Available as part of the Tidelift Subscription
+
+The maintainers of Commander and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-commander?utm_source=npm-commander&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)

typings/index.d.ts

@@ -8,5 +8,5 @@ // Type definitions for commander 2.11
 
-declare namespace local {
+declare namespace commander {
 
-  class CommanderError extends Error {
+  interface CommanderError extends Error {
     code: string;
@@ -16,7 +16,6 @@ exitCode: number;
     nestedError?: string;
-
-    constructor(exitCode: number, code: string, message: string);
   }
+  type CommanderErrorConstructor = { new (exitCode: number, code: string, message: string): CommanderError };
 
-  class Option {
+  interface Option {
     flags: string;
@@ -30,13 +29,6 @@ required: boolean; // A value must be supplied when the option is specified.
     description: string;
-
-    /**
-     * Initialize a new `Option` with the given `flags` and `description`.
-     *
-     * @param {string} flags
-     * @param {string} [description]
-     */
-    constructor(flags: string, description?: string);
   }
+  type OptionConstructor = { new (flags: string, description?: string): Option };
 
-  class Command extends NodeJS.EventEmitter {
+  interface Command extends NodeJS.EventEmitter {
     [key: string]: any; // options as properties
@@ -47,9 +39,2 @@
     /**
-     * Initialize a new `Command`.
-     *
-     * @param {string} [name]
-     */
-    constructor(name?: string);
-
-    /**
      * Set the program version to `str`. 
@@ -85,3 +70,3 @@ *
      */
-    command(nameAndArgs: string, opts?: commander.CommandOptions): Command;
+    command(nameAndArgs: string, opts?: CommandOptions): Command;
     /**
@@ -299,11 +284,5 @@ * Define a command, implemented in a separate executable file.
   }
+  type CommandConstructor = { new (name?: string): Command };
 
-}
 
-declare namespace commander {
-
-    type Command = local.Command
-
-    type Option = local.Option
-
     interface CommandOptions {
@@ -321,7 +300,5 @@ noHelp?: boolean;
     interface CommanderStatic extends Command {
-        Command: typeof local.Command;
-        Option: typeof local.Option;
-        CommandOptions: CommandOptions;
-        ParseOptionsResult: ParseOptionsResult;
-        CommanderError : typeof local.CommanderError;
+        Command: CommandConstructor;
+        Option: OptionConstructor;
+        CommanderError:CommanderErrorConstructor;
       }
@@ -328,0 +305,0 @@

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

89230

increased by0.38%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

660

increased by0.76%

Worsened metrics

Lines of code

1607

decreased by-1.05%

No dependency changes