@types/yargs - npm Package Compare versions

Comparing version 8.0.2 to 10.0.0

yargs/index.d.ts

@@ -1,2 +0,2 @@
-// Type definitions for yargs 8.0
+// Type definitions for yargs 10.0
 // Project: https://github.com/chevex/yargs
@@ -7,31 +7,69 @@ // Definitions by: Martin Poelstra <https://github.com/poelstra>
 //                 Jeff Kenney <https://github.com/jeffkenney>
+//                 Jimi (Dimitris) Charalampidis <https://github.com/JimiC>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.2
 
+// The following TSLint rules have been disabled:
 // unified-signatures: Because there is useful information in the argument names of the overloaded signatures
-// prefer-method-signature: Because it makes more sense for optional functions provided in options objects
-/* tslint:disable:unified-signatures prefer-method-signature */
 
+// Convention:
+// Use 'union types' when:
+//  - parameter types have similar signature type (i.e. 'string | string[]')
+//  - parameter names have the same semantic meaning (i.e. ['command', 'commands'] , ['key', 'keys'])
+//    An example for not using 'union types' is the declaration of 'env' where `prefix` and `enable` parameters
+//    have different semantics. On the other hand, in the declaration of 'usage', a `command: string` parameter
+//    has the same semantic meaning with declaring an overload method by using `commands: string[]`, thus
+//    it's prefered to use `command: string | string[]`
+// Use parameterless declaration instead of declaring all parameters optional,
+// when all parameters are optional and more than one
+
 declare namespace yargs {
     interface Argv {
+        (): Arguments;
+        (args: string[], cwd?: string): Arguments;
+
+        alias(shortName: string | string[], longName: string | string[]): Argv;
+        alias(aliases: { [shortName: string]: string | string[] }): Argv;
+
         argv: Arguments;
-        (args?: string[], cwd?: string): Arguments;
-        parse(args: string | string[], context?: object, parseCallback?: ParseCallback): Arguments;
 
-        reset(): Argv;
+        array(key: string | string[]): Argv;
 
-        locale(): string;
-        locale(loc: string): Argv;
+        boolean(key: string | string[]): Argv;
 
-        detectLocale(detect: boolean): Argv;
+        check(func: (argv: Arguments, aliases: { [alias: string]: string }) => any, global?: boolean): Argv;
 
-        terminalWidth(): number;
+        choices(key: string, values: Choices): Argv;
+        choices(choices: { [argName: string]: Choices }): Argv;
 
-        alias(shortName: string, longName: string | string[]): Argv;
-        alias(shortNames: string[], longName: string): Argv;
-        alias(aliases: { [shortName: string]: string | string[] }): Argv;
+        coerce(key: string | string[], func: (arg: any) => any): Argv;
+        coerce(opts: { [key: string]: (arg: any) => any; }): Argv;
 
-        array(key: string): Argv;
-        array(keys: string[]): Argv;
+        command(command: string | string[], description: string, builder?: (args: Argv) => Argv, handler?: (args: Arguments) => void): Argv;
+        command(command: string | string[], description: string, builder?: { [key: string]: Options }, handler?: (args: Arguments) => void): Argv;
+        command(command: string | string[], description: string, module: CommandModule): Argv;
+        command(command: string | string[], showInHelp: false, builder?: (args: Argv) => Argv, handler?: (args: Arguments) => void): Argv;
+        command(command: string | string[], showInHelp: false, builder?: { [key: string]: Options }, handler?: (args: Arguments) => void): Argv;
+        command(command: string | string[], showInHelp: false, module: CommandModule): Argv;
+        command(module: CommandModule): Argv;
 
+        // Advanced API
+        commandDir(dir: string, opts?: RequireDirectoryOptions): Argv;
+
+        completion(): Argv;
+        completion(cmd: string, func?: AsyncCompletionFunction): Argv;
+        completion(cmd: string, func?: SyncCompletionFunction): Argv;
+        completion(cmd: string, description?: string, func?: AsyncCompletionFunction): Argv;
+        completion(cmd: string, description?: string, func?: SyncCompletionFunction): Argv;
+
+        config(): Argv;
+        config(key: string | string[], description?: string, parseFn?: (configPath: string) => object): Argv;
+        config(key: string | string[], parseFn: (configPath: string) => object): Argv;
+        config(explicitConfigurationObject: object): Argv;
+
+        conflicts(key: string, value: string | string[]): Argv;
+        conflicts(conflicts: { [key: string]: string | string[] }): Argv;
+
+        count(key: string | string[]): Argv;
+
         default(key: string, value: any, description?: string): Argv;
@@ -42,97 +80,42 @@ default(defaults: { [key: string]: any }, description?: string): Argv;
          * @deprecated since version 6.6.0
+         * Use '.demandCommand()' or '.demandOption()' instead
          */
-        demand(key: string, msg: string): Argv;
-        demand(key: string, required?: boolean): Argv;
-        demand(keys: string[], msg: string): Argv;
-        demand(keys: string[], required?: boolean): Argv;
+        demand(key: string | string[], msg: string): Argv;
+        demand(key: string | string[], required?: boolean): Argv;
+        demand(positionals: number, msg: string): Argv;
         demand(positionals: number, required?: boolean): Argv;
-        demand(positionals: number, msg: string): Argv;
         demand(positionals: number, max: number, msg?: string): Argv;
 
-        demandCommand(min: number, minMsg?: string): Argv;
-        demandCommand(min: number, max?: number, minMsg?: string, maxMsg?: string): Argv;
-
         demandOption(key: string | string[], msg?: string): Argv;
         demandOption(key: string | string[], demand?: boolean): Argv;
 
-        /**
-         * @deprecated since version 6.6.0
-         */
-        require(key: string, msg: string): Argv;
-        require(key: string, required: boolean): Argv;
-        require(keys: number[], msg: string): Argv;
-        require(keys: number[], required: boolean): Argv;
-        require(positionals: number, required: boolean): Argv;
-        require(positionals: number, msg: string): Argv;
+        demandCommand(): Argv;
+        demandCommand(min: number, minMsg?: string): Argv;
+        demandCommand(min: number, max?: number, minMsg?: string, maxMsg?: string): Argv;
 
-        /**
-         * @deprecated since version 6.6.0
-         */
-        required(key: string, msg: string): Argv;
-        required(key: string, required: boolean): Argv;
-        required(keys: number[], msg: string): Argv;
-        required(keys: number[], required: boolean): Argv;
-        required(positionals: number, required: boolean): Argv;
-        required(positionals: number, msg: string): Argv;
-
-        requiresArg(key: string): Argv;
-        requiresArg(keys: string[]): Argv;
-
         describe(key: string | string[], description: string): Argv;
         describe(descriptions: { [key: string]: string }): Argv;
 
-        option(key: string, options: Options): Argv;
-        option(options: { [key: string]: Options }): Argv;
-        options(key: string, options: Options): Argv;
-        options(options: { [key: string]: Options }): Argv;
+        detectLocale(detect: boolean): Argv;
 
-        usage(message: string, options?: { [key: string]: Options }): Argv;
-        usage(options?: { [key: string]: Options }): Argv;
+        env(): Argv;
+        env(prefix: string): Argv;
+        env(enable: boolean): Argv;
 
-        command(command: string | string[], description: string): Argv;
-        command(command: string | string[], description: string, builder: (args: Argv) => Argv): Argv;
-        command(command: string | string[], description: string, builder: { [optionName: string]: Options }): Argv;
-        command(command: string | string[], description: string, builder: { [optionName: string]: Options }, handler: (args: Arguments) => void): Argv;
-        command(command: string | string[], description: string, builder: (args: Argv) => Argv, handler: (args: Arguments) => void): Argv;
-        command(command: string | string[], description: string, module: CommandModule): Argv;
-        command(module: CommandModule): Argv;
+        epilog(msg: string): Argv;
 
-        commandDir(dir: string, opts?: RequireDirectoryOptions): Argv;
+        epilogue(msg: string): Argv;
 
-        completion(): Argv;
-        completion(cmd: string, fn?: AsyncCompletionFunction): Argv;
-        completion(cmd: string, fn?: SyncCompletionFunction): Argv;
-        completion(cmd: string, description?: string, fn?: AsyncCompletionFunction): Argv;
-        completion(cmd: string, description?: string, fn?: SyncCompletionFunction): Argv;
-
         example(command: string, description: string): Argv;
 
-        check(func: (argv: Arguments, aliases: { [alias: string]: string }) => any, global?: boolean): Argv;
+        exitProcess(enabled: boolean): Argv;
 
-        boolean(key: string): Argv;
-        boolean(keys: string[]): Argv;
+        fail(func: (msg: string, err: Error) => any): Argv;
 
-        string(key: string): Argv;
-        string(keys: string[]): Argv;
+        getCompletion(args: string[], done: (completions: string[]) => void): Argv;
 
-        number(key: string): Argv;
-        number(keys: string[]): Argv;
+        global(key: string | string[]): Argv;
 
-        choices(choices: { [argName: string]: Choices }): Argv;
-        choices(key: string, values: Choices): Argv;
+        group(key: string | string[], groupName: string): Argv;
 
-        config(): Argv;
-        config(explicitConfigurationObject: object): Argv;
-        config(key: string, description?: string, parseFn?: (configPath: string) => object): Argv;
-        config(keys: string[], description?: string, parseFn?: (configPath: string) => object): Argv;
-        config(key: string, parseFn: (configPath: string) => object): Argv;
-        config(keys: string[], parseFn: (configPath: string) => object): Argv;
-
-        conflicts(key: string, value: string): Argv;
-        conflicts(conflicts: { [key: string]: string }): Argv;
-
-        wrap(columns: number): Argv;
-
-        strict(): Argv;
-
         help(): Argv;
@@ -143,55 +126,96 @@ help(enableExplicit: boolean): Argv;
 
-        env(prefix?: string): Argv;
-        env(enable: boolean): Argv;
+        implies(key: string, value: string | string[]): Argv;
+        implies(implies: { [key: string]: string | string[] }): Argv;
 
-        epilog(msg: string): Argv;
-        epilogue(msg: string): Argv;
+        locale(): string;
+        locale(loc: string): Argv;
 
-        version(version?: string, option?: string, description?: string): Argv;
-        version(version: () => string, option?: string, description?: string): Argv;
+        nargs(key: string, count: number): Argv;
+        nargs(nargs: { [key: string]: number }): Argv;
 
-        showHelpOnFail(enable: boolean, message?: string): Argv;
+        normalize(key: string | string[]): Argv;
 
-        showHelp(consoleLevel?: string): Argv;
+        number(key: string | string[]): Argv;
 
-        exitProcess(enabled: boolean): Argv;
+        option(key: string, options: Options): Argv;
+        option(options: { [key: string]: Options }): Argv;
 
-        global(key: string): Argv;
-        global(keys: string[]): Argv;
+        options(key: string, options: Options): Argv;
+        options(options: { [key: string]: Options }): Argv;
 
-        group(key: string, groupName: string): Argv;
-        group(keys: string[], groupName: string): Argv;
+        parse(): Arguments;
+        parse(arg: string | string[], context?: object, parseCallback?: ParseCallback): Arguments;
 
-        nargs(key: string, count: number): Argv;
-        nargs(nargs: { [key: string]: number }): Argv;
+        pkgConf(key: string | string[], cwd?: string): Argv;
 
-        normalize(key: string): Argv;
-        normalize(keys: string[]): Argv;
+        /**
+         * 'positional' should be called in a command's builder function, and is not
+         * available on the top-level yargs instance. If so, it will throw an error.
+         */
+        positional(key: string, opt: PositionalOptions): Argv;
 
-        implies(key: string, value: string): Argv;
-        implies(implies: { [key: string]: string }): Argv;
+        recommendCommands(): Argv;
 
-        count(key: string): Argv;
-        count(keys: string[]): Argv;
+        /**
+         * @deprecated since version 6.6.0
+         * Use '.demandCommand()' or '.demandOption()' instead
+         */
+        require(key: string, msg: string): Argv;
+        require(key: string, required: boolean): Argv;
+        require(keys: number[], msg: string): Argv;
+        require(keys: number[], required: boolean): Argv;
+        require(positionals: number, required: boolean): Argv;
+        require(positionals: number, msg: string): Argv;
 
-        fail(func: (msg: string, err: Error) => any): Argv;
+        /**
+         * @deprecated since version 6.6.0
+         * Use '.demandCommand()' or '.demandOption()' instead
+         */
+        required(key: string, msg: string): Argv;
+        required(key: string, required: boolean): Argv;
+        required(keys: number[], msg: string): Argv;
+        required(keys: number[], required: boolean): Argv;
+        required(positionals: number, required: boolean): Argv;
+        required(positionals: number, msg: string): Argv;
 
-        coerce<T, U>(key: string | string[], func: (arg: T) => U): Argv;
-        coerce<T, U>(opts: { [key: string]: (arg: T) => U; }): Argv;
+        requiresArg(key: string | string[]): Argv;
 
-        getCompletion(args: string[], done: (completions: string[]) => void): Argv;
+        /**
+         * @deprecated since version 6.6.0
+         * Use '.global()' instead
+         */
+        reset(): Argv;
 
-        pkgConf(key: string, cwd?: string): Argv;
-        pkgConf(keys: string[], cwd?: string): Argv;
+        showCompletionScript(): Argv;
 
-        recommendCommands(): Argv;
+        showHelp(consoleLevel?: string): Argv;
 
-        showCompletionScript(): Argv;
+        showHelpOnFail(enable: boolean, message?: string): Argv;
 
-        skipValidation(key: string): Argv;
-        skipValidation(keys: string[]): Argv;
+        skipValidation(key: string | string[]): Argv;
 
+        strict(): Argv;
+
+        string(key: string | string[]): Argv;
+
+        // Intended to be used with '.wrap()'
+        terminalWidth(): number;
+
         updateLocale(obj: { [key: string]: string }): Argv;
 
         updateStrings(obj: { [key: string]: string }): Argv;
+
+        usage(message: string): Argv;
+        usage(command: string | string[], description: string, builder?: (args: Argv) => Argv, handler?: (args: Arguments) => void): Argv;
+        usage(command: string | string[], showInHelp: boolean, builder?: (args: Argv) => Argv, handler?: (args: Arguments) => void): Argv;
+        usage(command: string | string[], description: string, builder?: { [key: string]: Options }, handler?: (args: Arguments) => void): Argv;
+        usage(commands: string | string[], showInHelp: boolean, builder?: { [key: string]: Options }, handler?: (args: Arguments) => void): Argv;
+
+        version(): Argv;
+        version(version: string): Argv;
+        version(enable: boolean): Argv;
+        version(optionKey: string, version: string): Argv;
+        version(optionKey: string, description: string, version: string): Argv;
+
+        wrap(columns: number): Argv;
     }
@@ -204,5 +228,4 @@
         $0: string;
-
         /** All remaining options */
-        [ argName: string ]: any;
+        [argName: string]: any;
     }
@@ -226,7 +249,10 @@
         configParser?: (configPath: string) => object;
-        conflicts?: string | object;
+        conflicts?: string | string[] | { [key: string]: string | string[] };
         count?: boolean;
         default?: any;
         defaultDescription?: string;
-        /** @deprecated since version 6.6.0 */
+        /**
+         *  @deprecated since version 6.6.0
+         *  Use 'demandOption' instead
+         */
         demand?: boolean | string;
@@ -239,3 +265,4 @@ demandOption?: boolean | string;
         group?: string;
-        implies?: string | object;
+        hidden?: boolean;
+        implies?: string | string[] | { [key: string]: string | string[] };
         nargs?: number;
@@ -249,5 +276,19 @@ normalize?: boolean;
         string?: boolean;
-        type?: "array" | "boolean" | "count" | "number" | "string";
+        type?: "array" | "count" | PositionalOptionsType;
     }
 
+    interface PositionalOptions {
+        alias?: string | string[];
+        choices?: Choices;
+        coerce?: (arg: any) => any;
+        conflicts?: string | string[] | { [key: string]: string | string[] };
+        default?: any;
+        desc?: string;
+        describe?: string;
+        description?: string;
+        implies?: string | string[] | { [key: string]: string | string[] };
+        normalize?: boolean;
+        type?: PositionalOptionsType;
+    }
+
     interface CommandModule {
@@ -265,4 +306,4 @@ aliases?: string[] | string;
     type AsyncCompletionFunction = (current: string, argv: any, done: (completion: string[]) => void) => void;
-    type Choice = string | true | undefined;
-    type Choices = Choice[];
+    type Choices = Array<string | true | undefined>;
+    type PositionalOptionsType = "boolean" | "number" | "string";
 }
@@ -269,0 +310,0 @@

yargs/package.json

 {
     "name": "@types/yargs",
-    "version": "8.0.2",
+    "version": "10.0.0",
     "description": "TypeScript definitions for yargs",
@@ -9,15 +9,24 @@ "license": "MIT",
             "name": "Martin Poelstra",
-            "url": "https://github.com/poelstra"
+            "url": "https://github.com/poelstra",
+            "githubUsername": "poelstra"
         },
         {
             "name": "Mizunashi Mana",
-            "url": "https://github.com/mizunashi-mana"
+            "url": "https://github.com/mizunashi-mana",
+            "githubUsername": "mizunashi-mana"
         },
         {
             "name": "Jeffery Grajkowski",
-            "url": "https://github.com/pushplay"
+            "url": "https://github.com/pushplay",
+            "githubUsername": "pushplay"
         },
         {
             "name": "Jeff Kenney",
-            "url": "https://github.com/jeffkenney"
+            "url": "https://github.com/jeffkenney",
+            "githubUsername": "jeffkenney"
+        },
+        {
+            "name": "Jimi (Dimitris) Charalampidis",
+            "url": "https://github.com/JimiC",
+            "githubUsername": "JimiC"
         }
@@ -32,5 +41,4 @@ ],
     "dependencies": {},
-    "peerDependencies": {},
-    "typesPublisherContentHash": "b037ce9187ffa3e8ad3713f0e68c16c3d5a45863794058d4a279a4a45351648c",
+    "typesPublisherContentHash": "dba3a0c62a61e2c1e5b43a9164b6e9c04ef1e6204fb9fe5e5c0e886e5b9871c8",
     "typeScriptVersion": "2.2"
 }

yargs/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Tue, 01 Aug 2017 21:20:06 GMT
+ * Last updated: Wed, 06 Dec 2017 20:10:39 GMT
  * Dependencies: none
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by Martin Poelstra <https://github.com/poelstra>, Mizunashi Mana <https://github.com/mizunashi-mana>, Jeffery Grajkowski <https://github.com/pushplay>, Jeff Kenney <https://github.com/jeffkenney>.
+These definitions were written by Martin Poelstra <https://github.com/poelstra>, Mizunashi Mana <https://github.com/mizunashi-mana>, Jeffery Grajkowski <https://github.com/pushplay>, Jeff Kenney <https://github.com/jeffkenney>, Jimi (Dimitris) Charalampidis <https://github.com/JimiC>.

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Improved metrics

Total package byte prevSize

15350

increased by19.36%

Lines of code

238

increased by17.24%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes