@oclif/core 2.0.1 → 2.0.2-beta.1

package/lib/interfaces/command.d.ts

@@ -1,110 +0,0 @@
-import { Config, LoadOptions } from './config';
-import { ArgInput, BooleanFlagProps, Deprecation, FlagInput, OptionFlagProps } from './parser';
-import { Plugin as IPlugin } from './plugin';
-export type Example = string | {
-    description: string;
-    command: string;
-};
-export interface CommandProps {
-    /** A command ID, used mostly in error or verbose reporting. */
-    id: string;
-    /** Hide the command from help */
-    hidden: boolean;
-    /** Mark the command as a given state (e.g. beta or deprecated) in help */
-    state?: 'beta' | 'deprecated' | string;
-    /**
-     * Provide details to the deprecation warning if state === 'deprecated'
-     */
-    deprecationOptions?: Deprecation;
-    /**
-     * Emit a deprecation warning when a command alias is used.
-     */
-    deprecateAliases?: boolean;
-    /** An array of aliases for this command. */
-    aliases: string[];
-    /**
-     * The tweet-sized description for your class, used in a parent-commands
-     * sub-command listing and as the header for the command help.
-     */
-    summary?: string;
-    /**
-     * A full description of how to use the command.
-     *
-     * If no summary, the first line of the description will be used as the summary.
-     */
-    description?: string;
-    /**
-     * An override string (or strings) for the default usage documentation.
-     */
-    usage?: string | string[];
-    /**
-     * An array of examples to show at the end of the command's help.
-     *
-     * IF only a string is provide, it will try to look for a line that starts
-     * with the cmd.bin as the example command and the rest as the description.
-     * If found, the command will be formatted appropriately.
-     *
-     * ```
-     * EXAMPLES:
-     *   A description of a particular use case.
-     *
-     *     $ <%= config.bin => command flags
-     * ```
-     */
-    examples?: Example[];
-}
-export interface Command extends CommandProps {
-    type?: string;
-    pluginName?: string;
-    pluginType?: string;
-    pluginAlias?: string;
-    flags: {
-        [name: string]: Command.Flag;
-    };
-    args: Command.Arg[];
-    strict: boolean;
-    hasDynamicHelp?: boolean;
-}
-export declare namespace Command {
-    interface Arg {
-        name: string;
-        description?: string;
-        required?: boolean;
-        hidden?: boolean;
-        default?: string;
-        options?: string[];
-    }
-    type Flag = Flag.Boolean | Flag.Option;
-    namespace Flag {
-        interface Boolean extends BooleanFlagProps {
-        }
-        interface Option extends OptionFlagProps {
-            default?: string;
-            defaultHelp?: () => Promise<string>;
-        }
-    }
-    interface Base extends CommandProps {
-        _base: string;
-    }
-    interface Class extends Base {
-        plugin?: IPlugin;
-        flags?: FlagInput<any>;
-        args?: ArgInput;
-        strict: boolean;
-        hasDynamicHelp?: boolean;
-        new (argv: string[], config: Config): Instance;
-        run(argv?: string[], config?: LoadOptions): PromiseLike<any>;
-    }
-    interface Instance {
-        _run(argv: string[]): Promise<any>;
-    }
-    interface Loadable extends Command {
-        load(): Promise<Class>;
-    }
-    /**
-     * @deprecated use Command.Loadable instead.
-     */
-    interface Plugin extends Command {
-        load(): Promise<Class>;
-    }
-}

package/lib/parser/args.d.ts

@@ -1,5 +0,0 @@
-import { ParserArg, Arg, ParseFn } from '../interfaces';
-export declare function newArg<T>(arg: Arg & {
-    Parse: ParseFn<T>;
-}): ParserArg<T>;
-export declare function newArg(arg: Arg): ParserArg<string>;

package/lib/parser/args.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.newArg = void 0;
-function newArg(arg) {
-    return {
-        parse: (i) => i,
-        ...arg,
-        required: Boolean(arg.required),
-    };
-}
-exports.newArg = newArg;

package/lib/parser/deps.d.ts

@@ -1,4 +0,0 @@
-declare const _default: () => {
-    add<T, K extends string, U>(this: T, name: K, fn: () => U): T & { [P in K]: U; };
-};
-export default _default;

package/lib/parser/deps.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = () => {
-    const cache = {};
-    return {
-        add(name, fn) {
-            Object.defineProperty(this, name, {
-                enumerable: true,
-                get: () => {
-                    cache[name] = cache[name] || fn();
-                    return cache[name];
-                },
-            });
-            return this;
-        },
-    };
-};

package/lib/parser/flags.d.ts

@@ -1,60 +0,0 @@
-/// <reference types="node" />
-import { URL } from 'url';
-import { Definition, OptionFlag, BooleanFlag } from '../interfaces';
-import { FlagParser, CustomOptionFlag } from '../interfaces/parser';
-/**
- * Create a custom flag.
- *
- * @example
- * type Id = string
- * type IdOpts = { startsWith: string; length: number };
- *
- * export const myFlag = custom<Id, IdOpts>({
- *   parse: async (input, opts) => {
- *     if (input.startsWith(opts.startsWith) && input.length === opts.length) {
- *       return input
- *     }
- *
- *     throw new Error('Invalid id')
- *   },
- * })
- */
-export declare function custom<T, P = Record<string, unknown>>(defaults: {
-    parse: FlagParser<T, string, P>;
-    multiple: true;
-} & Partial<CustomOptionFlag<T, P, true>>): Definition<T, P>;
-export declare function custom<T, P = Record<string, unknown>>(defaults: {
-    parse: FlagParser<T, string, P>;
-} & Partial<CustomOptionFlag<T, P>>): Definition<T, P>;
-export declare function custom<T = string, P = Record<string, unknown>>(defaults: Partial<CustomOptionFlag<T, P>>): Definition<T, P>;
-/**
- * @deprecated Use Flags.custom instead.
- */
-export declare function build<T>(defaults: {
-    parse: OptionFlag<T>['parse'];
-} & Partial<OptionFlag<T>>): Definition<T>;
-export declare function build(defaults: Partial<OptionFlag<string>>): Definition<string>;
-export declare function boolean<T = boolean>(options?: Partial<BooleanFlag<T>>): BooleanFlag<T>;
-export declare const integer: Definition<number, {
-    min?: number | undefined;
-    max?: number | undefined;
-}>;
-export declare const directory: Definition<string, {
-    exists?: boolean | undefined;
-}>;
-export declare const file: Definition<string, {
-    exists?: boolean | undefined;
-}>;
-/**
- * Initializes a string as a URL. Throws an error
- * if the string is not a valid URL.
- */
-export declare const url: Definition<URL, Record<string, unknown>>;
-export declare function option<T>(options: {
-    parse: OptionFlag<T>['parse'];
-} & Partial<CustomOptionFlag<T>>): OptionFlag<T | undefined>;
-declare const stringFlag: Definition<string, Record<string, unknown>>;
-export { stringFlag as string };
-export declare const defaultFlags: {
-    color: BooleanFlag<boolean>;
-};

package/lib/parser/flags.js

@@ -1,107 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultFlags = exports.string = exports.option = exports.url = exports.file = exports.directory = exports.integer = exports.boolean = exports.build = exports.custom = void 0;
-const url_1 = require("url");
-const fs = require("fs");
-function custom(defaults) {
-    return (options = {}) => {
-        return {
-            parse: async (i, _context, _opts) => i,
-            ...defaults,
-            ...options,
-            input: [],
-            multiple: Boolean(options.multiple === undefined ? defaults.multiple : options.multiple),
-            type: 'option',
-        };
-    };
-}
-exports.custom = custom;
-function build(defaults) {
-    return (options = {}) => {
-        return {
-            parse: async (i, _context) => i,
-            ...defaults,
-            ...options,
-            input: [],
-            multiple: Boolean(options.multiple === undefined ? defaults.multiple : options.multiple),
-            type: 'option',
-        };
-    };
-}
-exports.build = build;
-function boolean(options = {}) {
-    return {
-        parse: async (b, _) => b,
-        ...options,
-        allowNo: Boolean(options.allowNo),
-        type: 'boolean',
-    };
-}
-exports.boolean = boolean;
-exports.integer = custom({
-    parse: async (input, _, opts) => {
-        if (!/^-?\d+$/.test(input))
-            throw new Error(`Expected an integer but received: ${input}`);
-        const num = Number.parseInt(input, 10);
-        if (opts.min !== undefined && num < opts.min)
-            throw new Error(`Expected an integer greater than or equal to ${opts.min} but received: ${input}`);
-        if (opts.max !== undefined && num > opts.max)
-            throw new Error(`Expected an integer less than or equal to ${opts.max} but received: ${input}`);
-        return num;
-    },
-});
-exports.directory = custom({
-    parse: async (input, _, opts) => {
-        if (opts.exists)
-            return dirExists(input);
-        return input;
-    },
-});
-exports.file = custom({
-    parse: async (input, _, opts) => {
-        if (opts.exists)
-            return fileExists(input);
-        return input;
-    },
-});
-/**
- * Initializes a string as a URL. Throws an error
- * if the string is not a valid URL.
- */
-exports.url = custom({
-    parse: async (input) => {
-        try {
-            return new url_1.URL(input);
-        }
-        catch {
-            throw new Error(`Expected a valid url but received: ${input}`);
-        }
-    },
-});
-function option(options) {
-    return custom(options)();
-}
-exports.option = option;
-const stringFlag = custom({});
-exports.string = stringFlag;
-exports.defaultFlags = {
-    color: boolean({ allowNo: true }),
-};
-const dirExists = async (input) => {
-    if (!fs.existsSync(input)) {
-        throw new Error(`No directory found at ${input}`);
-    }
-    if (!(await fs.promises.stat(input)).isDirectory()) {
-        throw new Error(`${input} exists but is not a directory`);
-    }
-    return input;
-};
-const fileExists = async (input) => {
-    if (!fs.existsSync(input)) {
-        throw new Error(`No file found at ${input}`);
-    }
-    if (!(await fs.promises.stat(input)).isFile()) {
-        throw new Error(`${input} exists but is not a file`);
-    }
-    return input;
-};

package/lib/parser/list.d.ts

@@ -1,2 +0,0 @@
-import { List } from '../interfaces';
-export declare function renderList(items: List): string;

package/lib/parser/list.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderList = void 0;
-const screen_1 = require("../screen");
-const util_1 = require("./util");
-function linewrap(length, s) {
-    const lw = require('@oclif/linewrap');
-    return lw(length, screen_1.stdtermwidth, {
-        skipScheme: 'ansi-color',
-    })(s).trim();
-}
-function renderList(items) {
-    if (items.length === 0) {
-        return '';
-    }
-    const maxLength = (0, util_1.maxBy)(items, i => i[0].length)[0].length;
-    const lines = items.map(i => {
-        let left = i[0];
-        let right = i[1];
-        if (!right) {
-            return left;
-        }
-        left = left.padEnd(maxLength);
-        right = linewrap(maxLength + 2, right);
-        return `${left}  ${right}`;
-    });
-    return lines.join('\n');
-}
-exports.renderList = renderList;

package/lib/parser/util.d.ts

@@ -1,7 +0,0 @@
-export declare function pickBy<T extends {
-    [s: string]: T[keyof T];
-} | ArrayLike<T[keyof T]>>(obj: T, fn: (i: T[keyof T]) => boolean): Partial<T>;
-export declare function maxBy<T>(arr: T[], fn: (i: T) => number): T | undefined;
-type SortTypes = string | number | undefined | boolean;
-export declare function sortBy<T>(arr: T[], fn: (i: T) => SortTypes | SortTypes[]): T[];
-export {};

package/lib/parser/util.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sortBy = exports.maxBy = exports.pickBy = void 0;
-function pickBy(obj, fn) {
-    return Object.entries(obj)
-        .reduce((o, [k, v]) => {
-        if (fn(v))
-            o[k] = v;
-        return o;
-    }, {});
-}
-exports.pickBy = pickBy;
-function maxBy(arr, fn) {
-    let max;
-    for (const cur of arr) {
-        const i = fn(cur);
-        if (!max || i > max.i) {
-            max = { i, element: cur };
-        }
-    }
-    return max && max.element;
-}
-exports.maxBy = maxBy;
-function sortBy(arr, fn) {
-    // function castType(t: SortTypes | SortTypes[]): string | number | SortTypes[] {
-    //   if (t === undefined) return 0
-    //   if (t === false) return 1
-    //   if (t === true) return -1
-    //   return t
-    // }
-    function compare(a, b) {
-        a = a === undefined ? 0 : a;
-        b = b === undefined ? 0 : b;
-        if (Array.isArray(a) && Array.isArray(b)) {
-            if (a.length === 0 && b.length === 0)
-                return 0;
-            const diff = compare(a[0], b[0]);
-            if (diff !== 0)
-                return diff;
-            return compare(a.slice(1), b.slice(1));
-        }
-        if (a < b)
-            return -1;
-        if (a > b)
-            return 1;
-        return 0;
-    }
-    return arr.sort((a, b) => compare(fn(a), fn(b)));
-}
-exports.sortBy = sortBy;