cli-api 0.1.2 → 0.2.1

package/dist/types/constants.d.ts

@@ -1,4 +0,0 @@
-export declare const EMPTY_ARRAY: ReadonlyArray<any>;
-export declare const EMPTY_OBJECT: Record<string, any>;
-export declare const TRUE_VALUES: Set<string>;
-export declare const FALSE_VALUES: Set<string>;

package/dist/types/index.d.ts

@@ -1,3 +0,0 @@
-export type { App, Command, Option } from "./interfaces";
-export { OptType } from './interfaces';
-export { default as default } from './run';

package/dist/types/interfaces.d.ts

@@ -1,79 +0,0 @@
-export interface Command {
-    name: string;
-    alias?: string | string[];
-    description?: string;
-    longDescription?: string;
-    flags?: Flag[];
-    options?: Option[];
-    arguments?: Argument[];
-    /**
-     * Executed when the command matches.
-     *
-     * @param options Named arguments, options, and flags.
-     * @param args Positional arguments.
-     * @param app Entire app config.
-     */
-    execute(options: Record<string, any>, args: string[], app: App): Promise<number | void>;
-}
-export declare enum OptType {
-    STRING = 0,
-    BOOL = 1,
-    INT = 2,
-    FLOAT = 3,
-    /** A string, truncated and converted to lowercase. */
-    ENUM = 4,
-    /** File must be readable. Single dash will be converted to STDIN. */
-    INPUT_FILE = 5,
-    /** Directory must be readable. */
-    INPUT_DIRECTORY = 6,
-    /** File's directory must exist and be writeable. Single dash will be converted to STDOUT. */
-    OUTPUT_FILE = 7,
-    OUTPUT_DIRECTORY = 8,
-    /** An empty or non-existent directory. */
-    EMPTY_DIRECTORY = 9
-}
-interface ArgumentOrOptionOrFlag {
-    /** Name of the option to display in help. */
-    name: string;
-    /** Alternative name for this option. */
-    alias?: string | string[];
-    /** Description of the option. */
-    description?: string;
-    /** Default value if not provided. */
-    defaultValue?: any | ((value: string) => any);
-    /** Default value to display in help. */
-    defaultValueText?: string;
-    /** Property name to use in `execute()` options. */
-    key?: string;
-}
-export declare type AnyOptType = OptType | string[];
-export interface ArgumentOrOption extends ArgumentOrOptionOrFlag {
-    /** Type to coerce the option value to. */
-    type?: AnyOptType;
-    /** Option is repeatable by specifying the flag again. Value will be an array. */
-    repeatable?: boolean;
-    /** Option is required. */
-    required?: boolean;
-}
-/** Boolean flag. */
-export interface Flag extends ArgumentOrOptionOrFlag, OptionOrFlag {
-}
-/** Positional argument. */
-export interface Argument extends ArgumentOrOption {
-}
-interface OptionOrFlag {
-    valueNotRequired?: boolean;
-}
-/** Option with value. */
-export interface Option extends ArgumentOrOption, OptionOrFlag {
-    /** Placeholder value to use in help. */
-    valuePlaceholder?: string;
-}
-export interface App {
-    name: string;
-    argv0?: string;
-    version?: string;
-    commands: Command[];
-    globalOptions?: Option[];
-}
-export {};

package/dist/types/options.d.ts

@@ -1,7 +0,0 @@
-import { App, Command, Option } from './interfaces';
-export declare function formatOption(opt: Option): [string, string];
-export declare function getValuePlaceholder(opt: Option): string;
-export declare function getOptions(cmd: Command): Option[];
-export declare function parseArgs(cmd: Command, argv: string[]): [any[], Record<string, any>];
-export declare function getOptName(opt: Option): string;
-export declare function getCommand(name: string, app: App): Command;

package/dist/types/print-command-help.d.ts

@@ -1,2 +0,0 @@
-import { App, Command } from './interfaces';
-export declare function printCommandHelp(app: App, cmd: Command): void;

package/dist/types/run.d.ts

@@ -1,2 +0,0 @@
-import { App } from './interfaces';
-export default function run(app: App): void;

package/dist/types/utils.d.ts

@@ -1,17 +0,0 @@
-/// <reference types="node" />
-import { App } from './interfaces';
-import FileSys from 'fs';
-export declare const print: {
-    (buffer: string | Uint8Array, cb?: ((err?: Error | undefined) => void) | undefined): boolean;
-    (str: string | Uint8Array, encoding?: string | undefined, cb?: ((err?: Error | undefined) => void) | undefined): boolean;
-};
-export declare const printLn: (message?: any, ...optionalParams: any[]) => void;
-export declare function abort(message: string, code?: number): never;
-export declare function toArray<T>(x: T | T[]): readonly T[];
-export declare function resolve<T>(x: any): T;
-export declare function toBool(str: string | boolean): boolean;
-export declare function space(len: number, str?: string): string;
-export declare function getProcName(app: App): string;
-export declare function includes(needle: string, haystack: string | string[] | undefined): boolean;
-export declare function statSync(path: string): FileSys.Stats | null;
-export declare function sortBy<T>(arr: T[], cmp: (x: T) => string): T[];

package/rollup.config.js

@@ -1,44 +0,0 @@
-import babel from '@rollup/plugin-babel';
-import nodeResolve from '@rollup/plugin-node-resolve';
-import nodeExternals from 'rollup-plugin-node-externals'
-import * as tsconfig from './tsconfig.json';
-import * as pkg from './package.json'
-import json from '@rollup/plugin-json';
-const extensions = ['.ts'];
-
-export default {
-    input: tsconfig.files,
-    plugins: [
-        nodeResolve({
-            extensions,
-        }),
-        nodeExternals({
-            builtins: true,
-            deps: true,
-            devDeps: false,
-            peerDeps: true,
-            optDeps: true,
-        }),
-        json(),
-        // TODO: change to typescript2 like node-mysql3c
-        babel({
-            exclude: 'node_modules/**',
-            extensions,
-            comments: false,
-            babelHelpers: 'bundled',
-        }),
-    ],
-    output: [
-        {
-            file: pkg.main,
-            format: 'cjs',
-            sourcemap: true,
-            exports: 'named',
-        },
-        {
-            file: pkg.module,
-            format: 'es',
-            sourcemap: true,
-        },
-    ],
-}

package/tsconfig.json

@@ -1,32 +0,0 @@
-{
-    "compilerOptions": {
-        "strict": true,
-        "importHelpers": false,
-        "inlineSources": true,
-        "noEmitOnError": true,
-        "pretty": true,
-        "module": "commonjs",
-        "noImplicitAny": true,
-        "suppressImplicitAnyIndexErrors": false,
-        "removeComments": false,
-        "preserveConstEnums": false,
-        "sourceMap": true,
-        "lib": ["esnext"],
-        "skipLibCheck": false,
-        "outDir": "dist/types",
-        "emitDeclarationOnly": true,
-        "target": "esnext",
-        "declaration": true,
-        "resolveJsonModule": true,
-        "esModuleInterop": true,
-        "moduleResolution": "node",
-        "isolatedModules": true,
-        "allowSyntheticDefaultImports": true
-    },
-    "files": [
-        "src/index.ts"
-    ],
-    "include": [
-        "src/**/*.d.ts"
-    ]
-}