@deployanyway/error-translator 0.4.0 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.0.0
+
+- Explain This Failure: real errors and cause chains.
+- Typed API, CLI integration, runnable codebase example and meaningful workflow tests.
+- Stable contracts and migration guidance; original humor stays around accurate facts.
+
 ## 0.4.0
 
 46 built-in definitions cover filesystem, permissions, networking, module loading, streams, HTTP response lifecycle and JavaScript errors. Each has a specific explanation, likely causes and practical checks. Rubber-duck commentary has a distinct original line for every supported definition. No commands run automatically and unknown errors remain explicitly unrecognized.

package/MIGRATION.md

@@ -9,3 +9,9 @@ Install 0.3.0 with npm. Seeds and exact humorous wording are version-specific. D
 46 distinct error definitions with explanations, causes and practical checks; original duck commentary for each; structured errorCatalog API and --catalog CLI.
 
 Default behavior is retained except that the expanded error catalog now recognizes additional errors. New rotation and release-plan features are opt-in.
+
+## 0.4.0 to stable 1.0.0
+
+diagnoseError/renderDiagnosis and diagnostic CLI flags are additive. Explicit code precedence and existing catalog/batch behavior remain. Use diagnosis.original to hand the same error to your existing handler; serializing a diagnosis omits that reference.
+
+See README for exact contracts, bounds and failure behavior.

package/README.md

@@ -1,5 +1,35 @@
 # error-translator
 
+## Explain This Failure: real errors and cause chains (1.0.0)
+
+diagnoseError(error, options) walks actual Error.cause chains with a default eight-layer bound (maxDepth 1–32). It detects cycles, exposes unknown causes honestly and returns structured chain entries with a translation for each layer. It never throws away the original error: result.original is the exact input reference and is deliberately non-enumerable so JSON output excludes it. The caller controls rethrowing, logging and exit behavior.
+
+```js
+import { diagnoseError, renderDiagnosis } from "@deployanyway/error-translator";
+try {
+  await loadConfig();
+} catch (error) {
+  const diagnosis = diagnoseError(error, { mode: "rubber-duck" });
+  console.error(renderDiagnosis(diagnosis));
+  throw error; // preserve failure behavior and the original stack
+}
+```
+
+Options: mode plain/rubber-duck, maxDepth, includeStack (default false). Entries contain depth, name, message, optional code, translation and opt-in stack. stopped is complete/cycle/depth-limit; truncated reports incomplete traversal. Arbitrary primitive causes receive an explicit unknown translation. The caller's errors and causes are not mutated. AggregateError.errors is not flattened; this API follows the cause chain.
+
+```sh
+printf '%s' '{"message":"Config failed","cause":{"code":"ENOENT","message":"open config.json"}}' | error-translator --diagnose --json
+node node_modules/@deployanyway/error-translator/examples/explain-failure.mjs ./missing-config.json
+```
+
+--diagnose accepts a JSON error record from stdin or a quoted argument, with --max-depth and opt-in --include-stack. It rejects batch/catalog/list combinations. Translation/diagnosis exits 0; invalid input exits 2. The runnable filesystem example preserves application failure with exit 1. Messages and opt-in stacks can contain private data; this library does not redact them or run fixes.
+
+## Stable v1 contract
+
+Node 22.13+ or Node 24. MIT licensed. CLI flags, structured fields, ESM/CommonJS exports and declarations are covered by tests and installed-package checks. Existing 0.4 APIs remain available except the explicitly documented doggo-log redaction/text-context changes. Future incompatible public API changes require a major release; callers should consume structured fields rather than parse jokes. Exact humorous wording and seeded catalog choices are version-specific. No telemetry, external API keys or network service is needed for core use.
+
+Run npm test, npm run lint, npm run format:check, npm run coverage, npm run test:types and npm run verify:package from a source checkout. Runnable examples are shipped under examples/. The root demo is https://deployanyway.github.io/.
+
 ## Browse the debugging library (0.4.0)
 
 46 built-in definitions cover filesystem, permissions, networking, module loading, streams, HTTP response lifecycle and JavaScript errors. Each has a specific explanation, likely causes and practical checks. Rubber-duck commentary has a distinct original line for every supported definition. No commands run automatically and unknown errors remain explicitly unrecognized.

package/dist/index.cjs

@@ -20,8 +20,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.js
 var index_exports = {};
 __export(index_exports, {
+  diagnoseError: () => diagnoseError,
   errorCatalog: () => errorCatalog,
   listErrors: () => listErrors,
+  renderDiagnosis: () => renderDiagnosis,
   renderTranslation: () => renderTranslation,
   translateError: () => translateError,
   translateErrors: () => translateErrors
@@ -586,6 +588,67 @@ var definitions = {
   }
 };
 
+// src/diagnostics.js
+function diagnoseError(error, options = {}) {
+  if (!options || typeof options !== "object" || Array.isArray(options))
+    throw new TypeError("Options must be an object.");
+  const maxDepth = options.maxDepth ?? 8, includeStack = options.includeStack ?? false;
+  if (!Number.isInteger(maxDepth) || maxDepth < 1 || maxDepth > 32)
+    throw new RangeError("maxDepth must be an integer from 1 to 32.");
+  if (typeof includeStack !== "boolean")
+    throw new TypeError("includeStack must be a boolean.");
+  translateError(error, options);
+  const seen = /* @__PURE__ */ new Set(), chain = [];
+  let current = error, stopped = "complete";
+  while (current !== void 0) {
+    if (chain.length === maxDepth) {
+      stopped = "depth-limit";
+      break;
+    }
+    if (current !== null && typeof current === "object") {
+      if (seen.has(current)) {
+        stopped = "cycle";
+        break;
+      }
+      seen.add(current);
+    }
+    const object = current !== null && typeof current === "object" && !Array.isArray(current) ? current : void 0;
+    const raw = typeof current === "string" ? current : object?.message;
+    const message = typeof raw === "string" ? raw : String(current);
+    const name = typeof object?.name === "string" ? object.name : "Error";
+    const code = typeof object?.code === "string" ? object.code : void 0;
+    const translation = translateError(
+      { name, message, ...code ? { code } : {} },
+      options
+    );
+    chain.push({
+      depth: chain.length,
+      name,
+      message,
+      ...code ? { code } : {},
+      translation,
+      ...includeStack && typeof object?.stack === "string" ? { stack: object.stack } : {}
+    });
+    current = object?.cause;
+  }
+  const result = { chain, stopped, truncated: stopped !== "complete" };
+  Object.defineProperty(result, "original", {
+    value: error,
+    enumerable: false
+  });
+  return result;
+}
+function renderDiagnosis(result) {
+  if (!result || !Array.isArray(result.chain) || !result.chain.length || !["complete", "cycle", "depth-limit"].includes(result.stopped))
+    throw new TypeError("Provide a diagnosis result.");
+  return result.chain.map(
+    (item, index) => `${index === 0 ? "Failure" : "Caused by"}: ${item.name}${item.code ? " [" + item.code + "]" : ""}: ${item.message}
+${renderTranslation(item.translation)}${item.stack ? "\n\nOriginal stack:\n" + item.stack : ""}`
+  ).join("\n\n---\n\n") + (result.truncated ? `
+
+Cause traversal stopped: ${result.stopped}.` : "");
+}
+
 // src/index.js
 var listErrors = () => Object.keys(definitions);
 function translateErrors(errors, options = {}) {
@@ -717,8 +780,10 @@ function errorCatalog(options = {}) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  diagnoseError,
   errorCatalog,
   listErrors,
+  renderDiagnosis,
   renderTranslation,
   translateError,
   translateErrors

package/examples/basic.js

@@ -0,0 +1,9 @@
+import {
+  translateError,
+  renderTranslation,
+} from "@deployanyway/error-translator";
+
+const error = Object.assign(new Error("connect ECONNREFUSED 127.0.0.1:3000"), {
+  code: "ECONNREFUSED",
+});
+console.log(renderTranslation(translateError(error)));

package/examples/explain-failure.mjs

@@ -0,0 +1,11 @@
+import { readFileSync } from "node:fs";
+import { diagnoseError, renderDiagnosis } from "@deployanyway/error-translator";
+const file = process.argv[2] ?? "missing-config.json";
+try {
+  readFileSync(file, "utf8");
+  console.log("Config read successfully.");
+} catch (cause) {
+  const failure = new Error("Application config could not be read", { cause });
+  console.error(renderDiagnosis(diagnoseError(failure)));
+  process.exitCode = 1;
+}

package/index.d.cts

@@ -1,5 +1,11 @@
-export type ErrorInput =
-  string | Error | { code?: string; name?: string; message?: string };
+export interface ErrorRecord {
+  code?: string;
+  name?: string;
+  message?: string;
+  stack?: string;
+  cause?: unknown;
+}
+export type ErrorInput = string | Error | ErrorRecord;
 export interface TranslationOptions {
   mode?: "plain" | "rubber-duck";
 }
@@ -23,3 +29,26 @@ export function renderTranslation(result: Translation): string;
 export function listErrors(): string[];
 
 export function errorCatalog(options?: TranslationOptions): Translation[];
+export interface DiagnosisOptions extends TranslationOptions {
+  maxDepth?: number;
+  includeStack?: boolean;
+}
+export interface DiagnosticLayer {
+  depth: number;
+  name: string;
+  message: string;
+  code?: string;
+  translation: Translation;
+  stack?: string;
+}
+export interface Diagnosis {
+  readonly original: ErrorInput;
+  chain: DiagnosticLayer[];
+  stopped: "complete" | "cycle" | "depth-limit";
+  truncated: boolean;
+}
+export function diagnoseError(
+  error: ErrorInput,
+  options?: DiagnosisOptions,
+): Diagnosis;
+export function renderDiagnosis(result: Diagnosis): string;

package/index.d.ts

@@ -1,5 +1,11 @@
-export type ErrorInput =
-  string | Error | { code?: string; name?: string; message?: string };
+export interface ErrorRecord {
+  code?: string;
+  name?: string;
+  message?: string;
+  stack?: string;
+  cause?: unknown;
+}
+export type ErrorInput = string | Error | ErrorRecord;
 export interface TranslationOptions {
   mode?: "plain" | "rubber-duck";
 }
@@ -23,3 +29,26 @@ export function renderTranslation(result: Translation): string;
 export function listErrors(): string[];
 
 export function errorCatalog(options?: TranslationOptions): Translation[];
+export interface DiagnosisOptions extends TranslationOptions {
+  maxDepth?: number;
+  includeStack?: boolean;
+}
+export interface DiagnosticLayer {
+  depth: number;
+  name: string;
+  message: string;
+  code?: string;
+  translation: Translation;
+  stack?: string;
+}
+export interface Diagnosis {
+  readonly original: ErrorInput;
+  chain: DiagnosticLayer[];
+  stopped: "complete" | "cycle" | "depth-limit";
+  truncated: boolean;
+}
+export function diagnoseError(
+  error: ErrorInput,
+  options?: DiagnosisOptions,
+): Diagnosis;
+export function renderDiagnosis(result: Diagnosis): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@deployanyway/error-translator",
-  "version": "0.4.0",
-  "description": "Plain-English Node.js error explanations and debugging tips, because the stack trace has chosen violence.",
+  "version": "1.0.0",
+  "description": "Explain real Node.js errors and cause chains with practical debugging checks. The stack trace has chosen violence; the duck brought context.",
   "type": "module",
   "exports": {
     ".": {
@@ -27,7 +27,8 @@
     "dist",
     "index.d.ts",
     "index.d.cts",
-    "MIGRATION.md"
+    "MIGRATION.md",
+    "examples"
   ],
   "engines": {
     "node": ">=22.13"
@@ -74,7 +75,9 @@
     "plain-english",
     "typescript",
     "humor",
-    "deployanyway"
+    "deployanyway",
+    "error-cause",
+    "error-handling"
   ],
   "main": "./dist/index.cjs",
   "types": "./index.d.ts",

package/src/cli.js

@@ -7,6 +7,8 @@ import {
   translateErrors,
   listErrors,
   errorCatalog,
+  diagnoseError,
+  renderDiagnosis,
 } from "./index.js";
 
 import { readStdin } from "./input.js";
@@ -21,12 +23,15 @@ try {
       batch: { type: "boolean" },
       list: { type: "boolean" },
       catalog: { type: "boolean" },
+      diagnose: { type: "boolean" },
+      "include-stack": { type: "boolean" },
+      "max-depth": { type: "string" },
       mode: { type: "string", default: "plain" },
     },
   });
   if (values.help) {
     console.log(
-      'Usage: error-translator <error code or quoted message> [--json] [--mode plain|rubber-duck]\n\nTranslate errors into human-readable guidance. Without arguments, read stdin (256 KiB). --batch reads a JSON array of 1–100 errors. --list lists supported codes. --catalog prints all explanations and checks.\n\nOptions:\n  -h, --help     Show help\n  -v, --version  Show version\n  --json         Print a structured JSON result\n  --mode plain|rubber-duck   Keep useful guidance; add duck commentary\n\nExamples:\n  error-translator ECONNREFUSED\n  error-translator "TypeError: value is not a function" --json\n\nExit codes: 0 translation/help/version; 2 invalid arguments.',
+      'Usage: error-translator <error code or quoted message> [--json] [--mode plain|rubber-duck]\n\nTranslate errors into human-readable guidance. --diagnose reads a JSON error/cause record; --max-depth 1..32 bounds it; --include-stack opts into original stacks. Without arguments, read stdin (256 KiB). --batch reads a JSON array of 1–100 errors. --list lists supported codes. --catalog prints all explanations and checks.\n\nOptions:\n  -h, --help     Show help\n  -v, --version  Show version\n  --json         Print a structured JSON result\n  --mode plain|rubber-duck   Keep useful guidance; add duck commentary\n\nExamples:\n  error-translator ECONNREFUSED\n  error-translator "TypeError: value is not a function" --json\n\nExit codes: 0 translation/help/version; 2 invalid arguments.',
     );
   } else if (values.version) {
     console.log(
@@ -34,6 +39,24 @@ try {
         readFileSync(new URL("../package.json", import.meta.url), "utf8"),
       ).version,
     );
+  } else if (values.diagnose) {
+    if (values.batch || values.catalog || values.list)
+      throw new TypeError(
+        "--diagnose cannot combine with --batch, --catalog or --list.",
+      );
+    const text = positionals.length ? positionals.join(" ") : await readStdin();
+    const result = diagnoseError(JSON.parse(text), {
+      mode: values.mode,
+      includeStack: values["include-stack"] ?? false,
+      ...(values["max-depth"] !== undefined
+        ? { maxDepth: Number(values["max-depth"]) }
+        : {}),
+    });
+    console.log(
+      values.json ? JSON.stringify(result, null, 2) : renderDiagnosis(result),
+    );
+  } else if (values["include-stack"] || values["max-depth"] !== undefined) {
+    throw new TypeError("--include-stack and --max-depth require --diagnose.");
   } else if (values.catalog) {
     if (positionals.length || values.batch || values.list)
       throw new TypeError(

package/src/diagnostics.js

@@ -0,0 +1,79 @@
+import { translateError, renderTranslation } from "./index.js";
+
+/** Snapshot a bounded cause chain; preserve the original without serializing it. */
+export function diagnoseError(error, options = {}) {
+  if (!options || typeof options !== "object" || Array.isArray(options))
+    throw new TypeError("Options must be an object.");
+  const maxDepth = options.maxDepth ?? 8,
+    includeStack = options.includeStack ?? false;
+  if (!Number.isInteger(maxDepth) || maxDepth < 1 || maxDepth > 32)
+    throw new RangeError("maxDepth must be an integer from 1 to 32.");
+  if (typeof includeStack !== "boolean")
+    throw new TypeError("includeStack must be a boolean.");
+  // Validate the root using the established translation contract.
+  translateError(error, options);
+  const seen = new Set(),
+    chain = [];
+  let current = error,
+    stopped = "complete";
+  while (current !== undefined) {
+    if (chain.length === maxDepth) {
+      stopped = "depth-limit";
+      break;
+    }
+    if (current !== null && typeof current === "object") {
+      if (seen.has(current)) {
+        stopped = "cycle";
+        break;
+      }
+      seen.add(current);
+    }
+    const object =
+      current !== null && typeof current === "object" && !Array.isArray(current)
+        ? current
+        : undefined;
+    const raw = typeof current === "string" ? current : object?.message;
+    const message = typeof raw === "string" ? raw : String(current);
+    const name = typeof object?.name === "string" ? object.name : "Error";
+    const code = typeof object?.code === "string" ? object.code : undefined;
+    const translation = translateError(
+      { name, message, ...(code ? { code } : {}) },
+      options,
+    );
+    chain.push({
+      depth: chain.length,
+      name,
+      message,
+      ...(code ? { code } : {}),
+      translation,
+      ...(includeStack && typeof object?.stack === "string"
+        ? { stack: object.stack }
+        : {}),
+    });
+    current = object?.cause;
+  }
+  const result = { chain, stopped, truncated: stopped !== "complete" };
+  Object.defineProperty(result, "original", {
+    value: error,
+    enumerable: false,
+  });
+  return result;
+}
+export function renderDiagnosis(result) {
+  if (
+    !result ||
+    !Array.isArray(result.chain) ||
+    !result.chain.length ||
+    !["complete", "cycle", "depth-limit"].includes(result.stopped)
+  )
+    throw new TypeError("Provide a diagnosis result.");
+  return (
+    result.chain
+      .map(
+        (item, index) =>
+          `${index === 0 ? "Failure" : "Caused by"}: ${item.name}${item.code ? " [" + item.code + "]" : ""}: ${item.message}\n${renderTranslation(item.translation)}${item.stack ? "\n\nOriginal stack:\n" + item.stack : ""}`,
+      )
+      .join("\n\n---\n\n") +
+    (result.truncated ? `\n\nCause traversal stopped: ${result.stopped}.` : "")
+  );
+}

package/src/index.js

@@ -1,4 +1,5 @@
 import { definitions } from "./definitions.js";
+export { diagnoseError, renderDiagnosis } from "./diagnostics.js";
 export const listErrors = () => Object.keys(definitions);
 
 /** Translate an ordered, bounded batch without mutating input. */