@vltpkg/cli-sdk 1.0.0-rc.22 → 1.0.0-rc.24

package/dist/config/definition.d.ts

@@ -0,0 +1,407 @@
+export declare const defaultView: string;
+export declare const defaultEditor: () => string;
+/**
+ * Command aliases mapped to their canonical names
+ */
+export declare const commands: {
+    readonly i: "install";
+    readonly add: "install";
+    readonly rm: "uninstall";
+    readonly u: "update";
+    readonly p: "pkg";
+    readonly pub: "publish";
+    readonly q: "query";
+    readonly b: "build";
+    readonly r: "run";
+    readonly 'run-script': "run";
+    readonly rx: "run-exec";
+    readonly x: "exec";
+    readonly xl: "exec-local";
+    readonly h: "help";
+    readonly '?': "help";
+    readonly info: "view";
+    readonly ls: "list";
+    readonly show: "view";
+    readonly xc: "exec-cache";
+    readonly bugs: "bugs";
+    readonly build: "build";
+    readonly cache: "cache";
+    readonly ci: "ci";
+    readonly config: "config";
+    readonly create: "create";
+    readonly docs: "docs";
+    readonly exec: "exec";
+    readonly 'exec-local': "exec-local";
+    readonly help: "help";
+    readonly init: "init";
+    readonly install: "install";
+    readonly login: "login";
+    readonly logout: "logout";
+    readonly list: "list";
+    readonly pack: "pack";
+    readonly ping: "ping";
+    readonly pkg: "pkg";
+    readonly publish: "publish";
+    readonly query: "query";
+    readonly repo: "repo";
+    readonly 'run-exec': "run-exec";
+    readonly run: "run";
+    readonly token: "token";
+    readonly uninstall: "uninstall";
+    readonly update: "update";
+    readonly 'exec-cache': "exec-cache";
+    readonly version: "version";
+    readonly view: "view";
+    readonly whoami: "whoami";
+};
+/**
+ * Canonical command names mapped to an array of its aliases
+ */
+export declare const commandAliases: Map<string, string[]>;
+export type Commands = typeof commands;
+export declare const getCommand: (s?: string) => Commands[keyof Commands] | undefined;
+/**
+ * Fields that are parsed as a set of key=value pairs
+ */
+export declare const recordFields: readonly ["git-hosts", "registries", "git-host-archives", "scope-registries", "jsr-registries"];
+export type RecordField = (typeof recordFields)[number];
+export declare const isRecordField: (s: string) => s is RecordField;
+export declare const definition: import("jackspeak").Jack<{
+    color: {
+        short: string;
+        description: string;
+    };
+    'no-color': {
+        short: string;
+        description: string;
+    };
+} & {
+    color: import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    'no-color': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+} & {
+    registry: {
+        hint: string;
+        default: string;
+        description: string;
+    };
+} & {
+    registry: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    registries: {
+        hint: string;
+        description: string;
+    };
+    'scope-registries': {
+        hint: string;
+        description: string;
+    };
+    'jsr-registries': {
+        hint: string;
+        description: string;
+    };
+    'git-hosts': {
+        hint: string;
+        short: string;
+        description: string;
+    };
+    'git-host-archives': {
+        hint: string;
+        short: string;
+        description: string;
+    };
+} & {
+    registries: import("jackspeak").ConfigOption<"string", true, readonly string[] | undefined>;
+    'scope-registries': import("jackspeak").ConfigOption<"string", true, readonly string[] | undefined>;
+    'jsr-registries': import("jackspeak").ConfigOption<"string", true, readonly string[] | undefined>;
+    'git-hosts': import("jackspeak").ConfigOption<"string", true, readonly string[] | undefined>;
+    'git-host-archives': import("jackspeak").ConfigOption<"string", true, readonly string[] | undefined>;
+} & {
+    cache: {
+        hint: string;
+        description: string;
+        default: string;
+    };
+    tag: {
+        description: string;
+        default: string;
+    };
+    before: {
+        hint: string;
+        description: string;
+    };
+    os: {
+        description: string;
+        default: NodeJS.Platform;
+    };
+    arch: {
+        description: string;
+        default: NodeJS.Architecture;
+    };
+    libc: {
+        description: string;
+    };
+    'node-version': {
+        hint: string;
+        description: string;
+        default: string;
+    };
+} & {
+    cache: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    tag: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    before: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    os: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    arch: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    libc: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    'node-version': import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    'git-shallow': {
+        description: string;
+    };
+} & {
+    'git-shallow': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+} & {
+    'fetch-retries': {
+        hint: string;
+        description: string;
+        default: number;
+    };
+    'fetch-retry-factor': {
+        hint: string;
+        description: string;
+        default: number;
+    };
+    'fetch-retry-mintimeout': {
+        hint: string;
+        description: string;
+        default: number;
+    };
+    'fetch-retry-maxtimeout': {
+        hint: string;
+        description: string;
+        default: number;
+    };
+    'stale-while-revalidate-factor': {
+        hint: string;
+        default: number;
+        description: string;
+    };
+} & {
+    'fetch-retries': import("jackspeak").ConfigOption<"number", false, readonly number[] | undefined>;
+    'fetch-retry-factor': import("jackspeak").ConfigOption<"number", false, readonly number[] | undefined>;
+    'fetch-retry-mintimeout': import("jackspeak").ConfigOption<"number", false, readonly number[] | undefined>;
+    'fetch-retry-maxtimeout': import("jackspeak").ConfigOption<"number", false, readonly number[] | undefined>;
+    'stale-while-revalidate-factor': import("jackspeak").ConfigOption<"number", false, readonly number[] | undefined>;
+} & {
+    identity: {
+        short: string;
+        validate: (v: unknown) => boolean;
+        hint: string;
+        default: string;
+        description: string;
+    };
+} & {
+    identity: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    workspace: {
+        hint: string;
+        short: string;
+        description: string;
+    };
+    'workspace-group': {
+        description: string;
+    };
+} & {
+    workspace: import("jackspeak").ConfigOption<"string", true, readonly string[] | undefined>;
+    'workspace-group': import("jackspeak").ConfigOption<"string", true, readonly string[] | undefined>;
+} & {
+    scope: {
+        short: string;
+        hint: string;
+        description: string;
+    };
+    target: {
+        short: string;
+        hint: string;
+        description: string;
+    };
+} & {
+    scope: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    target: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    'if-present': {
+        description: string;
+    };
+} & {
+    'if-present': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+} & {
+    recursive: {
+        short: string;
+        description: string;
+    };
+    bail: {
+        short: string;
+        description: string;
+        default: true;
+    };
+    'no-bail': {
+        short: string;
+        description: string;
+    };
+} & {
+    recursive: import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    bail: import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    'no-bail': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+} & {
+    config: {
+        hint: string;
+        description: string;
+        validOptions: readonly ["all", "user", "project"];
+        default: string;
+    };
+    editor: {
+        hint: string;
+        description: string;
+        default: string;
+    };
+    'script-shell': {
+        hint: string;
+        description: string;
+    };
+    'fallback-command': {
+        hint: string;
+        description: string;
+        default: string;
+        validOptions: string[];
+    };
+} & {
+    config: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    editor: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    'script-shell': import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    'fallback-command': import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    package: {
+        hint: string;
+        description: string;
+    };
+} & {
+    package: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    call: {
+        hint: string;
+        description: string;
+    };
+} & {
+    call: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    view: {
+        hint: string;
+        default: string;
+        description: string;
+        validOptions: readonly ["human", "json", "mermaid", "svg", "png", "count", "inspect", "silent"];
+    };
+} & {
+    view: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    'dashboard-root': {
+        hint: string;
+        description: string;
+    };
+} & {
+    'dashboard-root': import("jackspeak").ConfigOption<"string", true, readonly string[] | undefined>;
+} & {
+    'save-dev': {
+        short: string;
+        description: string;
+    };
+    'save-optional': {
+        short: string;
+        description: string;
+    };
+    'save-peer': {
+        description: string;
+    };
+    'save-prod': {
+        short: string;
+        description: string;
+    };
+} & {
+    'save-dev': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    'save-optional': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    'save-peer': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    'save-prod': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+} & {
+    'expect-results': {
+        hint: string;
+        validate: (v: unknown) => boolean;
+        description: string;
+    };
+} & {
+    'expect-results': import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    'dry-run': {
+        description: string;
+    };
+    'expect-lockfile': {
+        description: string;
+    };
+    'frozen-lockfile': {
+        description: string;
+    };
+    'lockfile-only': {
+        description: string;
+    };
+} & {
+    'dry-run': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    'expect-lockfile': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    'frozen-lockfile': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    'lockfile-only': import("jackspeak").ConfigOption<"boolean", false, undefined>;
+} & {
+    'allow-scripts': {
+        hint: string;
+        description: string;
+    };
+} & {
+    'allow-scripts': import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    access: {
+        description: string;
+        validOptions: readonly ["public", "restricted"];
+    };
+} & {
+    access: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    otp: {
+        description: string;
+    };
+    'publish-directory': {
+        hint: string;
+        description: string;
+    };
+} & {
+    otp: import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+    'publish-directory': import("jackspeak").ConfigOption<"string", false, readonly string[] | undefined>;
+} & {
+    yes: {
+        short: string;
+        description: string;
+    };
+    version: {
+        short: string;
+        description: string;
+    };
+    help: {
+        short: string;
+        description: string;
+    };
+    all: {
+        short: string;
+        description: string;
+    };
+} & {
+    yes: import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    version: import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    help: import("jackspeak").ConfigOption<"boolean", false, undefined>;
+    all: import("jackspeak").ConfigOption<"boolean", false, undefined>;
+}>;
+export declare const getSortedCliOptions: () => string[];
+export declare const getSortedKeys: () => string[];