@no-k/hermes 0.1.0 → 0.2.0

package/bin/hermes.mjs

@@ -1,159 +0,0 @@
-#!/usr/bin/env node
-import { lstatSync, mkdirSync, readFileSync, realpathSync, writeFileSync } from "node:fs";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import { parseArgs } from "node:util";
-import { validateCatalog } from "../lib/catalog.mjs";
-
-const packageDirectory = fileURLToPath(new URL("../", import.meta.url));
-const manifest = JSON.parse(readFileSync(path.join(packageDirectory, "package.json"), "utf8"));
-const help = [
-  "Hermes " + manifest.version + " — copy TypeScript utilities into your project",
-  "",
-  "Usage:",
-  "  hermes list",
-  "  hermes add <item...> --dir <directory> [--dry-run] [--overwrite]",
-  "",
-  "Options:",
-  "  -d, --dir       Destination for utility folders and LICENSE (required for add)",
-  "  --dry-run       Show the planned files without writing",
-  "  --overwrite     Replace existing files whose contents differ",
-  "  -h, --help      Show help",
-  "  -v, --version   Show version",
-  "",
-  "Example:",
-  "  npx @no-k/hermes add array-chunk --dir src/lib/hermes",
-  "",
-  "External npm dependencies are reported; they are not installed automatically.",
-].join("\n");
-
-function stat(file) {
-  try {
-    return lstatSync(file);
-  } catch (error) {
-    if (error.code === "ENOENT") return undefined;
-    throw error;
-  }
-}
-
-function destinationStat(directory, relative) {
-  let current = directory;
-  const segments = relative.split("/");
-  for (let index = -1; index < segments.length; index += 1) {
-    if (index >= 0) current = path.join(current, segments[index]);
-    const info = stat(current);
-    if (info?.isSymbolicLink()) throw new Error("Refusing to write through a symbolic link: " + current);
-    if (index < segments.length - 1 && info && !info.isDirectory()) {
-      throw new Error("Expected a directory: " + current);
-    }
-    if (index === segments.length - 1) {
-      if (info && !info.isFile()) throw new Error("Expected a regular file: " + current);
-      return info;
-    }
-  }
-}
-
-function sourceContent(relative) {
-  const directory = realpathSync(path.join(packageDirectory, "templates"));
-  const file = realpathSync(path.join(directory, relative));
-  const fromRoot = path.relative(directory, file);
-  if (path.isAbsolute(fromRoot) || fromRoot === ".." || fromRoot.startsWith(".." + path.sep)) {
-    throw new Error("Source template escapes its directory: " + relative);
-  }
-  return readFileSync(file, "utf8");
-}
-
-function add(items, options) {
-  if (!options.dir?.trim()) throw new Error("Specify a destination with --dir <directory>.");
-  const directory = path.resolve(options.dir);
-  const files = new Map();
-  for (const item of items) {
-    for (const file of item.files) {
-      if (!files.has(file)) files.set(file, sourceContent(file));
-    }
-  }
-  files.set("LICENSE", readFileSync(path.join(packageDirectory, "LICENSE"), "utf8"));
-  const plan = [...files]
-    .sort(([a], [b]) => a.localeCompare(b))
-    .map(([file, content]) => {
-      const destination = path.join(directory, file);
-      const existing = destinationStat(directory, file);
-      const same = existing && readFileSync(destination, "utf8") === content;
-      return { file, content, destination, action: same ? "keep" : existing ? "replace" : "create" };
-    });
-  const conflicts = plan.filter((file) => file.action === "replace");
-  if (conflicts.length && !options.overwrite) {
-    throw new Error(
-      "Existing files differ; no files were written:\n" +
-        conflicts.map((file) => "  " + file.destination).join("\n") +
-        "\nReview the changes, then use --overwrite if you want to replace them.",
-    );
-  }
-  for (const file of plan) {
-    if (!options["dry-run"] && file.action !== "keep") {
-      mkdirSync(path.dirname(file.destination), { recursive: true });
-      writeFileSync(file.destination, file.content, { flag: file.action === "create" ? "wx" : "w" });
-    }
-    console.log((options["dry-run"] ? "[dry-run] " : "") + file.action + " " + file.destination);
-  }
-  const dependencies = [...new Set(items.flatMap((item) => item.dependencies))].sort();
-  const devDependencies = [...new Set(items.flatMap((item) => item.devDependencies ?? []))].sort();
-  if (dependencies.length || devDependencies.length) {
-    console.log("\nThese utilities need npm packages. Install them in your consuming project:");
-    if (dependencies.length)
-      console.log("  npm install " + dependencies.map((value) => JSON.stringify(value)).join(" "));
-    if (devDependencies.length) {
-      console.log("  npm install --save-dev " + devDependencies.map((value) => JSON.stringify(value)).join(" "));
-    }
-  }
-  for (const item of items) {
-    if (item.runtime === "node") console.log("\n" + item.name + ": requires Node.js (imports a Node.js builtin).");
-    if (item.runtime === "dom") console.log("\n" + item.name + ": requires DOM APIs and DOM TypeScript types.");
-  }
-  console.log("\n" + (options["dry-run"] ? "Planned" : "Added") + " " + items.map((item) => item.name).join(", "));
-}
-
-function main() {
-  const { values, positionals } = parseArgs({
-    options: {
-      dir: { type: "string", short: "d" },
-      "dry-run": { type: "boolean" },
-      overwrite: { type: "boolean" },
-      help: { type: "boolean", short: "h" },
-      version: { type: "boolean", short: "v" },
-    },
-    allowPositionals: true,
-  });
-  if (values.help || (!positionals.length && !values.version)) {
-    console.log(help);
-    return;
-  }
-  if (values.version) {
-    console.log(manifest.version);
-    return;
-  }
-  const [command, ...names] = positionals;
-  if (!["list", "add"].includes(command)) throw new Error("Unknown command: " + command + ". Use --help.");
-  const catalog = validateCatalog(JSON.parse(readFileSync(path.join(packageDirectory, "catalog.json"), "utf8")));
-  if (catalog.version !== manifest.version)
-    throw new Error("The catalog version does not match the package. Rebuild the CLI.");
-  if (command === "list") {
-    if (names.length || values.dir || values.overwrite || values["dry-run"]) throw new Error("Usage: hermes list");
-    for (const item of catalog.items) console.log(item.name + "\t" + item.description);
-    return;
-  }
-  if (!names.length) throw new Error("Specify at least one item. Use 'hermes list' to see available items.");
-  const items = [...new Set(names)].map((name) => {
-    const item = catalog.items.find((candidate) => candidate.name === name);
-    if (!item) throw new Error("Unknown item: " + name + ". Use 'hermes list' to see available items.");
-    return item;
-  });
-  add(items, values);
-}
-
-try {
-  main();
-} catch (error) {
-  console.error("Hermes: " + error.message);
-  process.exitCode = 1;
-}

package/lib/catalog.mjs

@@ -1,51 +0,0 @@
-const itemNamePattern = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
-
-export function isSourcePath(value) {
-  return (
-    typeof value === "string" &&
-    value.endsWith(".ts") &&
-    !value.includes("\\") &&
-    !value.includes("\0") &&
-    !value.includes(":") &&
-    value.split("/").every((part) => part && part !== "." && part !== "..") &&
-    !/\.(test|spec|stories|config|d)\.ts$/.test(value)
-  );
-}
-
-export function validateCatalog(catalog) {
-  if (
-    catalog?.schemaVersion !== 1 ||
-    typeof catalog.version !== "string" ||
-    !Array.isArray(catalog.items) ||
-    catalog.items.length === 0
-  ) {
-    throw new Error("Invalid Hermes catalog.");
-  }
-  const names = new Set();
-  for (const item of catalog.items) {
-    if (
-      !item ||
-      typeof item.name !== "string" ||
-      !itemNamePattern.test(item.name) ||
-      names.has(item.name) ||
-      typeof item.description !== "string" ||
-      !Array.isArray(item.files) ||
-      item.files.length === 0 ||
-      !item.files.every(isSourcePath) ||
-      new Set(item.files).size !== item.files.length ||
-      (item.runtime !== undefined && !["node", "dom"].includes(item.runtime))
-    ) {
-      throw new Error("Invalid or duplicate Hermes item: " + item?.name);
-    }
-    for (const values of [item.dependencies, item.devDependencies ?? []]) {
-      if (
-        !Array.isArray(values) ||
-        !values.every((value) => typeof value === "string" && /^[^\s]+@[^\s]+$/.test(value))
-      ) {
-        throw new Error("Invalid dependencies for " + item.name);
-      }
-    }
-    names.add(item.name);
-  }
-  return catalog;
-}