@sous-io/sous 0.2.37 → 1.0.2

package/src/commands/repo/remove.ts

@@ -1,194 +0,0 @@
-/**
- * `sous repo remove <name>`: stop trusting a repository.
- *
- * The exact reverse of adding one. Adding a repository IS trusting it, so
- * removing the entry is how that trust is withdrawn, and everything the project
- * held through it goes with it: every subscription that resolves into it, every
- * recipe those subscriptions alone held, and the files those recipes compiled.
- *
- * Informed consent, never prevention: the command prints all of that before it
- * writes anything, asks once, and then does exactly what it described. The
- * checkout behind a link is never deleted, because it is somebody's working
- * copy and sous did not necessarily put it there.
- */
-
-import { Args, Flags } from "@oclif/core";
-import { BaseCommand } from "../../base-command.js";
-import { runProjectBuild } from "../../lib/build-service.js";
-import { ConfigError } from "../../lib/errors.js";
-import { resolveRootScope } from "../../lib/settings.js";
-import { subscriptionServiceFor } from "../../lib/repos/subscription-service.js";
-import { confirmationFlag } from "../../utils/flags.js";
-import { renderTable, type TableColumn } from "../../utils/table.js";
-import {
-  blankLine,
-  dryRunNotice,
-  footer,
-  heading,
-  indent,
-  log,
-  showCommandVars,
-  subheading,
-} from "../../utils/formatting.js";
-
-/** How far every line of this command's output is indented. */
-const INDENT = 2;
-
-/** The columns the report of what stayed behind shows. */
-const STAYED_COLUMNS: TableColumn[] = [
-  { key: "key", header: "Recipe", kind: "path", overflow: "truncate", minWidth: 12 },
-  { key: "heldBy", header: "Still held by", overflow: "wrap", flex: 1, minWidth: 16 },
-];
-
-export default class RepoRemove extends BaseCommand {
-  static description = "Stop trusting a repository, and remove everything it brought in";
-
-  /**
-   * 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 = ["repos:remove"];
-
-  static examples = [
-    "<%= config.bin %> repo remove my-recipes",
-    "<%= config.bin %> repo remove my-recipes --dry-run",
-    "<%= config.bin %> repo remove my-recipes --yes",
-  ];
-
-  static args = {
-    repo: Args.string({
-      description: "The repository's short name, as this project records it",
-      required: true,
-    }),
-  };
-
-  static flags = {
-    ...BaseCommand.baseFlags,
-    // The only question this command asks is whether to go ahead with what it
-    // has just described, so the shared confirmation flag answers it.
-    yes: confirmationFlag(),
-    "dry-run": Flags.boolean({
-      description: "Print what would be removed without writing anything",
-      default: false,
-    }),
-    "no-build": Flags.boolean({
-      description: "Remove the repository without rebuilding the project",
-      default: false,
-    }),
-  };
-
-  async run(): Promise<void> {
-    const { args, flags } = await this.parse(RepoRemove);
-    const dryRun = flags["dry-run"];
-
-    showCommandVars({
-      Project: this.projectLabel,
-      Config: this.configContext.configPath,
-      Repository: args.repo,
-      "Dry Run": dryRun,
-    });
-
-    // The heading is not followed by a blank line here: the plan that comes
-    // next opens with one of its own.
-    heading("Removing a repository");
-
-    if (dryRun) dryRunNotice("Nothing will be written.");
-
-    const service = subscriptionServiceFor({
-      configContext: this.configContext,
-      settings: this.settings,
-      shellEnv: this.shellEnv,
-    });
-
-    const outcome = await service.removeRepo({
-      name: args.repo,
-      yes: flags.yes,
-      dryRun,
-      // The output files a removed recipe wrote can only be named once the
-      // `recipes.skills.outputs` destinations have had their variables substituted.
-      scope: resolveRootScope(this.settings, this.configContext),
-    });
-
-    blankLine();
-    subheading("Lockfile");
-    blankLine();
-    if (outcome.diff.unchanged) {
-      log(indent("Nothing changed; nothing was locked because of this repository."));
-    } else {
-      for (const line of outcome.diff.lines) log(indent(line));
-    }
-
-    if (outcome.stayed.length > 0) {
-      blankLine();
-      subheading("What stayed, and why");
-      blankLine();
-      const rows = outcome.stayed.map((entry) => ({
-        key: entry.key,
-        heldBy: entry.heldBy.join(", "),
-      }));
-
-      for (const line of renderTable(STAYED_COLUMNS, rows, { indent: INDENT })) {
-        log(indent(line, INDENT));
-      }
-    }
-
-    const rebuilding = !dryRun && !flags["no-build"];
-
-    // The closing sentence names the build only when this run is not about to
-    // do it, so nobody is told to run a command that is already running.
-    const pruneHint = rebuilding
-      ? ``
-      : ` Run 'sous build' to prune what it used to write.`;
-
-    blankLine();
-    log(
-      indent(
-        dryRun
-          ? "Nothing was written. Run the same command without '--dry-run' to remove it."
-          : outcome.optedOut
-            ? `The repository '${outcome.name}' is one sous provides itself, so it was ` +
-              `switched off rather than deleted: this project's config now records ` +
-              `'${outcome.name}: { enabled: false }'.${pruneHint}`
-            : `This project no longer trusts '${outcome.name}'. Nothing is read from it ` +
-              `any more, and its entry is gone from the repositories layer.${pruneHint}`
-      )
-    );
-
-    footer();
-
-    if (rebuilding) await this.rebuildProject(outcome.name);
-  }
-
-  /**
-   * Rebuilds the project now that the repository has been removed, so the files
-   * its recipes used to contribute are pruned before this command returns.
-   *
-   * The repositories and subscriptions both live in managed `conf.d/` layers, so
-   * the settings loaded when this command started no longer describe the
-   * project; they are reloaded before the build, or it would compile the old
-   * recipe set straight back onto disk. A build that fails leaves the removal in
-   * place, because it is already written and locked; the message says so and
-   * names the command to run once the cause is fixed.
-   *
-   * @param name - The repository that was just removed, for the failure message.
-   */
-  private async rebuildProject(name: string): Promise<void> {
-    await this.reloadDiscoveredConfig();
-
-    const succeeded = await runProjectBuild({
-      settings: this.settings,
-      configContext: this.configContext,
-      shellEnv: this.shellEnv,
-      heading: "Building the project",
-    });
-
-    if (!succeeded) {
-      throw new ConfigError(
-        `The repository '${name}' was removed, but the build that followed it failed, ` +
-          `so this project may still hold files its recipes used to write. The removal ` +
-          `itself is recorded and locked; fix what the build reported above and run ` +
-          `'sous build' again.`
-      );
-    }
-  }
-}

package/src/commands/repo/search.ts

@@ -1,243 +0,0 @@
-/**
- * `sous repo search <text>`.
- *
- * Searches the cached index of every repository this project trusts: recipe
- * names, namespace names and descriptions. By default it reads only what is
- * already on disk, so it works offline and never downloads anything; a
- * repository whose index has not been fetched yet is named at the end rather
- * than silently left out of the results. `--latest` searches each index as
- * upstream serves it, saving nothing, and `--installed` searches only the
- * recipes the lockfile pins, showing the installed version.
- */
-
-import { Args, Flags } from "@oclif/core";
-import { BaseCommand } from "../../base-command.js";
-import { subscriptionServiceFor } from "../../lib/repos/subscription-service.js";
-import { readTrustedIndexes } from "../../lib/repos/catalog-inputs.js";
-import {
-  LINKED_NOTE,
-  describeIndexSource,
-  pinnedCell,
-} from "../../lib/repos/catalog-display.js";
-import { readEffectiveLinks } from "../../lib/repos/links.js";
-import { renderTable, type TableColumn } from "../../utils/table.js";
-import { namespaceOfKey } from "../../services/ref-resolver/index.js";
-import { browsingFlags } from "../../utils/flags.js";
-import {
-  blankLine,
-  footer,
-  indent,
-  log,
-  note,
-  paragraph,
-  section,
-  showCommandVars,
-} from "../../utils/formatting.js";
-
-/** How far every line of this command's output is indented. */
-const INDENT = 2;
-
-/**
- * The columns the results show. The recipe and its versions are why anybody ran
- * the search, so they stay however narrow the terminal is; the description takes
- * whatever room is left and wraps rather than being cut, because half a sentence
- * helps nobody.
- */
-const COLUMNS: TableColumn[] = [
-  { key: "key", header: "Recipe", kind: "path", overflow: "truncate", minWidth: 12 },
-  { key: "versions", header: "Versions", overflow: "truncate", minWidth: 7 },
-  { key: "repo", header: "Repository", overflow: "truncate", priority: "medium" },
-  {
-    key: "description",
-    header: "What it is",
-    overflow: "wrap",
-    flex: 1,
-    priority: "low",
-    minWidth: 16,
-  },
-];
-
-/** The column an `--installed` search adds: the version the lockfile pins. */
-const INSTALLED_COLUMN: TableColumn = {
-  key: "installed",
-  header: "Installed",
-  overflow: "truncate",
-  minWidth: 9,
-};
-
-/** One recipe that matched, ready to be shown. */
-type Match = {
-  repo: string;
-  key: string;
-  description: string;
-  versions: string[];
-  /** The version the lockfile pins, when it pins this recipe from this repository. */
-  installed?: string;
-  /** The linked checkout builds read it from, when it is installed and its repository is linked. */
-  linkedPath?: string;
-};
-
-export default class RepoSearch extends BaseCommand {
-  static description =
-    "Search the recipes every trusted repository publishes, by name or description";
-
-  /**
-   * Searching is the way into every other repository command, so it is also a
-   * top-level `sous search` and is listed as one. `repos:search` is the plural
-   * spelling of the topic.
-   */
-  static aliases = ["search", "repos:search"];
-
-  static examples = [
-    "<%= config.bin %> repo search task",
-    "<%= config.bin %> repo search browser --limit 50",
-    "<%= config.bin %> repo search task --installed --latest",
-  ];
-
-  static args = {
-    text: Args.string({
-      description: "The text to look for in a namespace, recipe name or description",
-      required: true,
-    }),
-  };
-
-  static flags = {
-    ...BaseCommand.baseFlags,
-    ...browsingFlags(),
-    limit: Flags.integer({
-      description: "How many matches to show",
-      default: 25,
-    }),
-  };
-
-  async run(): Promise<void> {
-    const { args, flags } = await this.parse(RepoSearch);
-    const needle = args.text.trim().toLowerCase();
-
-    showCommandVars({
-      Project: this.projectLabel,
-      Config: this.configContext.configPath,
-      Searching: args.text,
-      Reading: describeIndexSource(flags.latest),
-      ...(flags.installed ? { Showing: "only what this project has installed" } : {}),
-    });
-
-    section("Recipes matching your search");
-
-    const service = subscriptionServiceFor({
-      configContext: this.configContext,
-      settings: this.settings,
-      shellEnv: this.shellEnv,
-    });
-
-    const repos = Object.keys(service.currentRepos()).sort();
-    const matches: Match[] = [];
-    const indexes = await readTrustedIndexes(service, { latest: flags.latest });
-    const { notFetched, notChecked } = indexes;
-    const lock = service.lockService.read();
-    const links = readEffectiveLinks(this.configContext.sousDir);
-
-    for (const { name: repo, index } of indexes.repos) {
-      for (const [key, recipe] of Object.entries(index.recipes)) {
-        const locked = lock.recipes[key];
-        const installed = locked?.repo === repo ? locked.version : undefined;
-        if (flags.installed && installed === undefined) continue;
-
-        const namespace = namespaceOfKey(key);
-        const haystack = [
-          key,
-          recipe.description ?? "",
-          index.namespaces[namespace]?.description ?? "",
-        ]
-          .join(" ")
-          .toLowerCase();
-        if (!haystack.includes(needle)) continue;
-
-        matches.push({
-          repo,
-          key,
-          description: recipe.description ?? "",
-          versions: Object.keys(recipe.versions).sort(),
-          ...(installed === undefined ? {} : { installed }),
-          ...(installed === undefined || links[repo] === undefined
-            ? {}
-            : { linkedPath: links[repo]!.path }),
-        });
-      }
-    }
-
-    matches.sort((left, right) =>
-      left.key === right.key
-        ? left.repo.localeCompare(right.repo)
-        : left.key.localeCompare(right.key)
-    );
-
-    // Whatever the results themselves could not say goes into one closing
-    // summary, rather than a stack of separate notes under the table.
-    const summary: string[] = [];
-
-    if (matches.length === 0) {
-      paragraph(
-        repos.length === 0
-          ? "This project trusts no repositories yet, so there is nothing to search. " +
-            "Add one with 'sous repo add <url>'."
-          : flags.installed
-            ? `Nothing this project has installed matches '${args.text}'.`
-            : `Nothing in the repositories this project trusts matches '${args.text}'.`
-      );
-    } else {
-      const shown = matches.slice(0, flags.limit);
-      const rows = shown.map((match) => ({
-        key: match.key,
-        repo: match.repo,
-        versions: match.versions.join(", "),
-        installed: pinnedCell(match.installed, match.linkedPath),
-        description:
-          match.description.length > 0 ? match.description : "no description published",
-      }));
-
-      // Narrowed to what is installed, the installed version sits right after
-      // the recipe, ahead of every version the repository publishes.
-      const columns = flags.installed
-        ? [COLUMNS[0]!, INSTALLED_COLUMN, ...COLUMNS.slice(1)]
-        : COLUMNS;
-
-      for (const line of renderTable(columns, rows, { indent: INDENT })) {
-        log(indent(line, INDENT));
-      }
-
-      if (matches.length > shown.length) {
-        summary.push(
-          `${matches.length - shown.length} more matches are not shown. Raise the ` +
-            `number with '--limit'.`
-        );
-      }
-    }
-
-    if (notFetched.length > 0) {
-      summary.push(
-        `Nothing has been fetched from these repositories yet, so they were not ` +
-          `searched: ${notFetched.join(", ")}.`
-      );
-    }
-
-    if (notChecked.length > 0) {
-      summary.push(
-        `These repositories could not be reached, so they were searched as the cache ` +
-          `has them and were not checked: ${notChecked.join(", ")}.`
-      );
-    }
-
-    if (summary.length > 0) {
-      blankLine();
-      for (const line of summary) paragraph(line);
-    }
-
-    if (matches.slice(0, flags.limit).some((match) => match.linkedPath !== undefined)) {
-      blankLine();
-      note(LINKED_NOTE);
-    }
-
-    footer();
-  }
-}