@commander-js/extra-typings - npm Package Compare versions

Comparing version 0.3.0 to 9.4.0

index.d.ts

@@ -439,3 +439,3 @@
     args: string[];
-    processedArgs: any[];
+    processedArgs: Args;
     commands: CommandUnknownOpts[];
@@ -520,3 +520,3 @@ parent: CommandUnknownOpts | null;
      */
-    createArgument(name: string, description?: string): Argument;
+    createArgument<Usage extends string>(name: Usage, description?: string): Argument<Usage>;
   
@@ -741,3 +741,3 @@ /**
   
-    createOption(flags: string, description?: string): Option;
+    createOption<Usage extends string>(flags: Usage, description?: string): Option<Usage>;
   
@@ -1062,6 +1062,6 @@ /**
   export function createCommand(name?: string): Command;
-  export function createOption(flags: string, description?: string): Option;
-  export function createArgument(name: string, description?: string): Argument;
+  export function createOption<Usage extends string>(flags: Usage, description?: string): Option<Usage>;
+  export function createArgument<Usage extends string>(name: Usage, description?: string): Argument<Usage>;
   
   export const program: Command;
   

package.json

 {
   "name": "@commander-js/extra-typings",
-  "version": "0.3.0",
+  "version": "9.4.0",
   "description": "Infer strong typings for commander options and action handlers",
@@ -39,5 +39,6 @@ "main": "index.js",
   "peerDependencies": {
-    "commander": "9.x"
+    "commander": "9.4.x"
   },
   "devDependencies": {
+    "@types/node": "^18.7.16",
     "tsd": "^0.22.0",
@@ -44,0 +45,0 @@ "typescript": "^4.7.4"

README.md

 # extra-typings for commander
 
+[![NPM Version](http://img.shields.io/npm/v/@commander-js/extra-typings.svg?style=flat)](https://www.npmjs.org/package/@commander-js/extra-typings)
+[![NPM Downloads](https://img.shields.io/npm/dm/@commander-js/extra-typings.svg?style=flat)](https://npmcharts.com/compare/@commander-js/extra-typings?minimal=true)
+
 This package offers experimental TypeScript typings for `commander` which infer strong types for:
@@ -8,7 +11,4 @@
 
-Limitations
+The runtime is supplied by commander. This package is all about the typings.
 
-- subclassing is not directly supported for `Command`, `Argument`, or `Option`
-- the generics lead to some noisy types visible in editor and errors
-
 Usage
@@ -20,6 +20,14 @@
 
-The runtime is supplied by commander. This package is all about the typings.
+The installed version of this package should match the major and minor version numbers of the installed commander package, but the patch version number is independent (following pattern used by [Definitely Typed](https://github.com/DefinitelyTyped/DefinitelyTyped#how-do-definitely-typed-package-versions-relate-to-versions-of-the-corresponding-library)).
 
 Credit: this builds on work by @PaperStrike in <https://github.com/tj/commander.js/pull/1758>
 
+## Limitations
+
+- the generics lead to some noisy types visible in editor and errors
+- some minor code changes required for subclasses of `Command`, `Argument`, or `Option` (see [subclass.test-d.ts](./tests/subclass.test-d.ts))
+  - chaining methods which do type inference return base class rather than `this`
+  - subclass of `Command` returns base class not subclass from `.command(name)`
+  - type parameter needed for class declaration of subclass of `Option` and `Argument`
+
 ## Usage tips
@@ -59,2 +67,1 @@
 ```
-

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

44561

increased by2.6%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

65

increased by12.07%

Worsened metrics

Dev dependency count

3

increased by50%

No dependency changes