@vltpkg/cli-sdk 0.0.0-10

package/dist/esm/output.js

@@ -0,0 +1,121 @@
+import { formatWithOptions, styleText as utilStyleText, } from 'node:util';
+import { createSupportsColor } from 'supports-color';
+import { defaultView } from "./config/definition.js";
+import { printErr } from "./print-err.js";
+import { isViewClass } from "./view.js";
+const supportsColor = (stream) => {
+    const res = createSupportsColor(stream, { sniffFlags: false });
+    if (res === false)
+        return false;
+    /* c8 ignore next */
+    return res.level > 0;
+};
+// eslint-disable-next-line no-console
+export const stdout = (...args) => console.log(...args);
+// eslint-disable-next-line no-console
+export const stderr = (...args) => console.error(...args);
+/* c8 ignore start */
+const styleText = (f, s) => 
+// @ts-expect-error -- styleText 3rd argument is not in types/node
+utilStyleText(f, s, { validateStream: false });
+/* c8 ignore stop */
+// TODO: stop exporting mutable variables once exec output is refactored
+/* c8 ignore start */
+export let styleTextStdout = (_, s) => s;
+export let styleTextStderr = (_, s) => s;
+/* c8 ignore stop */
+const identity = (x) => x;
+export const getView = (conf, views) => {
+    const viewName = conf.values.view;
+    const viewFn = viewName === 'inspect' ? identity
+        : typeof views === 'function' ? views
+            : views && typeof views === 'object' ? views[viewName]
+                : identity;
+    // if the user specified a view that doesn't exist, then set it back to the
+    // default, and try again. This will fall back to identity if it's also
+    // missing. We also always treat 'json' as a valid view that falls back to
+    // identity. This allows the explicit use of `--view=json` to work even
+    // when the default view is `human`.
+    if (!viewFn &&
+        conf.values.view !== defaultView &&
+        conf.values.view !== 'json') {
+        conf.values.view = defaultView;
+        process.env.VLT_VIEW = defaultView;
+        return getView(conf, views);
+    }
+    return viewFn ?? identity;
+};
+/**
+ * If the view is a View class, then instantiate and start it.
+ * If it's a view function, then just define the onDone method.
+ */
+const startView = (conf, opts, views, { start } = { start: Date.now() }) => {
+    const View = getView(conf, views);
+    if (isViewClass(View)) {
+        const view = new View(opts, conf);
+        view.start();
+        return {
+            onDone(r) {
+                return view.done(r, { time: Date.now() - start });
+            },
+            onError(err) {
+                view.error(err);
+            },
+        };
+    }
+    return {
+        async onDone(r) {
+            if (r === undefined)
+                return;
+            return View(r, opts, conf);
+        },
+    };
+};
+/**
+ * Main export. Run the command appropriately, displaying output using
+ * the user-requested view, or the default if the user requested a view
+ * that is not defined for this command.
+ */
+export const outputCommand = async (cliCommand, conf, { start } = { start: Date.now() }) => {
+    const { usage, views, command } = cliCommand;
+    if (conf.values.help) {
+        return stdout(usage().usage());
+    }
+    const stdoutColor = conf.values.color ?? supportsColor(process.stdout);
+    const stderrColor = conf.values.color ?? supportsColor(process.stderr);
+    /* c8 ignore start */
+    if (stdoutColor)
+        styleTextStdout = styleText;
+    if (stderrColor)
+        styleTextStderr = styleText;
+    /* c8 ignore stop */
+    const formatOptions = {
+        depth: Infinity,
+        maxArrayLength: Infinity,
+        maxStringLength: Infinity,
+    };
+    const { onDone, onError } = startView(conf, 
+    // assume views will always output to stdout so use color support from there
+    { colors: stdoutColor }, views, { start });
+    try {
+        const output = await onDone(await command(conf));
+        if (output !== undefined) {
+            stdout(conf.values.view === 'json' ?
+                JSON.stringify(output, null, 2)
+                : formatWithOptions({
+                    ...formatOptions,
+                    colors: stdoutColor,
+                }, output));
+        }
+    }
+    catch (err) {
+        onError?.(err);
+        process.exitCode ||= 1;
+        printErr(err, usage, stderr, {
+            ...formatOptions,
+            colors: stderrColor,
+        });
+        process.exit(process.exitCode);
+    }
+};
+//# sourceMappingURL=output.js.map

package/dist/esm/output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../../src/output.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,iBAAiB,EACjB,SAAS,IAAI,aAAa,GAC3B,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAGpD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC,MAAM,aAAa,GAAG,CAAC,MAAmB,EAAE,EAAE;IAC5C,MAAM,GAAG,GAAG,mBAAmB,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;IAC9D,IAAI,GAAG,KAAK,KAAK;QAAE,OAAO,KAAK,CAAA;IAC/B,oBAAoB;IACpB,OAAO,GAAG,CAAC,KAAK,GAAG,CAAC,CAAA;AACtB,CAAC,CAAA;AAED,sCAAsC;AACtC,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAA;AAClE,sCAAsC;AACtC,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAA;AAOpE,qBAAqB;AACrB,MAAM,SAAS,GAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;AACtC,kEAAkE;AAClE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAA;AAChD,oBAAoB;AAEpB,wEAAwE;AACxE,qBAAqB;AACrB,MAAM,CAAC,IAAI,eAAe,GAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;AACrD,MAAM,CAAC,IAAI,eAAe,GAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;AACrD,oBAAoB;AAEpB,MAAM,QAAQ,GAAG,CAAI,CAAI,EAAK,EAAE,CAAC,CAAC,CAAA;AAElC,MAAM,CAAC,MAAM,OAAO,GAAG,CACrB,IAAkB,EAClB,KAAgB,EACP,EAAE;IACX,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAA;IAEjC,MAAM,MAAM,GACV,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ;QACjC,CAAC,CAAC,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK;YACrC,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;gBACtD,CAAC,CAAC,QAAQ,CAAA;IAEZ,2EAA2E;IAC3E,uEAAuE;IACvE,0EAA0E;IAC1E,uEAAuE;IACvE,oCAAoC;IACpC,IACE,CAAC,MAAM;QACP,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,WAAW;QAChC,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,EAC3B,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,WAAW,CAAA;QAC9B,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAA;QAClC,OAAO,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IAC7B,CAAC;IAED,OAAO,MAAM,IAAI,QAAQ,CAAA;AAC3B,CAAC,CAAA;AAMD;;;GAGG;AACH,MAAM,SAAS,GAAG,CAChB,IAAkB,EAClB,IAAiB,EACjB,KAAgB,EAChB,EAAE,KAAK,KAAwB,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,EAIpD,EAAE;IACF,MAAM,IAAI,GAAG,OAAO,CAAI,IAAI,EAAE,KAAK,CAAC,CAAA;IAEpC,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QACjC,IAAI,CAAC,KAAK,EAAE,CAAA;QACZ,OAAO;YACL,MAAM,CAAC,CAAC;gBACN,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC,CAAA;YACnD,CAAC;YACD,OAAO,CAAC,GAAG;gBACT,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACjB,CAAC;SACF,CAAA;IACH,CAAC;IAED,OAAO;QACL,KAAK,CAAC,MAAM,CAAC,CAAC;YACZ,IAAI,CAAC,KAAK,SAAS;gBAAE,OAAM;YAC3B,OAAO,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAC5B,CAAC;KACF,CAAA;AACH,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAChC,UAAsB,EACtB,IAAkB,EAClB,EAAE,KAAK,KAAwB,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,EACpD,EAAE;IACF,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAAA;IAE5C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACrB,OAAO,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAA;IAChC,CAAC;IAED,MAAM,WAAW,GACf,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACpD,MAAM,WAAW,GACf,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IAEpD,qBAAqB;IACrB,IAAI,WAAW;QAAE,eAAe,GAAG,SAAS,CAAA;IAC5C,IAAI,WAAW;QAAE,eAAe,GAAG,SAAS,CAAA;IAC5C,oBAAoB;IAEpB,MAAM,aAAa,GAAG;QACpB,KAAK,EAAE,QAAQ;QACf,cAAc,EAAE,QAAQ;QACxB,eAAe,EAAE,QAAQ;KACQ,CAAA;IAEnC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,SAAS,CACnC,IAAI;IACJ,4EAA4E;IAC5E,EAAE,MAAM,EAAE,WAAW,EAAE,EACvB,KAAK,EACL,EAAE,KAAK,EAAE,CACV,CAAA;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;QAChD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,MAAM,CACJ,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;gBAC3B,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBACjC,CAAC,CAAC,iBAAiB,CACf;oBACE,GAAG,aAAa;oBAChB,MAAM,EAAE,WAAW;iBACpB,EACD,MAAM,CACP,CACJ,CAAA;QACH,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,EAAE,CAAC,GAAG,CAAC,CAAA;QACd,OAAO,CAAC,QAAQ,KAAK,CAAC,CAAA;QAEtB,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE;YAC3B,GAAG,aAAa;YAChB,MAAM,EAAE,WAAW;SACpB,CAAC,CAAA;QAEF,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAChC,CAAC;AACH,CAAC,CAAA","sourcesContent":["import type { WriteStream } from 'node:tty'\nimport type { InspectOptions } from 'node:util'\nimport {\n  formatWithOptions,\n  styleText as utilStyleText,\n} from 'node:util'\nimport { createSupportsColor } from 'supports-color'\nimport { defaultView } from './config/definition.ts'\nimport type { LoadedConfig } from './config/index.ts'\nimport type { Command } from './index.ts'\nimport { printErr } from './print-err.ts'\nimport type { View, ViewOptions, Views } from './view.ts'\nimport { isViewClass } from './view.ts'\n\nconst supportsColor = (stream: WriteStream) => {\n  const res = createSupportsColor(stream, { sniffFlags: false })\n  if (res === false) return false\n  /* c8 ignore next */\n  return res.level > 0\n}\n\n// eslint-disable-next-line no-console\nexport const stdout = (...args: unknown[]) => console.log(...args)\n// eslint-disable-next-line no-console\nexport const stderr = (...args: unknown[]) => console.error(...args)\n\ntype StyleTextFn = (\n  format: Parameters<typeof utilStyleText>[0],\n  s: string,\n) => string\n\n/* c8 ignore start */\nconst styleText: StyleTextFn = (f, s) =>\n  // @ts-expect-error -- styleText 3rd argument is not in types/node\n  utilStyleText(f, s, { validateStream: false })\n/* c8 ignore stop */\n\n// TODO: stop exporting mutable variables once exec output is refactored\n/* c8 ignore start */\nexport let styleTextStdout: StyleTextFn = (_, s) => s\nexport let styleTextStderr: StyleTextFn = (_, s) => s\n/* c8 ignore stop */\n\nconst identity = <T>(x: T): T => x\n\nexport const getView = <T>(\n  conf: LoadedConfig,\n  views?: Views<T>,\n): View<T> => {\n  const viewName = conf.values.view\n\n  const viewFn =\n    viewName === 'inspect' ? identity\n    : typeof views === 'function' ? views\n    : views && typeof views === 'object' ? views[viewName]\n    : identity\n\n  // if the user specified a view that doesn't exist, then set it back to the\n  // default, and try again. This will fall back to identity if it's also\n  // missing. We also always treat 'json' as a valid view that falls back to\n  // identity. This allows the explicit use of `--view=json` to work even\n  // when the default view is `human`.\n  if (\n    !viewFn &&\n    conf.values.view !== defaultView &&\n    conf.values.view !== 'json'\n  ) {\n    conf.values.view = defaultView\n    process.env.VLT_VIEW = defaultView\n    return getView(conf, views)\n  }\n\n  return viewFn ?? identity\n}\n\nexport type OnDone<T> =\n  | ((result: T) => Promise<unknown>)\n  | ((result: T) => unknown)\n\n/**\n * If the view is a View class, then instantiate and start it.\n * If it's a view function, then just define the onDone method.\n */\nconst startView = <T>(\n  conf: LoadedConfig,\n  opts: ViewOptions,\n  views?: Views<T>,\n  { start }: { start: number } = { start: Date.now() },\n): {\n  onDone: OnDone<T>\n  onError?: (err: unknown) => void\n} => {\n  const View = getView<T>(conf, views)\n\n  if (isViewClass(View)) {\n    const view = new View(opts, conf)\n    view.start()\n    return {\n      onDone(r) {\n        return view.done(r, { time: Date.now() - start })\n      },\n      onError(err) {\n        view.error(err)\n      },\n    }\n  }\n\n  return {\n    async onDone(r) {\n      if (r === undefined) return\n      return View(r, opts, conf)\n    },\n  }\n}\n\n/**\n * Main export. Run the command appropriately, displaying output using\n * the user-requested view, or the default if the user requested a view\n * that is not defined for this command.\n */\nexport const outputCommand = async <T>(\n  cliCommand: Command<T>,\n  conf: LoadedConfig,\n  { start }: { start: number } = { start: Date.now() },\n) => {\n  const { usage, views, command } = cliCommand\n\n  if (conf.values.help) {\n    return stdout(usage().usage())\n  }\n\n  const stdoutColor =\n    conf.values.color ?? supportsColor(process.stdout)\n  const stderrColor =\n    conf.values.color ?? supportsColor(process.stderr)\n\n  /* c8 ignore start */\n  if (stdoutColor) styleTextStdout = styleText\n  if (stderrColor) styleTextStderr = styleText\n  /* c8 ignore stop */\n\n  const formatOptions = {\n    depth: Infinity,\n    maxArrayLength: Infinity,\n    maxStringLength: Infinity,\n  } as const satisfies InspectOptions\n\n  const { onDone, onError } = startView(\n    conf,\n    // assume views will always output to stdout so use color support from there\n    { colors: stdoutColor },\n    views,\n    { start },\n  )\n\n  try {\n    const output = await onDone(await command(conf))\n    if (output !== undefined) {\n      stdout(\n        conf.values.view === 'json' ?\n          JSON.stringify(output, null, 2)\n        : formatWithOptions(\n            {\n              ...formatOptions,\n              colors: stdoutColor,\n            },\n            output,\n          ),\n      )\n    }\n  } catch (err) {\n    onError?.(err)\n    process.exitCode ||= 1\n\n    printErr(err, usage, stderr, {\n      ...formatOptions,\n      colors: stderrColor,\n    })\n\n    process.exit(process.exitCode)\n  }\n}\n"]}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/parse-add-remove-args.d.ts

@@ -0,0 +1,22 @@
+import type { AddImportersDependenciesMap, RemoveImportersDependenciesMap } from '@vltpkg/graph';
+import type { Monorepo } from '@vltpkg/workspaces';
+import type { LoadedConfig } from './config/index.ts';
+export type ParsedAddArgs = {
+    add: AddImportersDependenciesMap;
+};
+export type ParsedRemoveArgs = {
+    remove: RemoveImportersDependenciesMap;
+};
+export type SaveTypes = {
+    'save-dev'?: boolean;
+    'save-optional'?: boolean;
+    'save-peer'?: boolean;
+    'save-prod'?: boolean;
+};
+export type WorkspaceTypes = {
+    workspace?: string[];
+    'workspace-group'?: string[];
+};
+export declare const parseAddArgs: (config: LoadedConfig, monorepo?: Monorepo) => ParsedAddArgs;
+export declare const parseRemoveArgs: (config: LoadedConfig, monorepo?: Monorepo) => ParsedRemoveArgs;
+//# sourceMappingURL=parse-add-remove-args.d.ts.map

package/dist/esm/parse-add-remove-args.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-add-remove-args.d.ts","sourceRoot":"","sources":["../../src/parse-add-remove-args.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,2BAA2B,EAE3B,8BAA8B,EAC/B,MAAM,eAAe,CAAA;AAKtB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,MAAM,aAAa,GAAG;IAC1B,GAAG,EAAE,2BAA2B,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,8BAA8B,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC7B,CAAA;AAqDD,eAAO,MAAM,YAAY,WACf,YAAY,aACT,QAAQ,KAClB,aA4BF,CAAA;AAED,eAAO,MAAM,eAAe,WAClB,YAAY,aACT,QAAQ,KAClB,gBAaF,CAAA"}

package/dist/esm/parse-add-remove-args.js

@@ -0,0 +1,71 @@
+import { joinDepIDTuple } from '@vltpkg/dep-id';
+import { asDependency } from '@vltpkg/graph';
+import { Spec } from '@vltpkg/spec';
+const rootDepID = joinDepIDTuple(['file', '.']);
+/**
+ * Get the list of importers that are currently selected
+ * in {@link WorkspaceTypes}.
+ */
+const getImporters = (opts, monorepo) => {
+    const res = new Set();
+    // collects DepID references to any selected workspace
+    if (monorepo) {
+        for (const ws of monorepo.filter(opts)) {
+            res.add(ws.id);
+        }
+    }
+    // if no references were found, default behavior is to point to project root
+    if (!res.size) {
+        res.add(rootDepID);
+    }
+    return res;
+};
+const getType = (opts) => opts['save-prod'] ? 'prod'
+    : opts['save-dev'] ? 'dev'
+        : opts['save-peer'] ?
+            opts['save-optional'] ?
+                'peerOptional'
+                : 'peer'
+            : opts['save-optional'] ? 'optional'
+                : 'implicit';
+class AddImportersDependenciesMapImpl extends Map {
+    modifiedDependencies = false;
+}
+class RemoveImportersDependenciesMapImpl extends Map {
+    modifiedDependencies = false;
+}
+export const parseAddArgs = (config, monorepo) => {
+    const add = new AddImportersDependenciesMapImpl();
+    const items = config.positionals;
+    const type = getType(config.values);
+    const importers = getImporters(config.values, monorepo);
+    const newDependencies = new Map();
+    const specOptions = config.options;
+    // nameless spec definitions will need to use their full
+    // stringified spec result instead of their name in order
+    // to have an unique key name in the resulting Map
+    const getName = (s) => s.name === '(unknown)' ? s.spec : s.name;
+    for (const item of items) {
+        const spec = Spec.parseArgs(item, specOptions);
+        newDependencies.set(getName(spec), asDependency({ spec, type }));
+        add.modifiedDependencies = true;
+    }
+    for (const importer of importers) {
+        add.set(importer, newDependencies);
+    }
+    return {
+        add,
+    };
+};
+export const parseRemoveArgs = (config, monorepo) => {
+    const remove = new RemoveImportersDependenciesMapImpl();
+    const importers = getImporters(config.values, monorepo);
+    for (const importer of importers) {
+        remove.set(importer, new Set(config.positionals));
+        remove.modifiedDependencies = true;
+    }
+    return {
+        remove,
+    };
+};
+//# sourceMappingURL=parse-add-remove-args.js.map

package/dist/esm/parse-add-remove-args.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-add-remove-args.js","sourceRoot":"","sources":["../../src/parse-add-remove-args.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAM/C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAyBnC,MAAM,SAAS,GAAG,cAAc,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;AAE/C;;;GAGG;AACH,MAAM,YAAY,GAAG,CACnB,IAAoB,EACpB,QAAmB,EACP,EAAE;IACd,MAAM,GAAG,GAAG,IAAI,GAAG,EAAS,CAAA;IAE5B,sDAAsD;IACtD,IAAI,QAAQ,EAAE,CAAC;QACb,KAAK,MAAM,EAAE,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;QAChB,CAAC;IACH,CAAC;IAED,4EAA4E;IAC5E,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACd,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IACpB,CAAC;IAED,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,OAAO,GAAG,CAAC,IAAe,EAAsB,EAAE,CACtD,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM;IAC1B,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK;QAC1B,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;YACnB,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;gBACrB,cAAc;gBAChB,CAAC,CAAC,MAAM;YACV,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,UAAU;gBACpC,CAAC,CAAC,UAAU,CAAA;AAEd,MAAM,+BACJ,SAAQ,GAAG;IAGX,oBAAoB,GAAG,KAAK,CAAA;CAC7B;AAED,MAAM,kCACJ,SAAQ,GAAG;IAGX,oBAAoB,GAAG,KAAK,CAAA;CAC7B;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,MAAoB,EACpB,QAAmB,EACJ,EAAE;IACjB,MAAM,GAAG,GACP,IAAI,+BAA+B,EAAE,CAAA;IACvC,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAA;IAChC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IACnC,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACvD,MAAM,eAAe,GAAG,IAAI,GAAG,EAAsB,CAAA;IACrD,MAAM,WAAW,GAAgB,MAAM,CAAC,OAAO,CAAA;IAE/C,wDAAwD;IACxD,yDAAyD;IACzD,kDAAkD;IAClD,MAAM,OAAO,GAAG,CAAC,CAAO,EAAU,EAAE,CAClC,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAE1C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;QAC9C,eAAe,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,YAAY,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;QAChE,GAAG,CAAC,oBAAoB,GAAG,IAAI,CAAA;IACjC,CAAC;IAED,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAA;IACpC,CAAC;IAED,OAAO;QACL,GAAG;KACJ,CAAA;AACH,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,MAAoB,EACpB,QAAmB,EACD,EAAE;IACpB,MAAM,MAAM,GACV,IAAI,kCAAkC,EAAE,CAAA;IAC1C,MAAM,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IAEvD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAA;QACjD,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAA;IACpC,CAAC;IAED,OAAO;QACL,MAAM;KACP,CAAA;AACH,CAAC,CAAA","sourcesContent":["import type { DepID } from '@vltpkg/dep-id'\nimport { joinDepIDTuple } from '@vltpkg/dep-id'\nimport type {\n  AddImportersDependenciesMap,\n  Dependency,\n  RemoveImportersDependenciesMap,\n} from '@vltpkg/graph'\nimport { asDependency } from '@vltpkg/graph'\nimport type { SpecOptions } from '@vltpkg/spec'\nimport { Spec } from '@vltpkg/spec'\nimport type { DependencySaveType } from '@vltpkg/types'\nimport type { Monorepo } from '@vltpkg/workspaces'\nimport type { LoadedConfig } from './config/index.ts'\n\nexport type ParsedAddArgs = {\n  add: AddImportersDependenciesMap\n}\n\nexport type ParsedRemoveArgs = {\n  remove: RemoveImportersDependenciesMap\n}\n\nexport type SaveTypes = {\n  'save-dev'?: boolean\n  'save-optional'?: boolean\n  'save-peer'?: boolean\n  'save-prod'?: boolean\n}\n\nexport type WorkspaceTypes = {\n  workspace?: string[]\n  'workspace-group'?: string[]\n}\n\nconst rootDepID = joinDepIDTuple(['file', '.'])\n\n/**\n * Get the list of importers that are currently selected\n * in {@link WorkspaceTypes}.\n */\nconst getImporters = (\n  opts: WorkspaceTypes,\n  monorepo?: Monorepo,\n): Set<DepID> => {\n  const res = new Set<DepID>()\n\n  // collects DepID references to any selected workspace\n  if (monorepo) {\n    for (const ws of monorepo.filter(opts)) {\n      res.add(ws.id)\n    }\n  }\n\n  // if no references were found, default behavior is to point to project root\n  if (!res.size) {\n    res.add(rootDepID)\n  }\n\n  return res\n}\n\nconst getType = (opts: SaveTypes): DependencySaveType =>\n  opts['save-prod'] ? 'prod'\n  : opts['save-dev'] ? 'dev'\n  : opts['save-peer'] ?\n    opts['save-optional'] ?\n      'peerOptional'\n    : 'peer'\n  : opts['save-optional'] ? 'optional'\n  : 'implicit'\n\nclass AddImportersDependenciesMapImpl\n  extends Map\n  implements AddImportersDependenciesMap\n{\n  modifiedDependencies = false\n}\n\nclass RemoveImportersDependenciesMapImpl\n  extends Map\n  implements RemoveImportersDependenciesMap\n{\n  modifiedDependencies = false\n}\n\nexport const parseAddArgs = (\n  config: LoadedConfig,\n  monorepo?: Monorepo,\n): ParsedAddArgs => {\n  const add: AddImportersDependenciesMap =\n    new AddImportersDependenciesMapImpl()\n  const items = config.positionals\n  const type = getType(config.values)\n  const importers = getImporters(config.values, monorepo)\n  const newDependencies = new Map<string, Dependency>()\n  const specOptions: SpecOptions = config.options\n\n  // nameless spec definitions will need to use their full\n  // stringified spec result instead of their name in order\n  // to have an unique key name in the resulting Map\n  const getName = (s: Spec): string =>\n    s.name === '(unknown)' ? s.spec : s.name\n\n  for (const item of items) {\n    const spec = Spec.parseArgs(item, specOptions)\n    newDependencies.set(getName(spec), asDependency({ spec, type }))\n    add.modifiedDependencies = true\n  }\n\n  for (const importer of importers) {\n    add.set(importer, newDependencies)\n  }\n\n  return {\n    add,\n  }\n}\n\nexport const parseRemoveArgs = (\n  config: LoadedConfig,\n  monorepo?: Monorepo,\n): ParsedRemoveArgs => {\n  const remove: RemoveImportersDependenciesMap =\n    new RemoveImportersDependenciesMapImpl()\n  const importers = getImporters(config.values, monorepo)\n\n  for (const importer of importers) {\n    remove.set(importer, new Set(config.positionals))\n    remove.modifiedDependencies = true\n  }\n\n  return {\n    remove,\n  }\n}\n"]}

package/dist/esm/print-err.d.ts

@@ -0,0 +1,7 @@
+import type { CommandUsage } from './index.ts';
+import type { InspectOptions } from 'node:util';
+export type ErrorFormatOptions = InspectOptions & {
+    maxLines?: number;
+};
+export declare const printErr: (err: unknown, usage: CommandUsage, stderr: (...a: string[]) => void, baseOpts?: ErrorFormatOptions) => void;
+//# sourceMappingURL=print-err.d.ts.map

package/dist/esm/print-err.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"print-err.d.ts","sourceRoot":"","sources":["../../src/print-err.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAG/C,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AA4BD,eAAO,MAAM,QAAQ,QACd,OAAO,SACL,YAAY,UACX,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,IAAI,aACrB,kBAAkB,SAkD9B,CAAA"}

package/dist/esm/print-err.js

@@ -0,0 +1,115 @@
+import { isErrorWithCode } from '@vltpkg/error-cause';
+import { formatWithOptions } from 'node:util';
+const trimStack = (err) => {
+    if (err.stack) {
+        const lines = err.stack.trim().split('\n');
+        if (lines[0] === `${err.name}: ${err.message}`) {
+            lines.shift();
+        }
+        return lines.map(l => l.trim()).join('\n');
+    }
+};
+const indent = (lines, num = 2) => lines
+    .split('\n')
+    .map(l => ' '.repeat(num) + l)
+    .join('\n');
+const isErrorWithProps = (value) => value instanceof Error && Object.keys(value).length > 0;
+export const printErr = (err, usage, stderr, baseOpts) => {
+    const format = (arg, opts) => {
+        const { maxLines = 200, ...rest } = { ...baseOpts, ...opts };
+        const lines = formatWithOptions(rest, arg).split('\n');
+        const totalLines = lines.length;
+        if (totalLines > maxLines) {
+            lines.length = maxLines;
+            lines.push(`... ${totalLines - maxLines} lines hidden ...`);
+        }
+        return lines.join('\n');
+    };
+    // This is an error with a cause, check if it we know about its
+    // code and try to print it. If it did not print then fallback
+    // to the next option.
+    if (isErrorWithCode(err) && print(err, usage, stderr, format)) {
+        return;
+    }
+    // We have a real but we dont know anything special about its
+    // properties. Just print the standard error properties as best we can.
+    if (err instanceof Error) {
+        stderr(`${err.name}: ${err.message}`);
+        if ('cause' in err) {
+            stderr(`Cause:`);
+            if (err.cause instanceof Error) {
+                stderr(indent(format(err.cause)));
+            }
+            else if (err.cause && typeof err.cause === 'object') {
+                for (const key in err.cause) {
+                    stderr(indent(`${key}: ${format(err.cause[key])}`));
+                }
+            }
+            else {
+                stderr(indent(format(err.cause)));
+            }
+        }
+        const stack = trimStack(err);
+        if (stack) {
+            stderr(`Stack:`);
+            stderr(indent(format(stack)));
+        }
+        return;
+    }
+    // We don't know what this is, just print it.
+    stderr(`Unknown Error:`, format(err));
+};
+const print = (err, usage, stderr, format) => {
+    switch (err.cause.code) {
+        case 'EUSAGE': {
+            const { found, validOptions } = err.cause;
+            stderr(usage().usage());
+            stderr(`Usage Error: ${err.message}`);
+            if (found) {
+                stderr(indent(`Found: ${format(found)}`));
+            }
+            if (validOptions) {
+                stderr(indent(`Valid options: ${format(validOptions.join(', '))}`));
+            }
+            return true;
+        }
+        case 'ERESOLVE': {
+            const { url, from, response, spec } = err.cause;
+            stderr(`Resolve Error: ${err.message}`);
+            if (url) {
+                stderr(indent(`While fetching: ${url}`));
+            }
+            if (spec) {
+                stderr(indent(`To satisfy: ${format(spec)}`));
+            }
+            if (from) {
+                stderr(indent(`From: ${format(from)}`));
+            }
+            if (response) {
+                stderr(indent(`Response: ${format(response)}`));
+            }
+            return true;
+        }
+        case 'EREQUEST': {
+            const { url, method } = err.cause;
+            const { code, syscall } = isErrorWithProps(err.cause.cause) ?
+                err.cause.cause
+                : {};
+            stderr(`Request Error: ${err.message}`);
+            if (code) {
+                stderr(indent(`Code: ${format(code)}`));
+            }
+            if (syscall) {
+                stderr(indent(`Syscall: ${format(syscall)}`));
+            }
+            if (url) {
+                stderr(indent(`URL: ${url}`));
+            }
+            if (method) {
+                stderr(indent(`Method: ${format(method)}`));
+            }
+            return true;
+        }
+    }
+};
+//# sourceMappingURL=print-err.js.map

package/dist/esm/print-err.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"print-err.js","sourceRoot":"","sources":["../../src/print-err.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAIrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAW7C,MAAM,SAAS,GAAG,CAAC,GAAU,EAAE,EAAE;IAC/B,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;QACd,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC1C,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;YAC/C,KAAK,CAAC,KAAK,EAAE,CAAA;QACf,CAAC;QACD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC5C,CAAC;AACH,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,GAAG,GAAG,CAAC,EAAE,EAAE,CACxC,KAAK;KACF,KAAK,CAAC,IAAI,CAAC;KACX,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;KAC7B,IAAI,CAAC,IAAI,CAAC,CAAA;AAEf,MAAM,gBAAgB,GAAG,CACvB,KAAc,EAC4B,EAAE,CAC5C,KAAK,YAAY,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;AAEzD,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,GAAY,EACZ,KAAmB,EACnB,MAAgC,EAChC,QAA6B,EAC7B,EAAE;IACF,MAAM,MAAM,GAAc,CAAC,GAAY,EAAE,IAAI,EAAE,EAAE;QAC/C,MAAM,EAAE,QAAQ,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,EAAE,CAAA;QAC5D,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACtD,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAA;QAC/B,IAAI,UAAU,GAAG,QAAQ,EAAE,CAAC;YAC1B,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAA;YACvB,KAAK,CAAC,IAAI,CAAC,OAAO,UAAU,GAAG,QAAQ,mBAAmB,CAAC,CAAA;QAC7D,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC,CAAA;IAED,+DAA+D;IAC/D,8DAA8D;IAC9D,sBAAsB;IACtB,IAAI,eAAe,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QAC9D,OAAM;IACR,CAAC;IAED,6DAA6D;IAC7D,uEAAuE;IACvE,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;QACrC,IAAI,OAAO,IAAI,GAAG,EAAE,CAAC;YACnB,MAAM,CAAC,QAAQ,CAAC,CAAA;YAChB,IAAI,GAAG,CAAC,KAAK,YAAY,KAAK,EAAE,CAAC;gBAC/B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACnC,CAAC;iBAAM,IAAI,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACtD,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;oBAC5B,MAAM,CACJ,MAAM,CACJ,GAAG,GAAG,KAAK,MAAM,CAAE,GAAG,CAAC,KAAiC,CAAC,GAAG,CAAC,CAAC,EAAE,CACjE,CACF,CAAA;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;YACnC,CAAC;QACH,CAAC;QACD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAA;QAC5B,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,CAAC,QAAQ,CAAC,CAAA;YAChB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAC/B,CAAC;QACD,OAAM;IACR,CAAC;IAED,6CAA6C;IAC7C,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;AACvC,CAAC,CAAA;AAED,MAAM,KAAK,GAAG,CACZ,GAAkB,EAClB,KAAmB,EACnB,MAAgC,EAChC,MAAiB,EACjB,EAAE;IACF,QAAQ,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACvB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,GAAG,CAAC,KAAK,CAAA;YACzC,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAA;YACvB,MAAM,CAAC,gBAAgB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;YACrC,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,CAAC,MAAM,CAAC,UAAU,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAA;YAC3C,CAAC;YACD,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,CACJ,MAAM,CAAC,kBAAkB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAC5D,CAAA;YACH,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC;QAED,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,KAAK,CAAA;YAC/C,MAAM,CAAC,kBAAkB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;YACvC,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,MAAM,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC,CAAA;YAC1C,CAAC;YACD,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,CAAC,MAAM,CAAC,eAAe,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;YAC/C,CAAC;YACD,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;YACzC,CAAC;YACD,IAAI,QAAQ,EAAE,CAAC;gBACb,MAAM,CAAC,MAAM,CAAC,aAAa,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAA;YACjD,CAAC;YACD,OAAO,IAAI,CAAA;QACb,CAAC;QAED,KAAK,UAAU,CAAC,CAAC,CAAC;YAChB,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,KAAK,CAAA;YACjC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GACrB,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;gBACjC,GAAG,CAAC,KAAK,CAAC,KAAK;gBACjB,CAAC,CAAE,EAA8B,CAAA;YACnC,MAAM,CAAC,kBAAkB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;YACvC,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;YACzC,CAAC;YACD,IAAI,OAAO,EAAE,CAAC;gBACZ,MAAM,CAAC,MAAM,CAAC,YAAY,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;YAC/C,CAAC;YACD,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC,CAAC,CAAA;YAC/B,CAAC;YACD,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,MAAM,CAAC,WAAW,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;YAC7C,CAAC;YAED,OAAO,IAAI,CAAA;QACb,CAAC;IACH,CAAC;AACH,CAAC,CAAA","sourcesContent":["import { isErrorWithCode } from '@vltpkg/error-cause'\nimport type { ErrorWithCode } from '@vltpkg/error-cause'\nimport type { CommandUsage } from './index.ts'\nimport type { InspectOptions } from 'node:util'\nimport { formatWithOptions } from 'node:util'\n\nexport type ErrorFormatOptions = InspectOptions & {\n  maxLines?: number\n}\n\ntype Formatter = (\n  arg: unknown,\n  options?: ErrorFormatOptions,\n) => string\n\nconst trimStack = (err: Error) => {\n  if (err.stack) {\n    const lines = err.stack.trim().split('\\n')\n    if (lines[0] === `${err.name}: ${err.message}`) {\n      lines.shift()\n    }\n    return lines.map(l => l.trim()).join('\\n')\n  }\n}\n\nconst indent = (lines: string, num = 2) =>\n  lines\n    .split('\\n')\n    .map(l => ' '.repeat(num) + l)\n    .join('\\n')\n\nconst isErrorWithProps = (\n  value: unknown,\n): value is Error & Record<string, unknown> =>\n  value instanceof Error && Object.keys(value).length > 0\n\nexport const printErr = (\n  err: unknown,\n  usage: CommandUsage,\n  stderr: (...a: string[]) => void,\n  baseOpts?: ErrorFormatOptions,\n) => {\n  const format: Formatter = (arg: unknown, opts) => {\n    const { maxLines = 200, ...rest } = { ...baseOpts, ...opts }\n    const lines = formatWithOptions(rest, arg).split('\\n')\n    const totalLines = lines.length\n    if (totalLines > maxLines) {\n      lines.length = maxLines\n      lines.push(`... ${totalLines - maxLines} lines hidden ...`)\n    }\n    return lines.join('\\n')\n  }\n\n  // This is an error with a cause, check if it we know about its\n  // code and try to print it. If it did not print then fallback\n  // to the next option.\n  if (isErrorWithCode(err) && print(err, usage, stderr, format)) {\n    return\n  }\n\n  // We have a real but we dont know anything special about its\n  // properties. Just print the standard error properties as best we can.\n  if (err instanceof Error) {\n    stderr(`${err.name}: ${err.message}`)\n    if ('cause' in err) {\n      stderr(`Cause:`)\n      if (err.cause instanceof Error) {\n        stderr(indent(format(err.cause)))\n      } else if (err.cause && typeof err.cause === 'object') {\n        for (const key in err.cause) {\n          stderr(\n            indent(\n              `${key}: ${format((err.cause as Record<string, unknown>)[key])}`,\n            ),\n          )\n        }\n      } else {\n        stderr(indent(format(err.cause)))\n      }\n    }\n    const stack = trimStack(err)\n    if (stack) {\n      stderr(`Stack:`)\n      stderr(indent(format(stack)))\n    }\n    return\n  }\n\n  // We don't know what this is, just print it.\n  stderr(`Unknown Error:`, format(err))\n}\n\nconst print = (\n  err: ErrorWithCode,\n  usage: CommandUsage,\n  stderr: (...a: string[]) => void,\n  format: Formatter,\n) => {\n  switch (err.cause.code) {\n    case 'EUSAGE': {\n      const { found, validOptions } = err.cause\n      stderr(usage().usage())\n      stderr(`Usage Error: ${err.message}`)\n      if (found) {\n        stderr(indent(`Found: ${format(found)}`))\n      }\n      if (validOptions) {\n        stderr(\n          indent(`Valid options: ${format(validOptions.join(', '))}`),\n        )\n      }\n      return true\n    }\n\n    case 'ERESOLVE': {\n      const { url, from, response, spec } = err.cause\n      stderr(`Resolve Error: ${err.message}`)\n      if (url) {\n        stderr(indent(`While fetching: ${url}`))\n      }\n      if (spec) {\n        stderr(indent(`To satisfy: ${format(spec)}`))\n      }\n      if (from) {\n        stderr(indent(`From: ${format(from)}`))\n      }\n      if (response) {\n        stderr(indent(`Response: ${format(response)}`))\n      }\n      return true\n    }\n\n    case 'EREQUEST': {\n      const { url, method } = err.cause\n      const { code, syscall } =\n        isErrorWithProps(err.cause.cause) ?\n          err.cause.cause\n        : ({} as Record<string, unknown>)\n      stderr(`Request Error: ${err.message}`)\n      if (code) {\n        stderr(indent(`Code: ${format(code)}`))\n      }\n      if (syscall) {\n        stderr(indent(`Syscall: ${format(syscall)}`))\n      }\n      if (url) {\n        stderr(indent(`URL: ${url}`))\n      }\n      if (method) {\n        stderr(indent(`Method: ${format(method)}`))\n      }\n\n      return true\n    }\n  }\n}\n"]}

package/dist/esm/read-password.d.ts

@@ -0,0 +1,8 @@
+export type Streams = {
+    stdin: NodeJS.ReadableStream & {
+        setRawMode(mode: boolean): void;
+    };
+    stdout: NodeJS.WritableStream;
+};
+export declare const readPassword: (prompt: string, { stdin, stdout }?: Streams) => Promise<string>;
+//# sourceMappingURL=read-password.d.ts.map

package/dist/esm/read-password.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-password.d.ts","sourceRoot":"","sources":["../../src/read-password.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC,cAAc,GAAG;QAAE,UAAU,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAAA;KAAE,CAAA;IAClE,MAAM,EAAE,MAAM,CAAC,cAAc,CAAA;CAC9B,CAAA;AAED,eAAO,MAAM,YAAY,WACf,MAAM,sBACK,OAAO,KACzB,OAAO,CAAC,MAAM,CA4BhB,CAAA"}

package/dist/esm/read-password.js

@@ -0,0 +1,33 @@
+import { error } from '@vltpkg/error-cause';
+export const readPassword = async (prompt, { stdin, stdout } = process) => {
+    let input = '';
+    stdout.write(prompt);
+    stdin.setRawMode(true);
+    await new Promise((res, rej) => {
+        stdin.on('data', (c) => {
+            // backspace
+            if (c.length === 1 && c[0] === 0x7f) {
+                input = input.substring(0, input.length - 1);
+                stdout.write('\x1b[1D \x1b[1D');
+                return;
+            }
+            input += String(c);
+            if (/\r|\n|\x04|\x03/.test(input)) {
+                input = input.replace(/(\r|\n|\x04|\x03)/g, '');
+                stdin.setRawMode(false);
+                stdin.pause();
+                // x03 === ^C
+                if (c[c.length - 1] === 3) {
+                    rej(error('canceled', { signal: 'SIGINT' }));
+                }
+                else
+                    res();
+            }
+            else {
+                stdout.write('*'.repeat(c.length));
+            }
+        });
+    });
+    return input;
+};
+//# sourceMappingURL=read-password.js.map

package/dist/esm/read-password.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-password.js","sourceRoot":"","sources":["../../src/read-password.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAO3C,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,MAAc,EACd,EAAE,KAAK,EAAE,MAAM,KAAc,OAAO,EACnB,EAAE;IACnB,IAAI,KAAK,GAAG,EAAE,CAAA;IACd,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IACpB,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;IACtB,MAAM,IAAI,OAAO,CAAO,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACnC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAS,EAAE,EAAE;YAC7B,YAAY;YACZ,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBACpC,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;gBAC5C,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAA;gBAC/B,OAAM;YACR,CAAC;YAED,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAA;YAClB,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAA;gBAC/C,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;gBACvB,KAAK,CAAC,KAAK,EAAE,CAAA;gBACb,aAAa;gBACb,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC1B,GAAG,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAA;gBAC9C,CAAC;;oBAAM,GAAG,EAAE,CAAA;YACd,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;YACpC,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,OAAO,KAAK,CAAA;AACd,CAAC,CAAA","sourcesContent":["import { error } from '@vltpkg/error-cause'\n\nexport type Streams = {\n  stdin: NodeJS.ReadableStream & { setRawMode(mode: boolean): void }\n  stdout: NodeJS.WritableStream\n}\n\nexport const readPassword = async (\n  prompt: string,\n  { stdin, stdout }: Streams = process,\n): Promise<string> => {\n  let input = ''\n  stdout.write(prompt)\n  stdin.setRawMode(true)\n  await new Promise<void>((res, rej) => {\n    stdin.on('data', (c: Buffer) => {\n      // backspace\n      if (c.length === 1 && c[0] === 0x7f) {\n        input = input.substring(0, input.length - 1)\n        stdout.write('\\x1b[1D \\x1b[1D')\n        return\n      }\n\n      input += String(c)\n      if (/\\r|\\n|\\x04|\\x03/.test(input)) {\n        input = input.replace(/(\\r|\\n|\\x04|\\x03)/g, '')\n        stdin.setRawMode(false)\n        stdin.pause()\n        // x03 === ^C\n        if (c[c.length - 1] === 3) {\n          rej(error('canceled', { signal: 'SIGINT' }))\n        } else res()\n      } else {\n        stdout.write('*'.repeat(c.length))\n      }\n    })\n  })\n  return input\n}\n"]}

package/dist/esm/start-gui.d.ts

@@ -0,0 +1,9 @@
+import type { PathScurry } from 'path-scurry';
+import type { LoadedConfig } from './config/index.ts';
+export declare const getDefaultStartingRoute: (options: {
+    startingRoute?: string;
+    projectRoot: string;
+    scurry: PathScurry;
+}) => Promise<string>;
+export declare const startGUI: (conf: LoadedConfig, startingRoute?: string) => Promise<import("@vltpkg/server").VltServer>;
+//# sourceMappingURL=start-gui.d.ts.map

package/dist/esm/start-gui.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-gui.d.ts","sourceRoot":"","sources":["../../src/start-gui.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAIrD,eAAO,MAAM,uBAAuB,YAAmB;IACrD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,UAAU,CAAA;CACnB,oBAOA,CAAA;AAaD,eAAO,MAAM,QAAQ,SACb,YAAY,kBACF,MAAM,gDAuBvB,CAAA"}

package/dist/esm/start-gui.js

@@ -0,0 +1,40 @@
+import { createServer } from '@vltpkg/server';
+import { urlOpen } from '@vltpkg/url-open';
+import { stdout } from "./output.js";
+import { resolve } from 'node:path';
+export const getDefaultStartingRoute = async (options) => {
+    const { startingRoute, projectRoot, scurry } = options;
+    if (startingRoute)
+        return startingRoute;
+    const stat = await scurry.lstat(`${projectRoot}/package.json`);
+    return stat?.isFile() && !stat.isSymbolicLink() ?
+        `/explore?query=${encodeURIComponent(':root')}`
+        : '/';
+};
+const getAssetsDir = () => {
+    /* c8 ignore start */
+    if (process.env.__VLT_INTERNAL_GUI_ASSETS_DIR) {
+        return resolve(import.meta.dirname, process.env.__VLT_INTERNAL_GUI_ASSETS_DIR);
+    }
+    /* c8 ignore stop */
+};
+export const startGUI = async (conf, startingRoute) => {
+    const server = createServer({
+        ...conf.options,
+        assetsDir: getAssetsDir(),
+    });
+    server.on('needConfigUpdate', dir => {
+        conf.resetOptions(dir);
+        server.updateOptions(conf.options);
+    });
+    const { projectRoot, scurry } = conf.options;
+    await server.start();
+    stdout(`⚡️ vlt GUI running at ${server.address()}`);
+    void urlOpen(server.address(await getDefaultStartingRoute({
+        startingRoute,
+        projectRoot,
+        scurry,
+    })));
+    return server;
+};
+//# sourceMappingURL=start-gui.js.map

package/dist/esm/start-gui.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-gui.js","sourceRoot":"","sources":["../../src/start-gui.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAG1C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAAE,OAI7C,EAAE,EAAE;IACH,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;IACtD,IAAI,aAAa;QAAE,OAAO,aAAa,CAAA;IACvC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,GAAG,WAAW,eAAe,CAAC,CAAA;IAC9D,OAAO,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;QAC7C,kBAAkB,kBAAkB,CAAC,OAAO,CAAC,EAAE;QACjD,CAAC,CAAC,GAAG,CAAA;AACT,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,GAAG,EAAE;IACxB,qBAAqB;IACrB,IAAI,OAAO,CAAC,GAAG,CAAC,6BAA6B,EAAE,CAAC;QAC9C,OAAO,OAAO,CACZ,MAAM,CAAC,IAAI,CAAC,OAAO,EACnB,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAC1C,CAAA;IACH,CAAC;IACD,oBAAoB;AACtB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAC3B,IAAkB,EAClB,aAAsB,EACtB,EAAE;IACF,MAAM,MAAM,GAAG,YAAY,CAAC;QAC1B,GAAG,IAAI,CAAC,OAAO;QACf,SAAS,EAAE,YAAY,EAAE;KAC1B,CAAC,CAAA;IACF,MAAM,CAAC,EAAE,CAAC,kBAAkB,EAAE,GAAG,CAAC,EAAE;QAClC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CACrB;QAAC,MAA6B,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC7D,CAAC,CAAC,CAAA;IACF,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;IAC5C,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;IACpB,MAAM,CAAC,yBAAyB,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IACnD,KAAK,OAAO,CACV,MAAM,CAAC,OAAO,CACZ,MAAM,uBAAuB,CAAC;QAC5B,aAAa;QACb,WAAW;QACX,MAAM;KACP,CAAC,CACH,CACF,CAAA;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA","sourcesContent":["import type { VltServerListening } from '@vltpkg/server'\nimport { createServer } from '@vltpkg/server'\nimport { urlOpen } from '@vltpkg/url-open'\nimport type { PathScurry } from 'path-scurry'\nimport type { LoadedConfig } from './config/index.ts'\nimport { stdout } from './output.ts'\nimport { resolve } from 'node:path'\n\nexport const getDefaultStartingRoute = async (options: {\n  startingRoute?: string\n  projectRoot: string\n  scurry: PathScurry\n}) => {\n  const { startingRoute, projectRoot, scurry } = options\n  if (startingRoute) return startingRoute\n  const stat = await scurry.lstat(`${projectRoot}/package.json`)\n  return stat?.isFile() && !stat.isSymbolicLink() ?\n      `/explore?query=${encodeURIComponent(':root')}`\n    : '/'\n}\n\nconst getAssetsDir = () => {\n  /* c8 ignore start */\n  if (process.env.__VLT_INTERNAL_GUI_ASSETS_DIR) {\n    return resolve(\n      import.meta.dirname,\n      process.env.__VLT_INTERNAL_GUI_ASSETS_DIR,\n    )\n  }\n  /* c8 ignore stop */\n}\n\nexport const startGUI = async (\n  conf: LoadedConfig,\n  startingRoute?: string,\n) => {\n  const server = createServer({\n    ...conf.options,\n    assetsDir: getAssetsDir(),\n  })\n  server.on('needConfigUpdate', dir => {\n    conf.resetOptions(dir)\n    ;(server as VltServerListening).updateOptions(conf.options)\n  })\n  const { projectRoot, scurry } = conf.options\n  await server.start()\n  stdout(`⚡️ vlt GUI running at ${server.address()}`)\n  void urlOpen(\n    server.address(\n      await getDefaultStartingRoute({\n        startingRoute,\n        projectRoot,\n        scurry,\n      }),\n    ),\n  )\n  return server\n}\n"]}

package/dist/esm/view.d.ts

@@ -0,0 +1,30 @@
+import type { LoadedConfig } from './config/index.ts';
+export type ViewOptions = {
+    colors?: boolean;
+};
+/**
+ * The base class for all View classes
+ *
+ * Do not override the constructor, just provide start/done/error methods.
+ *
+ * These classes should be used as one or more of the exported views for
+ * commands that need to know when the processing starts, handle errors in
+ * various ways, etc. Fancy stuff.
+ *
+ * For simple use cases, usually better to create a {@link ViewFn} instead.
+ */
+export declare class ViewClass<T = unknown> {
+    options: ViewOptions;
+    config: LoadedConfig;
+    constructor(options: ViewOptions, config: LoadedConfig);
+    start(): void;
+    done(_result: T, _opts: {
+        time: number;
+    }): unknown;
+    error(_err: unknown): void;
+}
+export type ViewFn<T = unknown> = (result: T, options: ViewOptions, conf: LoadedConfig) => unknown;
+export type View<T = unknown> = ViewFn<T> | typeof ViewClass<T>;
+export declare const isViewClass: <T = unknown>(view: View<T>) => view is typeof ViewClass<T>;
+export type Views<T = unknown> = View<T> | Record<string, View<T>>;
+//# sourceMappingURL=view.d.ts.map

package/dist/esm/view.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/view.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,MAAM,WAAW,GAAG;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAE9C;;;;;;;;;;GAUG;AACH,qBAAa,SAAS,CAAC,CAAC,GAAG,OAAO;IAChC,OAAO,EAAE,WAAW,CAAA;IACpB,MAAM,EAAE,YAAY,CAAA;gBAER,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY;IAQtD,KAAK;IACL,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO;IAGlD,KAAK,CAAC,IAAI,EAAE,OAAO;CACpB;AAED,MAAM,MAAM,MAAM,CAAC,CAAC,GAAG,OAAO,IAAI,CAChC,MAAM,EAAE,CAAC,EACT,OAAO,EAAE,WAAW,EACpB,IAAI,EAAE,YAAY,KACf,OAAO,CAAA;AAEZ,MAAM,MAAM,IAAI,CAAC,CAAC,GAAG,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,SAAS,CAAC,CAAC,CAAC,CAAA;AAE/D,eAAO,MAAM,WAAW,GAAI,CAAC,kBACrB,IAAI,CAAC,CAAC,CAAC,KACZ,IAAI,IAAI,OAAO,SAAS,CAAC,CAAC,CAGQ,CAAA;AAErC,MAAM,MAAM,KAAK,CAAC,CAAC,GAAG,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA"}

package/dist/esm/view.js

@@ -0,0 +1,31 @@
+/**
+ * The base class for all View classes
+ *
+ * Do not override the constructor, just provide start/done/error methods.
+ *
+ * These classes should be used as one or more of the exported views for
+ * commands that need to know when the processing starts, handle errors in
+ * various ways, etc. Fancy stuff.
+ *
+ * For simple use cases, usually better to create a {@link ViewFn} instead.
+ */
+export class ViewClass {
+    options;
+    config;
+    constructor(options, config) {
+        this.options = options;
+        this.config = config;
+    }
+    // TODO: maybe have start() return a flag to say "i got this, do not
+    // run the command", for example to have the gui just open a web browser
+    // to the page relevant to a given thing, rather than computing it twice
+    start() { }
+    done(_result, _opts) {
+        return;
+    }
+    error(_err) { }
+}
+export const isViewClass = (view) => typeof view === 'function' &&
+    'prototype' in view &&
+    view.prototype instanceof ViewClass;
+//# sourceMappingURL=view.js.map

package/dist/esm/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../src/view.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;GAUG;AACH,MAAM,OAAO,SAAS;IACpB,OAAO,CAAa;IACpB,MAAM,CAAc;IAEpB,YAAY,OAAoB,EAAE,MAAoB;QACpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,oEAAoE;IACpE,wEAAwE;IACxE,wEAAwE;IACxE,KAAK,KAAI,CAAC;IACV,IAAI,CAAC,OAAU,EAAE,KAAuB;QACtC,OAAM;IACR,CAAC;IACD,KAAK,CAAC,IAAa,IAAG,CAAC;CACxB;AAUD,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,IAAa,EACgB,EAAE,CAC/B,OAAO,IAAI,KAAK,UAAU;IAC1B,WAAW,IAAI,IAAI;IACnB,IAAI,CAAC,SAAS,YAAY,SAAS,CAAA","sourcesContent":["import type { LoadedConfig } from './config/index.ts'\n\nexport type ViewOptions = { colors?: boolean }\n\n/**\n * The base class for all View classes\n *\n * Do not override the constructor, just provide start/done/error methods.\n *\n * These classes should be used as one or more of the exported views for\n * commands that need to know when the processing starts, handle errors in\n * various ways, etc. Fancy stuff.\n *\n * For simple use cases, usually better to create a {@link ViewFn} instead.\n */\nexport class ViewClass<T = unknown> {\n  options: ViewOptions\n  config: LoadedConfig\n\n  constructor(options: ViewOptions, config: LoadedConfig) {\n    this.options = options\n    this.config = config\n  }\n\n  // TODO: maybe have start() return a flag to say \"i got this, do not\n  // run the command\", for example to have the gui just open a web browser\n  // to the page relevant to a given thing, rather than computing it twice\n  start() {}\n  done(_result: T, _opts: { time: number }): unknown {\n    return\n  }\n  error(_err: unknown) {}\n}\n\nexport type ViewFn<T = unknown> = (\n  result: T,\n  options: ViewOptions,\n  conf: LoadedConfig,\n) => unknown\n\nexport type View<T = unknown> = ViewFn<T> | typeof ViewClass<T>\n\nexport const isViewClass = <T = unknown>(\n  view: View<T>,\n): view is typeof ViewClass<T> =>\n  typeof view === 'function' &&\n  'prototype' in view &&\n  view.prototype instanceof ViewClass\n\nexport type Views<T = unknown> = View<T> | Record<string, View<T>>\n"]}