@sous-io/sous 0.2.36 → 1.0.1

package/src/commands/lock/show.ts

@@ -1,115 +0,0 @@
-/**
- * `sous lock show`.
- *
- * Prints the lockfile: every recipe this project pins, the version and the
- * repository it is pinned to, and who holds it. It reads the file and nothing
- * else, so it works offline and never writes.
- */
-
-import { BaseCommand } from "../../base-command.js";
-import { subscriptionServiceFor } from "../../lib/repos/subscription-service.js";
-import { PROJECT_HOLDER } from "../../lib/repos/formats/lockfile.js";
-import { renderTable, type TableColumn } from "../../utils/table.js";
-import {
-  blankLine,
-  footer,
-  heading,
-  indent,
-  log,
-  paragraph,
-  showCommandVars,
-} from "../../utils/formatting.js";
-
-/** How far every line of this command's output is indented. */
-const INDENT = 2;
-
-/**
- * The columns the listing shows. The recipe and the version it is pinned at are
- * what a lockfile is for, so they stay whatever the terminal's width; the list
- * of holders takes the room that is left and wraps rather than being cut.
- */
-const COLUMNS: TableColumn[] = [
-  { key: "key", header: "Recipe", kind: "path", overflow: "truncate", minWidth: 12 },
-  { key: "version", header: "Version", overflow: "truncate", minWidth: 7 },
-  { key: "repo", header: "Repository", overflow: "truncate", priority: "medium" },
-  {
-    key: "heldBy",
-    header: "Held by",
-    overflow: "wrap",
-    flex: 1,
-    priority: "low",
-    minWidth: 16,
-  },
-];
-
-export default class LockShow extends BaseCommand {
-  static description = "Show every recipe version this project's lockfile pins";
-
-  /**
-   * The other spelling of the topic. It lives under a hidden topic, so it is
-   * typable everywhere without ever reaching the top-level listing.
-   */
-  static aliases = ["locks:show"];
-
-  static examples = ["<%= config.bin %> lock show"];
-
-  static flags = { ...BaseCommand.baseFlags };
-
-  async run(): Promise<void> {
-    await this.parse(LockShow);
-
-    showCommandVars({
-      Project: this.projectLabel,
-      Config: this.configContext.configPath,
-    });
-
-    const service = subscriptionServiceFor({
-      configContext: this.configContext,
-      settings: this.settings,
-      shellEnv: this.shellEnv,
-    });
-
-    const lock = service.lockService.read();
-    const keys = Object.keys(lock.recipes).sort();
-
-    heading("Recipe versions this project pins");
-    blankLine();
-
-    if (keys.length === 0) {
-      paragraph(
-        `This project pins nothing yet. Its lockfile is ${service.lockService.filePath}.`
-      );
-      footer();
-      return;
-    }
-
-    const rows = keys.map((key) => {
-      const entry = lock.recipes[key]!;
-      return {
-        key,
-        version: entry.version,
-        repo: entry.repo,
-        heldBy: entry.requestedBy.map(describeHolder).join(", "),
-      };
-    });
-
-    for (const line of renderTable(COLUMNS, rows, { indent: INDENT })) {
-      log(indent(line, INDENT));
-    }
-
-    blankLine();
-    paragraph(`This project's lockfile is ${service.lockService.filePath}.`);
-
-    footer();
-  }
-}
-
-/**
- * Plain-language wording for one holder of a locked recipe: the project itself,
- * or the recipe that requires it.
- *
- * @param holder - What the lockfile recorded.
- */
-function describeHolder(holder: string): string {
-  return holder === PROJECT_HOLDER ? "this project" : holder;
-}

package/src/commands/namespace/list.ts

@@ -1,138 +0,0 @@
-/**
- * `sous namespace list`.
- *
- * Shows every namespace published by the repositories this project trusts, how
- * many recipes each one holds, and how much of it the project subscribes to. It
- * reads only the indexes sous already has on disk by default, so it works
- * offline; a repository whose index has never been fetched is named at the end
- * rather than being silently left out. `--latest` reads the indexes from
- * upstream instead, without saving them, and `--installed` narrows the listing
- * to the namespaces the lockfile pins a recipe from.
- */
-
-import { BaseCommand } from "../../base-command.js";
-import { subscriptionServiceFor } from "../../lib/repos/subscription-service.js";
-import { loadCatalogContext } from "../../lib/repos/catalog-inputs.js";
-import { listNamespaces, narrowToInstalled } from "../../lib/repos/catalog.js";
-import {
-  INDENT,
-  describeCoverage,
-  describeIndexSource,
-  printBrowsingNotes,
-} from "../../lib/repos/catalog-display.js";
-import { renderTable, type TableColumn } from "../../utils/table.js";
-import { browsingFlags } from "../../utils/flags.js";
-import {
-  blankLine,
-  footer,
-  heading,
-  indent,
-  log,
-  paragraph,
-  showCommandVars,
-} from "../../utils/formatting.js";
-
-/**
- * The columns the listing shows. The namespace and what a project has of it are
- * the point of the command, so they stay whatever the terminal's width; the
- * description takes the room that is left and wraps rather than being cut.
- */
-const COLUMNS: TableColumn[] = [
-  { key: "namespace", header: "Namespace", overflow: "truncate", minWidth: 10 },
-  { key: "repo", header: "Repository", overflow: "truncate", priority: "medium" },
-  { key: "recipes", header: "Recipes", kind: "number", priority: "medium" },
-  { key: "subscribed", header: "Subscribed", priority: "medium" },
-  {
-    key: "description",
-    header: "What it is",
-    overflow: "wrap",
-    flex: 1,
-    priority: "low",
-    minWidth: 16,
-  },
-];
-
-export default class NamespaceList extends BaseCommand {
-  static description = "List the namespaces the repositories this project trusts publish";
-
-  /**
-   * The other spelling of the topic. It lives under a hidden topic, so it is
-   * typable everywhere without ever reaching the top-level listing.
-   */
-  static aliases = ["namespaces:list"];
-
-  static examples = [
-    "<%= config.bin %> namespace list",
-    "<%= config.bin %> namespace list --installed",
-  ];
-
-  static flags = { ...BaseCommand.baseFlags, ...browsingFlags() };
-
-  async run(): Promise<void> {
-    const { flags } = await this.parse(NamespaceList);
-
-    showCommandVars({
-      Project: this.projectLabel,
-      Config: this.configContext.configPath,
-      Reading: describeIndexSource(flags.latest),
-      ...(flags.installed ? { Showing: "only what this project has installed" } : {}),
-    });
-
-    heading(
-      flags.installed
-        ? "Namespaces this project has installed recipes from"
-        : "Namespaces in the repositories this project trusts"
-    );
-
-    const service = subscriptionServiceFor({
-      configContext: this.configContext,
-      settings: this.settings,
-      shellEnv: this.shellEnv,
-    });
-
-    const { inputs, notFetched, notChecked } = await loadCatalogContext({
-      service,
-      sousDir: this.configContext.sousDir,
-      settings: this.settings,
-      latest: flags.latest,
-    });
-
-    // Narrowed to what is installed, a namespace's recipe count is the number
-    // of its recipes the project has installed, and the column says so.
-    const listings = listNamespaces(flags.installed ? narrowToInstalled(inputs) : inputs);
-    const columns = flags.installed
-      ? COLUMNS.map((column) =>
-          column.key === "recipes" ? { ...column, header: "Installed" } : column
-        )
-      : COLUMNS;
-
-    blankLine();
-
-    if (listings.length === 0) {
-      paragraph(
-        inputs.repos.length === 0
-          ? "Sous has read no repository index for this project, so there are no " +
-            "namespaces to show."
-          : flags.installed
-            ? "This project has installed no recipe from the repositories it trusts."
-            : "The repositories this project trusts publish no namespaces."
-      );
-    } else {
-      const rows = listings.map((entry) => ({
-        namespace: entry.namespace,
-        repo: entry.repo,
-        recipes: String(entry.recipeCount),
-        subscribed: describeCoverage(entry.subscribed),
-        description: entry.description ?? "no description published",
-      }));
-
-      for (const line of renderTable(columns, rows, { indent: INDENT })) {
-        log(indent(line, INDENT));
-      }
-    }
-
-    printBrowsingNotes({ notFetched, notChecked });
-
-    footer();
-  }
-}

package/src/commands/namespace/show.ts

@@ -1,130 +0,0 @@
-/**
- * `sous namespace show <ref>`.
- *
- * Shows one namespace in full: the repository publishing it, what that
- * repository says it is for, how much of it this project subscribes to, and
- * every recipe in it with its latest version, its pinned version and its own
- * subscription state. It reads only the indexes sous already has on disk,
- * unless `--latest` asks it to read upstream (which saves nothing); `--installed`
- * narrows the recipes to the ones the lockfile pins.
- */
-
-import { Args } from "@oclif/core";
-import { BaseCommand } from "../../base-command.js";
-import { subscriptionServiceFor } from "../../lib/repos/subscription-service.js";
-import { loadCatalogContext } from "../../lib/repos/catalog-inputs.js";
-import { describeInstalled, describeNamespace } from "../../lib/repos/catalog.js";
-import {
-  INDENT,
-  describeCoverage,
-  describeIndexSource,
-  factIf,
-  printBrowsingNotes,
-  printFacts,
-  recipeColumns,
-  recipeRows,
-} from "../../lib/repos/catalog-display.js";
-import { renderTable } from "../../utils/table.js";
-import { browsingFlags } from "../../utils/flags.js";
-import {
-  blankLine,
-  footer,
-  heading,
-  indent,
-  log,
-  paragraph,
-  showCommandVars,
-  subheading,
-} from "../../utils/formatting.js";
-
-export default class NamespaceShow extends BaseCommand {
-  static description = "Show one namespace and every recipe the repository publishes in it";
-
-  /**
-   * The other spelling of the topic. It lives under a hidden topic, so it is
-   * typable everywhere without ever reaching the top-level listing.
-   */
-  static aliases = ["namespaces:show"];
-
-  static examples = [
-    "<%= config.bin %> namespace show workflow",
-    "<%= config.bin %> namespace show sous-recipes:core",
-  ];
-
-  static args = {
-    ref: Args.string({
-      description: "A namespace, optionally written as 'repository:namespace'",
-      required: true,
-    }),
-  };
-
-  static flags = { ...BaseCommand.baseFlags, ...browsingFlags() };
-
-  async run(): Promise<void> {
-    const { args, flags } = await this.parse(NamespaceShow);
-
-    showCommandVars({
-      Project: this.projectLabel,
-      Config: this.configContext.configPath,
-      Namespace: args.ref,
-      Reading: describeIndexSource(flags.latest),
-      ...(flags.installed ? { Showing: "only what this project has installed" } : {}),
-    });
-
-    const service = subscriptionServiceFor({
-      configContext: this.configContext,
-      settings: this.settings,
-      shellEnv: this.shellEnv,
-    });
-
-    const { inputs, notChecked } = await loadCatalogContext({
-      service,
-      sousDir: this.configContext.sousDir,
-      settings: this.settings,
-      latest: flags.latest,
-    });
-
-    const detail = flags.installed
-      ? await describeInstalled(inputs, args.ref, describeNamespace, "namespace")
-      : await describeNamespace(inputs, args.ref);
-
-    heading(`The namespace ${detail.namespace}`);
-    blankLine();
-
-    printFacts([
-      { label: "Repository", lines: [detail.repo] },
-      ...factIf("Location", detail.repoUrl),
-      ...factIf("About", detail.description),
-      {
-        label: flags.installed ? "Installed recipes" : "Recipes",
-        lines: [String(detail.recipes.length)],
-      },
-      { label: "Subscribed", lines: [describeCoverage(detail.subscribed)] },
-    ]);
-
-    blankLine();
-    subheading(`Recipes in ${detail.namespace}`);
-    blankLine();
-
-    if (detail.recipes.length === 0) {
-      paragraph(`The repository ${detail.repo} publishes no recipes in this namespace.`);
-      footer();
-      return;
-    }
-
-    for (const line of renderTable(
-      recipeColumns({ installed: flags.installed }),
-      recipeRows(detail.recipes),
-      { indent: INDENT }
-    )) {
-      log(indent(line, INDENT));
-    }
-
-    printBrowsingNotes({
-      notChecked: notChecked.filter((name) => name === detail.repo),
-      anyLinked: detail.recipes.some((entry) => entry.linkedPath !== undefined),
-    });
-
-    footer();
-  }
-}

package/src/commands/prune.ts

@@ -1,43 +0,0 @@
-import { Flags } from "@oclif/core";
-import { BaseCommand } from "../base-command.js";
-import { runProjectBuild } from "../lib/build-service.js";
-import { showCommandVars } from "../utils/formatting.js";
-
-export default class Prune extends BaseCommand {
-  static description = "Remove output files that are no longer in the current config";
-
-  static examples = [
-    "<%= config.bin %> prune",
-    "<%= config.bin %> prune --dry-run",
-  ];
-
-  static flags = {
-    ...BaseCommand.baseFlags,
-    "dry-run": Flags.boolean({
-      description: "Print what would be pruned without deleting",
-      default: false,
-    }),
-  };
-
-  async run(): Promise<void> {
-    const { flags } = await this.parse(Prune);
-
-    showCommandVars({
-      Project: this.projectLabel,
-      Config: this.configContext.configPath,
-      "Dry Run": flags["dry-run"],
-    });
-
-    // Prune goes through the same build path as everything else, with the
-    // compile step switched off: what counts as current depends on the recipes
-    // the lockfile pins, so they are restored first, or a recipe missing from
-    // the store would have its outputs pruned as if it were gone.
-    await runProjectBuild({
-      settings: this.settings,
-      configContext: this.configContext,
-      shellEnv: this.shellEnv,
-      heading: "Pruning",
-      options: { noCompile: true, dryRun: flags["dry-run"] },
-    });
-  }
-}

package/src/commands/recipe/list.ts

@@ -1,112 +0,0 @@
-/**
- * `sous recipe list`.
- *
- * Shows every recipe the repositories this project trusts publish, with the
- * latest published version, the version this project pins, and whether it is
- * subscribed. By default it reads only the indexes sous already has on disk, so
- * it works offline; a repository whose index has never been fetched is named at
- * the end rather than being silently left out. `--latest` reads the indexes
- * from upstream instead, without saving them, and `--installed` narrows the
- * listing to what the lockfile pins.
- */
-
-import { BaseCommand } from "../../base-command.js";
-import { subscriptionServiceFor } from "../../lib/repos/subscription-service.js";
-import { loadCatalogContext } from "../../lib/repos/catalog-inputs.js";
-import { listRecipes, narrowToInstalled } from "../../lib/repos/catalog.js";
-import {
-  INDENT,
-  describeIndexSource,
-  printBrowsingNotes,
-  recipeColumns,
-  recipeRows,
-} from "../../lib/repos/catalog-display.js";
-import { renderTable } from "../../utils/table.js";
-import { browsingFlags } from "../../utils/flags.js";
-import {
-  blankLine,
-  footer,
-  heading,
-  indent,
-  log,
-  paragraph,
-  showCommandVars,
-} from "../../utils/formatting.js";
-
-export default class RecipeList extends BaseCommand {
-  static description = "List the recipes the repositories this project trusts publish";
-
-  /**
-   * The other spelling of the topic. It lives under a hidden topic, so it is
-   * typable everywhere without ever reaching the top-level listing.
-   */
-  static aliases = ["recipes:list"];
-
-  static examples = [
-    "<%= config.bin %> recipe list",
-    "<%= config.bin %> recipe list --installed --latest",
-  ];
-
-  static flags = { ...BaseCommand.baseFlags, ...browsingFlags() };
-
-  async run(): Promise<void> {
-    const { flags } = await this.parse(RecipeList);
-
-    showCommandVars({
-      Project: this.projectLabel,
-      Config: this.configContext.configPath,
-      Reading: describeIndexSource(flags.latest),
-      ...(flags.installed ? { Showing: "only what this project has installed" } : {}),
-    });
-
-    heading(
-      flags.installed
-        ? "Recipes this project has installed"
-        : "Recipes in the repositories this project trusts"
-    );
-
-    const service = subscriptionServiceFor({
-      configContext: this.configContext,
-      settings: this.settings,
-      shellEnv: this.shellEnv,
-    });
-
-    const { inputs, notFetched, notChecked } = await loadCatalogContext({
-      service,
-      sousDir: this.configContext.sousDir,
-      settings: this.settings,
-      latest: flags.latest,
-    });
-
-    const listings = listRecipes(flags.installed ? narrowToInstalled(inputs) : inputs);
-
-    blankLine();
-
-    if (listings.length === 0) {
-      paragraph(
-        inputs.repos.length === 0
-          ? "Sous has read no repository index for this project, so there are no " +
-            "recipes to show."
-          : flags.installed
-            ? "This project has installed no recipe from the repositories it trusts."
-            : "The repositories this project trusts publish no recipes."
-      );
-    } else {
-      for (const line of renderTable(
-        recipeColumns({ installed: flags.installed }),
-        recipeRows(listings),
-        { indent: INDENT }
-      )) {
-        log(indent(line, INDENT));
-      }
-    }
-
-    printBrowsingNotes({
-      notFetched,
-      notChecked,
-      anyLinked: listings.some((entry) => entry.linkedPath !== undefined),
-    });
-
-    footer();
-  }
-}