yargs 15.3.2-beta.0 → 15.4.1

package/build/lib/type-helpers/command-builder.d.ts

@@ -1,2 +0,0 @@
-import { CommandBuilder, FunctionCommandBuilder } from '../types';
-export declare function isFunctionCommandBuilder(builder: CommandBuilder): builder is FunctionCommandBuilder;

package/build/lib/type-helpers/command-builder.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function isFunctionCommandBuilder(builder) {
-    return typeof builder === 'function';
-}
-exports.isFunctionCommandBuilder = isFunctionCommandBuilder;

package/build/lib/type-helpers/completion-function.d.ts

@@ -1,2 +0,0 @@
-import { CompletionFunction, SyncCompletionFunction } from '../types';
-export declare function isSyncCompletionFunction(completionFunction: CompletionFunction): completionFunction is SyncCompletionFunction;

package/build/lib/type-helpers/completion-function.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function isSyncCompletionFunction(completionFunction) {
-    return completionFunction.length < 3;
-}
-exports.isSyncCompletionFunction = isSyncCompletionFunction;

package/build/lib/type-helpers/index.d.ts

@@ -1,2 +0,0 @@
-export * from './completion-function';
-export * from './command-builder';

package/build/lib/type-helpers/index.js

@@ -1,7 +0,0 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./completion-function"));
-__export(require("./command-builder"));

package/build/lib/types/command-builder.d.ts

@@ -1,5 +0,0 @@
-import { YargsInstance } from './yargs-instance';
-export declare type CommandBuilder = FunctionCommandBuilder;
-export interface FunctionCommandBuilder {
-    (y: YargsInstance): YargsInstance;
-}

package/build/lib/types/command-builder.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/command-handler.d.ts

@@ -1,4 +0,0 @@
-import { CommandBuilder } from './command-builder';
-export interface CommandHandler {
-    builder: CommandBuilder;
-}

package/build/lib/types/command-handler.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/command-instance.d.ts

@@ -1,7 +0,0 @@
-import { CommandHandler } from './command-handler';
-import { Dictionary } from './dictionary';
-/** Instance of the command module. */
-export interface CommandInstance {
-    getCommandHandlers(): Dictionary<CommandHandler>;
-    getCommands(): string[];
-}

package/build/lib/types/command-instance.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/completion-function.d.ts

@@ -1,8 +0,0 @@
-import { Arguments } from 'yargs-parser';
-export declare type CompletionFunction = SyncCompletionFunction | AsyncCompletionFunction;
-export interface SyncCompletionFunction {
-    (current: string, argv: Arguments): string[] | Promise<string[]>;
-}
-export interface AsyncCompletionFunction {
-    (current: string, argv: Arguments, done: (completions: string[]) => any): any;
-}

package/build/lib/types/completion-function.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/completion-instance.d.ts

@@ -1,10 +0,0 @@
-import { CompletionFunction } from './completion-function';
-import { DetailedArguments } from 'yargs-parser';
-/** Instance of the completion module. */
-export interface CompletionInstance {
-    completionKey: string;
-    generateCompletionScript($0: string, cmd: string): string;
-    getCompletion(args: string[], done: (completions: string[]) => any): any;
-    registerFunction(fn: CompletionFunction): void;
-    setParsed(parsed: DetailedArguments): void;
-}

package/build/lib/types/completion-instance.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/context.d.ts

@@ -1,4 +0,0 @@
-/** Yargs' context. */
-export interface Context {
-    commands: string[];
-}

package/build/lib/types/context.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/custom-check.d.ts

@@ -1,5 +0,0 @@
-import { Arguments, DetailedArguments } from 'yargs-parser';
-export interface CustomCheck {
-    func: (argv: Arguments, aliases: DetailedArguments['aliases']) => any;
-    global: boolean;
-}

package/build/lib/types/custom-check.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/dictionary.d.ts

@@ -1,3 +0,0 @@
-export declare type Dictionary<T = any> = {
-    [key: string]: T;
-};

package/build/lib/types/dictionary.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/electron-process.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="node" />
-export interface ElectronProcess extends NodeJS.Process {
-    defaultApp?: boolean;
-    versions: NodeJS.ProcessVersions & {
-        electron: string;
-    };
-}

package/build/lib/types/electron-process.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/failure-function.d.ts

@@ -1,5 +0,0 @@
-import { UsageInstance } from './usage-instance';
-import { YError } from '../yerror';
-export interface FailureFunction {
-    (msg: string | undefined | null, err: YError | string | undefined, usage: UsageInstance): void;
-}

package/build/lib/types/failure-function.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/frozen-usage-instance.d.ts

@@ -1,11 +0,0 @@
-import { Dictionary } from './dictionary';
-export interface FrozenUsageInstance {
-    failMessage: string | undefined | null;
-    failureOutput: boolean;
-    usages: [string, string][];
-    usageDisabled: boolean;
-    epilogs: string[];
-    examples: [string, string][];
-    commands: [string, string, boolean, string[]][];
-    descriptions: Dictionary<string | undefined>;
-}

package/build/lib/types/frozen-usage-instance.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/frozen-validation-instance.d.ts

@@ -1,8 +0,0 @@
-import { CustomCheck } from './custom-check';
-import { Dictionary } from './dictionary';
-import { KeyOrPos } from './key-or-pos';
-export interface FrozenValidationInstance {
-    implied: Dictionary<KeyOrPos[]>;
-    checks: CustomCheck[];
-    conflicting: Dictionary<(string | undefined)[]>;
-}

package/build/lib/types/frozen-validation-instance.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/index.d.ts

@@ -1,20 +0,0 @@
-export * from './command-builder';
-export * from './command-handler';
-export * from './command-instance';
-export * from './completion-function';
-export * from './completion-instance';
-export * from './custom-check';
-export * from './context';
-export * from './dictionary';
-export * from './electron-process';
-export * from './failure-function';
-export * from './frozen-usage-instance';
-export * from './frozen-validation-instance';
-export * from './key-or-pos';
-export * from './logger-instance';
-export * from './options';
-export * from './parsed-command';
-export * from './parser-configuration';
-export * from './usage-instance';
-export * from './validation-instance';
-export * from './yargs-instance';

package/build/lib/types/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/key-or-pos.d.ts

@@ -1 +0,0 @@
-export declare type KeyOrPos = string | number | undefined;

package/build/lib/types/key-or-pos.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/logger-instance.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="node" />
-export declare type LoggerInstance = Pick<Console, 'error' | 'log'>;

package/build/lib/types/logger-instance.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/options.d.ts

@@ -1,19 +0,0 @@
-import { Dictionary } from './dictionary';
-import { ParserConfiguration } from './parser-configuration';
-export interface Options {
-    array: string[];
-    alias: Dictionary<string[]>;
-    boolean: string[];
-    choices: Dictionary<string[]>;
-    configuration: ParserConfiguration;
-    count: string[];
-    default: Dictionary;
-    defaultDescription: Dictionary<string | undefined>;
-    hiddenOptions: string[];
-    /** Manually set keys */
-    key: Dictionary<boolean>;
-    normalize: string[];
-    number: string[];
-    showHiddenOpt: string;
-    string: string[];
-}

package/build/lib/types/options.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/parsed-command.d.ts

@@ -1,6 +0,0 @@
-import { Positional } from './positional';
-export interface ParsedCommand {
-    cmd: string;
-    demanded: Positional[];
-    optional: Positional[];
-}

package/build/lib/types/parsed-command.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/parser-configuration.d.ts

@@ -1,5 +0,0 @@
-import yargsParser = require('yargs-parser');
-export interface ParserConfiguration extends yargsParser.Configuration {
-    /** Should command be sorted in help */
-    'sort-commands': boolean;
-}

package/build/lib/types/parser-configuration.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/positional.d.ts

@@ -1,4 +0,0 @@
-export interface Positional {
-    cmd: string[];
-    variadic: boolean;
-}

package/build/lib/types/positional.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/usage-instance.d.ts

@@ -1,37 +0,0 @@
-import { Dictionary } from './dictionary';
-import { FailureFunction } from './failure-function';
-import { YError } from '../yerror';
-/** Instance of the usage module. */
-export interface UsageInstance {
-    cacheHelpMessage(): void;
-    clearCachedHelpMessage(): void;
-    command(cmd: string, description: string | undefined, isDefault: boolean, aliases: string[]): void;
-    deferY18nLookup(str: string): string;
-    describe(key: string, desc?: string): void;
-    describe(keys: Dictionary<string>): void;
-    epilog(msg: string): void;
-    example(cmd: string, description?: string): void;
-    fail(msg?: string | null, err?: YError | string): void;
-    failFn(f: FailureFunction): void;
-    freeze(): void;
-    functionDescription(fn: {
-        name?: string;
-    }): string;
-    getCommands(): [string, string, boolean, string[]][];
-    getDescriptions(): Dictionary<string | undefined>;
-    getPositionalGroupName(): string;
-    getUsage(): [string, string][];
-    getUsageDisabled(): boolean;
-    help(): string;
-    reset(localLookup: Dictionary<boolean>): UsageInstance;
-    showHelp(level: 'error' | 'log'): void;
-    showHelp(level: (message: string) => void): void;
-    showHelpOnFail(message?: string): UsageInstance;
-    showHelpOnFail(enabled: boolean, message: string): UsageInstance;
-    showVersion(): void;
-    stringifiedValues(values?: any[], separator?: string): string;
-    unfreeze(): void;
-    usage(msg: string | null, description?: string): UsageInstance;
-    version(ver: any): void;
-    wrap(cols: number): void;
-}

package/build/lib/types/usage-instance.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/validation-instance.d.ts

@@ -1,28 +0,0 @@
-import { CustomCheck } from './custom-check';
-import { Dictionary } from './dictionary';
-import { KeyOrPos } from './key-or-pos';
-import { Arguments, DetailedArguments } from 'yargs-parser';
-/** Instance of the validation module. */
-export interface ValidationInstance {
-    check(f: CustomCheck['func'], global: boolean): void;
-    conflicting(argv: Arguments): void;
-    conflicts(key: string, value: string | string[]): void;
-    conflicts(key: Dictionary<string | string[]>): void;
-    customChecks(argv: Arguments, aliases: DetailedArguments['aliases']): void;
-    freeze(): void;
-    getConflicting(): Dictionary<(string | undefined)[]>;
-    getImplied(): Dictionary<KeyOrPos[]>;
-    implications(argv: Arguments): void;
-    implies(key: string, value: KeyOrPos | KeyOrPos[]): void;
-    implies(key: Dictionary<KeyOrPos | KeyOrPos[]>): void;
-    isValidAndSomeAliasIsNotNew(key: string, aliases: DetailedArguments['aliases']): boolean;
-    limitedChoices(argv: Arguments): void;
-    nonOptionCount(argv: Arguments): void;
-    positionalCount(required: number, observed: number): void;
-    recommendCommands(cmd: string, potentialCommands: string[]): void;
-    requiredArguments(argv: Arguments): void;
-    reset(localLookup: Dictionary): ValidationInstance;
-    unfreeze(): void;
-    unknownArguments(argv: Arguments, aliases: DetailedArguments['aliases'], positionalMap: Dictionary): void;
-    unknownCommands(argv: Arguments): boolean;
-}

package/build/lib/types/validation-instance.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/build/lib/types/yargs-instance.d.ts

@@ -1,44 +0,0 @@
-import { CommandInstance } from './command-instance';
-import { Context } from './context';
-import { Dictionary } from './dictionary';
-import { LoggerInstance } from './logger-instance';
-import { Options } from './options';
-import { ParserConfiguration } from './parser-configuration';
-import { YError } from '../yerror';
-import { Arguments, DetailedArguments } from 'yargs-parser';
-/** Instance of the yargs module. */
-export interface YargsInstance {
-    $0: string;
-    argv: Arguments;
-    customScriptName: boolean;
-    parsed: DetailedArguments;
-    _getLoggerInstance(): LoggerInstance;
-    _getParseContext(): Object;
-    _hasParseCallback(): boolean;
-    array(key: string): YargsInstance;
-    boolean(key: string): YargsInstance;
-    count(key: string): YargsInstance;
-    demandOption(key: string, msg: string): YargsInstance;
-    exit(code: number, err?: YError | string): void;
-    getCommandInstance(): CommandInstance;
-    getContext(): Context;
-    getDemandedOptions(): Dictionary<string>;
-    getDemandedCommands(): Dictionary<{
-        min: number;
-        max: number;
-        minMsg?: string | null;
-        maxMsg?: string | null;
-    }>;
-    getDeprecatedOptions(): Dictionary<string | boolean>;
-    getExitProcess(): boolean;
-    getGroups(): Dictionary<string[]>;
-    getOptions(): Options;
-    getParserConfiguration(): ParserConfiguration;
-    global(globals: string | string[], global?: boolean): YargsInstance;
-    normalize(key: string): YargsInstance;
-    number(key: string): YargsInstance;
-    parse(args: string[], shortCircuit: boolean): Arguments;
-    reset(): YargsInstance;
-    showHelp(level: string): YargsInstance;
-    string(key: string): YargsInstance;
-}

package/build/lib/types/yargs-instance.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });