@ix-xs/node-comfort 1.2.0 → 2.1.0

package/types/src/Checker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Checker.d.ts","sourceRoot":"","sources":["../../src/Checker.js"],"names":[],"mappings":"AAUE;;;;;;;;;GASG;AACH,+BAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;;GAUG;AACH,gCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,gCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,iCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,+BAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;;GAUG;AACH,kCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,uCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;;;;;GAaG;AACH,gCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;;;;GAYG;AACH,qCAHW,GAAC,GACC,OAAO,CAMnB;AAED;;;;;;;;;;GAUG;AACH,iCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,gCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;GAQG;AACH,gCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,gCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,mCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,8BAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;;GAUG;AACH,6BAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,mCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;;GAUG;AACH,iCAHW,GAAC,GACC,OAAO,CASnB;AAED;;;;;;;;;GASG;AACH,gCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;;;GAWG;AACH,8BAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,mCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,6BAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;GASG;AACH,6BAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;GAKG;AACH,iCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;GAKG;AACH,iCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;;;;GAYG;AACH,kCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;GAKG;AACH,gCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;GAKG;AACH,oCAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;;;;GAYG;AACH,+BAHW,GAAC,GACC,OAAO,CAInB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,+BAHW,GAAC,GACC,OAAO,CAQnB;AAED;;;;;;;;;;;;GAYG;AACH,+BAHW,GAAC,GACC,OAAO,CAKnB;AAED;;;;;;;;;;GAUG;AACH,6BAJW,GAAC,YACD;IAAE,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,GACtB,OAAO,CAWnB;AAED;;;;;;;;GAQG;AACH,8BAHW,GAAC,GACC,OAAO,CAKnB;AAED;;;;;;;;;GASG;AACH,8BAHW,GAAC,GACC,OAAO,CAUnB;AAED;;;;;;;;;;;GAWG;AACH,iCAHW,GAAC,GACC,OAAO,CAMnB"}
+{"version":3,"file":"Checker.d.ts","sourceRoot":"","sources":["../../src/Checker.js"],"names":[],"mappings":";;;4BA4Ba,SAAS,GAAG,UAAU,GAAG,iBAAiB,GAAG,UAAU,GAAG,WAAW,GAAG,UAAU,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,GAAG,cAAc;;;;wBAK/J,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAP3E;;;GAGG;AAEH;;;GAGG;AAEH;;;;;GAKG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;GAIG;AAEH;;;;;;;;;GASG;AACH,+BAHW,OAAO,GACL,KAAK,IAAI,GAAG,EAAE,CAI1B;AAED;;;;;;;;;;GAUG;AACH,gCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;;GAUG;AACH,gCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,iCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,qCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,+BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,kCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,kCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,iCAHW,OAAO,GACL,KAAK,IAAI,OAAO,CAI5B;AAED;;;;;;;;;GASG;AACH,gCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;GAKG;AACH,gCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,gCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;GAKG;AACH,mCAHW,OAAO,GACL,KAAK,IAAI,SAAS,CAI9B;AAED;;;;;GAKG;AACH,8BAHW,OAAO,GACL,KAAK,IAAI,IAAI,CAIzB;AAED;;;;;;;;;GASG;AACH,6BAHW,OAAO,GACL,KAAK,IAAI,IAAI,GAAG,SAAS,CAIrC;AAED;;;;;;;;;;GAUG;AACH,0BAJa,CAAC,SACH,CAAC,GACC,KAAK,IAAI,WAAW,CAAC,CAAC,CAAC,CAInC;AAED;;;;;GAKG;AACH,mCAHW,OAAO,GACL,KAAK,IAAI,SAAS,CAI9B;AAED;;;;;GAKG;AACH,kCAHW,OAAO,GACL,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAI5C;AAED;;;;;;;;;;GAUG;AACH,uCAHW,OAAO,GACL,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAIrD;AAED;;;;;GAKG;AACH,2CAHW,OAAO,GACL,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,SAAS,CAIlD;AAED;;;;;GAKG;AACH,mCAHW,OAAO,GACL,KAAK,IAAI,SAAS,CAI9B;AAED;;;;;;;;;GASG;AACH,+BAHW,OAAO,GACL,KAAK,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAIhD;AAED;;;;;;GAMG;AACH,gCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;;GAUG;AACH,qCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAI5C;AAED;;;;;GAKG;AACH,iCAHW,OAAO,GACL,KAAK,IAAI,WAAW,CAAC,GAAG,CAAC,CASrC;AAED;;;;;GAKG;AACH,gCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;GAKG;AACH,8BAHW,OAAO,GACL,KAAK,IAAI,IAAI,CAIzB;AAED;;;;;;;;;GASG;AACH,mCAHW,OAAO,GACL,KAAK,IAAI,IAAI,CAIzB;AAED;;;;;GAKG;AACH,6BAHW,OAAO,GACL,KAAK,IAAI,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAI1C;AAED;;;;;GAKG;AACH,6BAHW,OAAO,GACL,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,CAIjC;AAED;;;;;GAKG;AACH,iCAHW,OAAO,GACL,KAAK,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAI7C;AAED;;;;;GAKG;AACH,iCAHW,OAAO,GACL,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAIpC;AAED;;;;;GAKG;AACH,kCAHW,OAAO,GACL,KAAK,IAAI,QAAQ,CAAC,OAAO,CAAC,CAItC;AAED;;;;;GAKG;AACH,uCAHW,OAAO,GACL,KAAK,IAAI,aAAa,CAAC,OAAO,CAAC,CAI3C;AAED;;;;;GAKG;AACH,gCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;GAKG;AACH,oCAHW,OAAO,GACL,KAAK,IAAI,aAAa,CAIlC;AAED;;;;;GAKG;AACH,+BAHW,OAAO,GACL,KAAK,IAAI,KAAK,CAI1B;AAED;;;;;;;;;;;;GAYG;AACH,+BAHW,OAAO,GACL,OAAO,CASnB;AAED;;;;;;;;;GASG;AACH,+BAHW,OAAO,GACL,OAAO,CAKnB;AAED;;;;;;;;;;GAUG;AACH,0BALa,CAAC,SACH,OAAO,SACP,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,IAAI,CAAC,GAC1B,KAAK,IAAI,CAAC,EAAE,CAIxB;AAED;;;;;;;;;;;;GAYG;AACH,wBALkC,CAAC,SAAtB,SAAU,OAAO,EAAG,SACtB,OAAO,WACP,CAAC,GACC,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CAI9B;AAED;;;;;;;;;;;;GAYG;AACH,+BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;;;GAWG;AACH,6BAJW,OAAO,YACP,YAAY,GACV,KAAK,IAAI,MAAM,CAS3B;AAED;;;;;;;;;;GAUG;AACH,8BAJW,OAAO,YACP,aAAa,GACX,KAAK,IAAI,MAAM,CAQ3B;AAED;;;;;;;;;GASG;AACH,8BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAU3B;AAED;;;;;;;;;;GAUG;AACH,iCAHW,OAAO,GACL,KAAK,IAAI,MAAM,GAAG,MAAM,CAMpC;AAED;;;;;;;;;;;GAWG;AACH,4BAJW,OAAO,YACP,CAAC,GAAC,CAAC,GACD,KAAK,IAAI,MAAM,CAM3B;AAED;;;;;GAKG;AACH,8BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;GAKG;AACH,8BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,8BAHW,OAAO,GACL,OAAO,CAKnB;AAED;;;;;GAKG;AACH,6BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,kCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;;GAUG;AACH,gCAJW,OAAO,YACP,eAAe,GACb,KAAK,IAAI,MAAM,CAM3B;AAED;;;;;;;;;GASG;AACH,gCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAO3B;AAED;;;;;;;;;GASG;AACH,iCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAc3B;AAED;;;;;GAKG;AACH,8BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,+BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;GAKG;AACH,sCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,oCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAkB3B;AAED;;;;;;GAMG;AACH,6BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAa3B;AAED;;;;;;;;;;;;;GAaG;AACH,kCAJW,OAAO,YACP,iBAAiB,GACf,KAAK,IAAI,MAAM,CAQ3B;AAED;;;;;;;;;;GAUG;AACH,oCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,8BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAc3B;AAED;;;;;;;;;;GAUG;AACH,8BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;GAQG;AACH,kCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;GAQG;AACH,8BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,iCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;;GAUG;AACH,kCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;GASG;AACH,kCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAU3B;AAED;;;;;;;;;GASG;AACH,gCAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAS3B;AAED;;;;;;;;;;GAUG;AACH,8BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAU3B;AAED;;;;;;;;;GASG;AACH,+BAHW,OAAO,GACL,KAAK,IAAI,MAAM,CAI3B;AAED;;;;;;;;;;;;;GAaG;AACH,kCALW,OAAO,YACP,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,GACrB,QAAQ,SAAS,CAK7B;AAED;;;;;;;;;;;;;GAaG;AACH,2BAPa,CAAC,SACH,OAAO,SACP,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,YAC9B,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,GACrB,QAAQ,KAAK,IAAI,CAAC,CAQ9B"}

package/types/src/Cli.d.ts

@@ -0,0 +1,664 @@
+/**
+ * Border styles for `table()` and `box()`.
+ */
+export type BorderStyle = "rounded" | "single" | "double" | "heavy" | "ascii" | "none";
+/**
+ * A column of `table()`.
+ */
+export type TableColumn = {
+    /**
+     * Property name for object rows, index for array rows.
+     */
+    key: string | number;
+    /**
+     * Defaults to the key.
+     */
+    header?: string | undefined;
+    /**
+     * Defaults to right for numbers, left otherwise.
+     */
+    align?: "left" | "center" | "right" | undefined;
+    /**
+     * Longer values are cut with `…`.
+     */
+    maxWidth?: number | undefined;
+    /**
+     * Changes the value before it's shown.
+     */
+    format?: ((value: unknown, row: any) => unknown) | undefined;
+};
+/**
+ * Options for `table()`.
+ */
+export type TableOptions = {
+    /**
+     * Which columns, in which order. Defaults to every key found.
+     */
+    columns?: (string | TableColumn)[] | undefined;
+    /**
+     * `"markdown"` gives a Markdown table. Defaults to `"rounded"`.
+     */
+    border?: BorderStyle | "markdown" | undefined;
+    /**
+     * Show the header row. Defaults to `true`.
+     */
+    header?: boolean | undefined;
+    /**
+     * Bold header and faint borders. Automatic by default.
+     */
+    colors?: boolean | undefined;
+    /**
+     * Spaces around cell content. Defaults to `1`.
+     */
+    padding?: number | undefined;
+};
+/**
+ * Options for `box()`.
+ */
+export type BoxOptions = {
+    /**
+     * Shown in the top border.
+     */
+    title?: string | undefined;
+    /**
+     * Defaults to `"rounded"`.
+     */
+    border?: BorderStyle | undefined;
+    /**
+     * Space around the text. Defaults to `{ x: 2, y: 0 }`.
+     */
+    padding?: number | {
+        x?: number;
+        y?: number;
+    } | undefined;
+    /**
+     * Defaults to `"left"`.
+     */
+    align?: "left" | "center" | "right" | undefined;
+    /**
+     * A style name like `"green"`, or a hex code.
+     */
+    borderColor?: string | undefined;
+    /**
+     * Fixed inner width. Defaults to the longest line.
+     */
+    width?: number | undefined;
+    /**
+     * Automatic by default.
+     */
+    colors?: boolean | undefined;
+};
+/**
+ * Options for `spinner()`.
+ */
+export type SpinnerOptions = {
+    /**
+     * Animation frames. Defaults to braille dots.
+     */
+    frames?: string[] | undefined;
+    /**
+     * Milliseconds per frame. Defaults to `80`.
+     */
+    interval?: number | undefined;
+    /**
+     * A style name or hex code. Defaults to `"cyan"`.
+     */
+    color?: string | undefined;
+    /**
+     * Defaults to stderr, which keeps stdout clean for data.
+     */
+    stream?: NodeJS.WriteStream | undefined;
+};
+/**
+ * A spinner. Every method returns it.
+ */
+export type Spinner = {
+    /**
+     * Starts spinning, optionally with new text.
+     */
+    start: (text?: string) => Spinner;
+    /**
+     * Stops and clears the line.
+     */
+    stop: () => Spinner;
+    /**
+     * Stops with a green `✔`.
+     */
+    succeed: (text?: string) => Spinner;
+    /**
+     * Stops with a red `✖`.
+     */
+    fail: (text?: string) => Spinner;
+    /**
+     * Stops with a yellow `⚠`.
+     */
+    warn: (text?: string) => Spinner;
+    /**
+     * Stops with a blue `ℹ`.
+     */
+    info: (text?: string) => Spinner;
+    /**
+     * The text next to the spinner. Change it any time.
+     */
+    text: string;
+    isSpinning: boolean;
+};
+/**
+ * Options for `progress()`.
+ */
+export type ProgressOptions = {
+    /**
+     * The value that means 100%.
+     */
+    total: number;
+    /**
+     * Bar width in characters. Defaults to `30`.
+     */
+    width?: number | undefined;
+    /**
+     * Can use `{bar}`, `{percent}`, `{value}`, `{total}`, `{eta}`, `{elapsed}`, `{rate}` and `{label}`.
+     */
+    format?: string | undefined;
+    /**
+     * Filled character. Defaults to `"█"`.
+     */
+    complete?: string | undefined;
+    /**
+     * Empty character. Defaults to `"░"`.
+     */
+    incomplete?: string | undefined;
+    /**
+     * Text for `{label}`.
+     */
+    label?: string | undefined;
+    /**
+     * Defaults to stderr.
+     */
+    stream?: NodeJS.WriteStream | undefined;
+};
+/**
+ * A progress bar.
+ */
+export type ProgressBar = {
+    /**
+     * Adds to the value, 1 by default.
+     */
+    tick: (amount?: number, label?: string) => ProgressBar;
+    /**
+     * Sets the value.
+     */
+    update: (value: number, label?: string) => ProgressBar;
+    /**
+     * Draws the final state and frees the line.
+     */
+    stop: () => ProgressBar;
+    value: number;
+    /**
+     * You can change it along the way.
+     */
+    total: number;
+    /**
+     * From 0 to 100.
+     */
+    percent: number;
+};
+/**
+ * Options for `prompt()`.
+ */
+export type PromptOptions = {
+    /**
+     * Used when the answer is empty.
+     */
+    default?: string | undefined;
+    /**
+     * Return `true` to accept, or a message to ask again.
+     */
+    validate?: ((answer: string) => true | string | Promise<true | string>) | undefined;
+    /**
+     * Defaults to stdin.
+     */
+    input?: NodeJS.ReadableStream | undefined;
+    /**
+     * Defaults to stdout.
+     */
+    output?: NodeJS.WritableStream | undefined;
+};
+/**
+ * Options for `confirm()`.
+ */
+export type ConfirmOptions = {
+    /**
+     * The answer when the user just presses Enter. Defaults to `false`.
+     */
+    default?: boolean | undefined;
+    /**
+     * Defaults to stdin.
+     */
+    input?: NodeJS.ReadableStream | undefined;
+    /**
+     * Defaults to stdout.
+     */
+    output?: NodeJS.WritableStream | undefined;
+};
+/**
+ * A choice for `select()` and `multiselect()`: a string, or a label with a
+ * value of any type.
+ */
+export type Choice<V = string> = string | {
+    label: string;
+    value: V;
+    hint?: string;
+    disabled?: boolean;
+};
+/**
+ * Options for `select()` and `multiselect()`.
+ */
+export type SelectOptions = {
+    /**
+     * Index of the choice highlighted at first. Defaults to `0`.
+     */
+    default?: number | undefined;
+    /**
+     * How many choices are visible at once. Defaults to `10`.
+     */
+    pageSize?: number | undefined;
+    /**
+     * `multiselect()` only: minimum number of choices.
+     */
+    min?: number | undefined;
+    /**
+     * Defaults to stdin.
+     */
+    input?: NodeJS.ReadStream | undefined;
+    /**
+     * Defaults to stdout.
+     */
+    output?: NodeJS.WriteStream | undefined;
+};
+/**
+ * A flag for `args()`.
+ */
+export type FlagSpec = {
+    /**
+     * Numbers are checked. Booleans also accept `--no-name`.
+     */
+    type: "string" | "number" | "boolean";
+    /**
+     * One-letter alias, like `"p"` for `-p`.
+     */
+    short?: string | undefined;
+    /**
+     * Used when the flag is missing.
+     */
+    default?: unknown;
+    /**
+     * Can be repeated (`--tag a --tag b`); you get an array.
+     */
+    multiple?: boolean | undefined;
+    /**
+     * Fail if it's missing.
+     */
+    required?: boolean | undefined;
+    /**
+     * Allowed values.
+     */
+    choices?: readonly string[] | readonly number[] | undefined;
+    /**
+     * An environment variable to read when the flag isn't given, like `"PORT"`. The command line wins, then the variable, then `default`.
+     */
+    env?: string | undefined;
+    /**
+     * Shown in `--help`.
+     */
+    description?: string | undefined;
+};
+/**
+ * The type of a flag's value.
+ */
+export type FlagValue<F extends FlagSpec> = F["type"] extends "boolean" ? boolean : F extends {
+    choices: readonly (infer C)[];
+} ? C : F["type"] extends "number" ? number : string;
+/**
+ * The parsed flags, typed from the schema.
+ */
+export type ParsedFlags<S extends Record<string, FlagSpec>> = { [K in keyof S]: S[K] extends {
+    multiple: true;
+} ? Array<FlagValue<S[K]>> : S[K] extends {
+    default: any;
+} | {
+    required: true;
+} | {
+    type: "boolean";
+} ? FlagValue<S[K]> : FlagValue<S[K]> | undefined; };
+/**
+ * Options for `args()`.
+ */
+export type ArgsOptions = {
+    /**
+     * What to parse. Defaults to `process.argv.slice(2)`.
+     */
+    argv?: string[] | undefined;
+    /**
+     * Program name in the help. Defaults to the script name.
+     */
+    name?: string | undefined;
+    /**
+     * Shown at the top of the help.
+     */
+    description?: string | undefined;
+    /**
+     * A usage line, like `"<file> [options]"`.
+     */
+    usage?: string | undefined;
+    /**
+     * Subcommands and what they do, like `{ build: "Build the project" }`. The first argument, when there is one, must be one of them and comes back as `command`. They share the flags of the program.
+     */
+    commands?: Record<string, string> | undefined;
+    /**
+     * Command lines shown at the end of the help.
+     */
+    examples?: string[] | undefined;
+    /**
+     * Answer `--help` and `-h` by printing the help and exiting. Defaults to `true`.
+     */
+    help?: boolean | undefined;
+    /**
+     * Answer `--version` with this version.
+     */
+    version?: string | undefined;
+    /**
+     * Reject unknown flags, with a suggestion. Defaults to `true`.
+     */
+    strict?: boolean | undefined;
+    /**
+     * Where `env` flags are read from. Defaults to `process.env`.
+     */
+    env?: Record<string, string | undefined> | undefined;
+};
+/**
+ * What `args()` returns.
+ */
+export type ParsedArgs<S extends Record<string, FlagSpec>> = {
+    flags: ParsedFlags<S>;
+    /**
+     * Arguments that aren't flags.
+     */
+    positionals: string[];
+    /**
+     * The subcommand, when `commands` was given.
+     */
+    command: string | undefined;
+    /**
+     * The generated help text.
+     */
+    help: () => string;
+};
+/**
+ * Options for `spin()`: the spinner's, plus what to say at the end.
+ */
+export type SpinOptions<T> = SpinnerOptions & {
+    success?: string | ((result: T) => string);
+    fail?: string | ((error: unknown) => string);
+};
+/**
+ * Options for `tree()`.
+ */
+export type TreeOptions = {
+    /**
+     * Draw with `|`, `+` and `-` instead of box characters.
+     */
+    ascii?: boolean | undefined;
+};
+/**
+ * One line reader per input stream, shared by every prompt, so piped lines
+ * that arrive early are queued instead of lost.
+ */
+export type _LineReader = {
+    rl: import("node:readline").Interface;
+    lines: string[];
+    waiting: Array<{
+        resolve: (line: string) => void;
+        reject: (error: Error) => void;
+    }>;
+    closed: boolean;
+};
+/**
+ * Draws a table from an array of objects (keys become columns) or an array
+ * of arrays. Colors, emoji and CJK characters line up correctly.
+ *
+ * @example
+ * console.log(cli.table([
+ *   { name: "Ada", role: "admin", logins: 42 },
+ *   { name: "Bob", role: "user", logins: 7 },
+ * ]));
+ * // ╭──────┬───────┬────────╮
+ * // │ name │ role  │ logins │
+ * // ├──────┼───────┼────────┤
+ * // │ Ada  │ admin │     42 │
+ * // │ Bob  │ user  │      7 │
+ * // ╰──────┴───────┴────────╯
+ *
+ * @param {Array<Record<string, unknown>> | unknown[][]} rows
+ * @param {TableOptions} [options]
+ * @returns {string}
+ */
+export function table(rows: Array<Record<string, unknown>> | unknown[][], options?: TableOptions): string;
+/**
+ * Draws a box around text.
+ *
+ * @example
+ * console.log(cli.box("Server ready\nhttp://localhost:3000", { title: "my-app", borderColor: "green" }));
+ * // ╭─ my-app ────────────────╮
+ * // │  Server ready           │
+ * // │  http://localhost:3000  │
+ * // ╰─────────────────────────╯
+ *
+ * @param {string} text
+ * @param {BoxOptions} [options]
+ * @returns {string}
+ */
+export function box(text: string, options?: BoxOptions): string;
+/**
+ * Draws nested data as a tree, like the `tree` command does for folders.
+ * Keys are branches. A value that is an object or an array opens a level,
+ * `null` or `true` makes a plain leaf, anything else is shown after the key.
+ *
+ * @example
+ * console.log(cli.tree({
+ *   src: { "index.js": null, lib: ["a.js", "b.js"] },
+ *   "package.json": "1.2 kB",
+ * }));
+ * // ├── src
+ * // │   ├── index.js
+ * // │   └── lib
+ * // │       ├── a.js
+ * // │       └── b.js
+ * // └── package.json: 1.2 kB
+ *
+ * @param {Record<string, unknown> | unknown[]} data
+ * @param {TreeOptions} [options]
+ * @returns {string}
+ */
+export function tree(data: Record<string, unknown> | unknown[], options?: TreeOptions): string;
+/**
+ * A spinner for work in progress. Call `.start()`, then finish with
+ * `.succeed()`, `.fail()`, `.warn()`, `.info()` or `.stop()`.
+ *
+ * @example
+ * const spin = cli.spinner("Downloading").start();
+ * try {
+ *   await download();
+ *   spin.succeed("Downloaded 12 files");
+ * } catch (error) {
+ *   spin.fail(`Download failed: ${error.message}`);
+ * }
+ *
+ * @param {string} [text=""]
+ * @param {SpinnerOptions} [options]
+ * @returns {Spinner} Not started yet.
+ */
+export function spinner(text?: string, options?: SpinnerOptions): Spinner;
+/**
+ * Shows a spinner while some work runs, then `✔` or `✖` depending on how it
+ * ended. Resolves with the result of the work, or rejects with its error.
+ *
+ * @example
+ * const users = await cli.spin("Loading users", () => db.getAll("users"));
+ * await cli.spin("Deploying", deploy(), {
+ *   success: (url) => `Deployed to ${url}`,
+ *   fail: (error) => `Deploy failed: ${error.message}`,
+ * });
+ *
+ * @template T
+ * @param {string} text
+ * @param {Promise<T> | ((spinner: Spinner) => T | Promise<T>)} task A promise, or a function that gets the spinner so it can update the text.
+ * @param {SpinOptions<T>} [options]
+ * @returns {Promise<T>}
+ */
+export function spin<T>(text: string, task: Promise<T> | ((spinner: Spinner) => T | Promise<T>), options?: SpinOptions<T>): Promise<T>;
+/**
+ * A progress bar with percentage, ETA and speed. It redraws at most every
+ * 50 ms, so calling `tick()` in a tight loop is fine.
+ *
+ * @example
+ * const bar = cli.progress({ total: files.length, format: "{bar} {percent}% {label}" });
+ * for (const file of files) {
+ *   await upload(file);
+ *   bar.tick(1, file.name);
+ * }
+ * bar.stop();
+ *
+ * @param {ProgressOptions} options
+ * @returns {ProgressBar}
+ */
+export function progress(options: ProgressOptions): ProgressBar;
+/**
+ * Asks a question and returns the answer. With `validate`, it keeps asking
+ * until the answer is valid.
+ *
+ * @example
+ * const name = await cli.prompt("Project name?", { default: "my-app" });
+ * const age = await cli.prompt("Age?", {
+ *   validate: (answer) => /^\d+$/.test(answer) || "Please enter a number",
+ * });
+ *
+ * @param {string} question
+ * @param {PromptOptions} [options]
+ * @returns {Promise<string>} Trimmed.
+ */
+export function prompt(question: string, options?: PromptOptions): Promise<string>;
+/**
+ * Asks for a secret without showing it; each character appears as `*`.
+ *
+ * @example
+ * const token = await cli.password("API token?");
+ *
+ * @param {string} question
+ * @param {{ mask?: string, input?: NodeJS.ReadStream, output?: NodeJS.WriteStream }} [options] `mask: ""` shows nothing at all.
+ * @returns {Promise<string>}
+ */
+export function password(question: string, options?: {
+    mask?: string;
+    input?: NodeJS.ReadStream;
+    output?: NodeJS.WriteStream;
+}): Promise<string>;
+/**
+ * Asks a yes/no question. Understands `y`, `yes`, `o`, `oui`, `true`, `1`
+ * and their opposites; an empty answer gives the default.
+ *
+ * @example
+ * if (await cli.confirm("Delete 42 files?")) await cleanup();
+ *
+ * @param {string} question
+ * @param {ConfirmOptions} [options]
+ * @returns {Promise<boolean>}
+ */
+export function confirm(question: string, options?: ConfirmOptions): Promise<boolean>;
+/**
+ * Lets the user pick one choice with the arrow keys and Enter. Without an
+ * interactive terminal, it prints a numbered list and reads a number.
+ *
+ * @example
+ * const framework = await cli.select("Framework?", ["Express", "Fastify", "Koa"]);
+ * const plan = await cli.select("Plan?", [
+ *   { label: "Free", value: "free", hint: "0 €" },
+ *   { label: "Pro", value: "pro", hint: "9 €/month" },
+ * ]);
+ *
+ * @template [V=string]
+ * @param {string} question
+ * @param {Array<Choice<V>>} choices
+ * @param {SelectOptions} [options]
+ * @returns {Promise<V>}
+ */
+export function select<V = string>(question: string, choices: Array<Choice<V>>, options?: SelectOptions): Promise<V>;
+/**
+ * Lets the user pick several choices: arrows to move, Space to toggle, `a`
+ * for all, Enter to confirm.
+ *
+ * @example
+ * const features = await cli.multiselect("Features?", ["TypeScript", "ESLint", "Tests", "Docker"], { min: 1 });
+ *
+ * @template [V=string]
+ * @param {string} question
+ * @param {Array<Choice<V>>} choices
+ * @param {SelectOptions} [options]
+ * @returns {Promise<V[]>} In list order.
+ */
+export function multiselect<V = string>(question: string, choices: Array<Choice<V>>, options?: SelectOptions): Promise<V[]>;
+/**
+ * Parses command-line arguments from a schema, and types the result:
+ * `flags.port` is a `number`. Handles short aliases, defaults, required
+ * flags, allowed values, repeated flags, `--no-flag`, environment variables
+ * as a fallback and subcommands, and generates `--help`. A typo gets a
+ * "Did you mean...?" suggestion.
+ *
+ * @example
+ * // node server.js --port 8080 -v --tag api --tag web public/
+ * const { flags, positionals } = cli.args({
+ *   port: { type: "number", short: "p", default: 3000, env: "PORT", description: "Port to listen on" },
+ *   verbose: { type: "boolean", short: "v" },
+ *   tag: { type: "string", multiple: true },
+ *   env: { type: "string", choices: ["dev", "prod"], default: "dev" },
+ * }, { description: "Start the web server", version: "1.0.0" });
+ * // flags: { port: 8080, verbose: true, tag: ["api", "web"], env: "dev" }
+ *
+ * // node tool.js build --watch
+ * const { command, flags: buildFlags } = cli.args({ watch: { type: "boolean" } }, {
+ *   commands: { build: "Build the project", serve: "Start the dev server" },
+ * });
+ * // command: "build"
+ *
+ * @template {Record<string, FlagSpec>} S
+ * @param {S} schema
+ * @param {ArgsOptions} [options]
+ * @returns {ParsedArgs<S>}
+ * @throws {TypeError} For unknown flags or commands, bad numbers, missing required flags or values not in `choices`. The message is ready to show.
+ */
+export function args<S extends Record<string, FlagSpec>>(schema: S, options?: ArgsOptions): ParsedArgs<S>;
+/**
+ * Is someone at the keyboard? True when stdin and stdout are terminals and
+ * we're not in CI.
+ *
+ * @example
+ * const name = cli.isInteractive() ? await cli.prompt("Name?") : "default";
+ *
+ * @returns {boolean}
+ */
+export function isInteractive(): boolean;
+/**
+ * The terminal size, or 80x24 when it's unknown.
+ *
+ * @returns {{ columns: number, rows: number }}
+ */
+export function size(): {
+    columns: number;
+    rows: number;
+};
+/**
+ * Clears the screen. Does nothing when stdout isn't a terminal.
+ *
+ * @returns {void}
+ */
+export function clear(): void;
+//# sourceMappingURL=Cli.d.ts.map

package/types/src/Cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cli.d.ts","sourceRoot":"","sources":["../../src/Cli.js"],"names":[],"mappings":";;;0BAuBa,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM;;;;;;;;SAM3D,MAAM,GAAG,MAAM;;;;;;;;;;;;;;;;sBAIP,OAAO,OAAO,GAAG,KAAK,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAkBtB,MAAM;YAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmBjC,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,OAAO;;;;UAC1B,MAAM,OAAO;;;;aACb,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,OAAO;;;;UAC1B,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,OAAO;;;;UAC1B,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,OAAO;;;;UAC1B,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,OAAO;;;;UAC1B,MAAM;gBACN,OAAO;;;;;;;;;WAMP,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAYN,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,WAAW;;;;YAChD,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,WAAW;;;;UAC9C,MAAM,WAAW;WACjB,MAAM;;;;WACN,MAAM;;;;aACN,MAAM;;;;;;;;;;;;;yBAOG,MAAM,KAAK,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAgB1D,CAAC,aACF,MAAM,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAgBtE,QAAQ,GAAG,QAAQ,GAAG,SAAS;;;;;;;;cAE/B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;sBAUG,CAAC,SAAX,QAAS,IACV,CAAC,CAAC,MAAM,CAAC,SAAS,SAAS,GAAG,OAAO,GAAG,CAAC,SAAS;IAAE,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAA;CAAE,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,QAAQ,GAAG,MAAM,GAAG,MAAM;;;;wBAK3G,CAAC,SAA3B,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAE,IAC1B,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;IAAE,OAAO,EAAE,GAAG,CAAA;CAAE,GAAG;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,GAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAoB5K,CAAC,SAA3B,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAE;WAEzB,WAAW,CAAC,CAAC,CAAC;;;;iBACd,MAAM,EAAE;;;;aACR,MAAM,GAAG,SAAS;;;;UAClB,MAAM,MAAM;;;;;wBAKb,CAAC,IACD,cAAc,GAAG;IAAE,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,MAAM,CAAC,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,CAAC,CAAA;CAAE;;;;;;;;;;;;;;0BAoiB7G;IAAE,EAAE,EAAE,OAAO,eAAe,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;QAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;KAAE,CAAC,CAAC;IAAC,MAAM,EAAE,OAAO,CAAA;CAAE;AAhc7K;;;;;;;;;;;;;;;;;;;GAmBG;AACH,4BAJW,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,OAAO,EAAE,EAAE,YAC5C,YAAY,GACV,MAAM,CAmFlB;AAED;;;;;;;;;;;;;GAaG;AACH,0BAJW,MAAM,YACN,UAAU,GACR,MAAM,CAwBlB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,2BAJW,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,EAAE,YACnC,WAAW,GACT,MAAM,CAiDlB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,+BAJW,MAAM,YACN,cAAc,GACZ,OAAO,CAgEnB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBANa,CAAC,QACH,MAAM,QACN,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,YACnD,WAAW,CAAC,CAAC,CAAC,GACZ,OAAO,CAAC,CAAC,CAAC,CAYtB;AAWD;;;;;;;;;;;;;;GAcG;AACH,kCAHW,eAAe,GACb,WAAW,CAmFvB;AAgED;;;;;;;;;;;;;GAaG;AACH,iCAJW,MAAM,YACN,aAAa,GACX,OAAO,CAAC,MAAM,CAAC,CAc3B;AAED;;;;;;;;;GASG;AACH,mCAJW,MAAM,YACN;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,CAAA;CAAE,GACvE,OAAO,CAAC,MAAM,CAAC,CA0D3B;AAED;;;;;;;;;;GAUG;AACH,kCAJW,MAAM,YACN,cAAc,GACZ,OAAO,CAAC,OAAO,CAAC,CAe5B;AAkHD;;;;;;;;;;;;;;;;GAgBG;AACH,uBANc,CAAC,qBACJ,MAAM,WACN,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAChB,aAAa,GACX,OAAO,CAAC,CAAC,CAAC,CAkBtB;AAED;;;;;;;;;;;;GAYG;AACH,4BANc,CAAC,qBACJ,MAAM,WACN,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,YAChB,aAAa,GACX,OAAO,CAAC,CAAC,EAAE,CAAC,CAmBxB;AAeD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBANwC,CAAC,SAA3B,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAE,UAC5B,CAAC,YACD,WAAW,GACT,UAAU,CAAC,CAAC,CAAC,CAyHzB;AAED;;;;;;;;GAQG;AACH,iCAFa,OAAO,CAInB;AAED;;;;GAIG;AACH,wBAFa;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAM7C;AAED;;;;GAIG;AACH,yBAFa,IAAI,CAIhB"}