@bendyline/squisq-cli 2.3.3 → 2.4.0

package/README.md

@@ -121,6 +121,29 @@ squisq validate ./my-folder --strict
 
 Diagnostics are reported at three severities — `error`, `warning`, and `info` (info is counted and shown separately). Exit codes depend on **errors** only: `0` clean, warnings-only, or info-only; `1` errors (or any warning with `--strict`); `2` input unreadable.
 
+### `squisq transform <input>`
+
+Apply one-time markdown **source** transforms to a `.md` file, in the order given: `unwrap` (remove forced line wrapping so each paragraph is one line — hard breaks kept), `wrap` (hard-wrap paragraph prose at a column width on word boundaries — code, tables, and headings untouched), and `cleanup` (canonical house-style normalization: bullets, emphasis, headings, table padding, spacing; annotations and frontmatter preserved). Not to be confused with the `--transform <style>` slideshow-style flag on `convert`/`video` — this command rewrites the markdown text itself.
+
+The transformed markdown goes to stdout by default (status messages go to stderr, so it pipes cleanly).
+
+```bash
+squisq transform doc.md --ops unwrap
+squisq transform doc.md --ops unwrap,cleanup > cleaned.md
+squisq transform doc.md --ops wrap --width 100 --in-place
+squisq transform doc.md --ops cleanup -o cleaned.md
+```
+
+| Option         | Description                                                                |
+| -------------- | -------------------------------------------------------------------------- |
+| `--ops <list>` | Comma-separated transforms, applied in order (`unwrap`, `wrap`, `cleanup`) |
+| `--width <n>`  | Column width for `wrap` (20–500, default 80)                               |
+| `-o <file>`    | Write the result to a file (refuses to overwrite without `--overwrite`)    |
+| `--in-place`   | Rewrite the input file (conflicts with `-o`)                               |
+| `--overwrite`  | Allow `-o` to replace an existing file                                     |
+
+Transforms run in strict mode: each one reparses its output and structurally compares it against the input document; if equivalence cannot be proven, the command exits `1` without emitting anything. Exit codes: `0` success, `1` transform/output failure, `2` input unreadable.
+
 ## Input Formats
 
 All commands accept:

package/dist/index.js

@@ -12,7 +12,7 @@ import "./chunk-GGVASRPG.js";
 
 // src/index.ts
 import { createRequire } from "module";
-import { Command } from "commander";
+import { Command as Command2 } from "commander";
 
 // src/commands/convert.ts
 import { mkdir } from "fs/promises";
@@ -627,6 +627,91 @@ async function runDoctor(runtime = defaultDoctorRuntime) {
   return allPresent;
 }
 
+// src/commands/transform.ts
+import { mkdir as mkdir3, readFile } from "fs/promises";
+import { dirname as dirname4, resolve as resolve4 } from "path";
+import { Option as Option2 } from "commander";
+import {
+  DEFAULT_WRAP_WIDTH,
+  MARKDOWN_SOURCE_TRANSFORMS,
+  applyMarkdownSourceTransform
+} from "@bendyline/squisq/markdown";
+var VALID_OPS = MARKDOWN_SOURCE_TRANSFORMS.map((t) => t.id);
+function registerTransformCommand(program2) {
+  program2.command("transform").description("Apply one-time markdown source transforms (unwrap, wrap, cleanup) to a document").argument("<input>", "Path to a markdown (.md) file").requiredOption(
+    "--ops <list>",
+    `Comma-separated transforms, applied in order. Valid: ${VALID_OPS.join(", ")}`
+  ).option(
+    "--width <n>",
+    "Column width for the wrap transform (20\u2013500)",
+    String(DEFAULT_WRAP_WIDTH)
+  ).addOption(
+    new Option2("-o, --output <file>", "Write the result to a file (default: stdout)").conflicts(
+      "inPlace"
+    )
+  ).addOption(
+    new Option2("--in-place", "Rewrite the input file with the result").conflicts("output")
+  ).option("--overwrite", "Replace an existing --output file (default: refuse and exit non-zero)").action(async (inputPath, opts) => {
+    try {
+      process.exitCode = await runTransform(inputPath, opts);
+    } catch (err) {
+      const message = err instanceof Error ? err.message : String(err);
+      console.error(`Error: ${message}`);
+      process.exitCode = 1;
+    }
+  });
+}
+async function runTransform(inputPath, opts) {
+  const resolvedInput = resolve4(inputPath);
+  let source;
+  try {
+    source = await readFile(resolvedInput, { encoding: "utf-8" });
+  } catch (err) {
+    const message = err instanceof Error ? err.message : String(err);
+    console.error(`Error: could not read input: ${message}`);
+    return 2;
+  }
+  const ids = opts.ops.split(",").map((id) => id.trim()).filter((id) => id.length > 0);
+  if (ids.length === 0) {
+    console.error(`Error: --ops needs at least one transform (valid: ${VALID_OPS.join(", ")})`);
+    return 1;
+  }
+  for (const id of ids) {
+    if (!VALID_OPS.includes(id)) {
+      console.error(`Error: unknown transform "${id}" (valid: ${VALID_OPS.join(", ")})`);
+      return 1;
+    }
+  }
+  const width = Number.parseInt(opts.width, 10);
+  if (Number.isNaN(width)) {
+    console.error(`Error: --width must be a number (got "${opts.width}")`);
+    return 1;
+  }
+  let result = source;
+  const applied = [];
+  for (const id of ids) {
+    const step = applyMarkdownSourceTransform(id, result, { width, strict: true });
+    result = step.output;
+    applied.push(step.changed ? id : `${id} (no changes)`);
+  }
+  const summary = applied.join(", ");
+  const bytes = Buffer.from(result, "utf-8");
+  if (opts.inPlace) {
+    await writeFileGuarded(resolvedInput, bytes, true);
+    console.error(`\u2713 ${summary} \u2192 ${resolvedInput}`);
+  } else if (opts.output) {
+    const resolvedOutput = resolve4(opts.output);
+    await assertOutputsWritable([resolvedOutput], opts.overwrite);
+    await mkdir3(dirname4(resolvedOutput), { recursive: true });
+    await writeFileGuarded(resolvedOutput, bytes, opts.overwrite);
+    console.error(`\u2713 ${summary} \u2192 ${resolvedOutput}`);
+  } else {
+    process.stdout.write(result);
+    console.error(`\u2713 ${summary}`);
+  }
+  return 0;
+}
+
 // src/index.ts
 var require2 = createRequire(import.meta.url);
 var { version } = require2("../package.json");
@@ -635,10 +720,11 @@ if (process.stderr.isTTY) {
     `\x1B[36m{[\x1B[0m \x1B[1msquiggly square\x1B[0m \x1B[2m\u2014\x1B[0m \x1B[1msquisq\x1B[0m \x1B[2m\u2014\x1B[0m \x1B[33mv${version}\x1B[0m \x1B[36m]}\x1B[0m`
   );
 }
-var program = new Command();
+var program = new Command2();
 program.name("squisq").description("Squisq CLI \u2014 convert and process markdown-based documents").version(version);
 registerConvertCommand(program);
 registerVideoCommand(program);
 registerValidateCommand(program);
 registerDoctorCommand(program);
+registerTransformCommand(program);
 program.parse();