@callidescope/output 0.0.78 → 0.0.80

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.0.80 (2026-11-12)
+
+### 🧱 Updated Dependencies
+
+- Updated callidescope-configuration to 0.0.81
+- Updated callidescope-graph to 0.0.80
+- Updated callidescope-core to 0.0.80
+
+## 0.0.79 (2026-11-11)
+
+### 🚀 Features
+
+- **codometer:** ✨ tighten the comment budgets and shorten every comment over them ([#2262](https://github.com/organizzolini/codebase/pull/2262), [#2261](https://github.com/organizzolini/codebase/issues/2261))
+
+### 🧱 Updated Dependencies
+
+- Updated callidescope-configuration to 0.0.80
+- Updated callidescope-graph to 0.0.79
+- Updated callidescope-core to 0.0.79
+
 ## 0.0.78 (2026-11-10)
 
 ### 🚀 Features

package/dist/src/index.d.ts

@@ -37,10 +37,9 @@ export declare class AddressReportModule {
 /**
  * Renders `depth` and `breadth`'s findings for a terminal.
  *
- * Markdown by default and mermaid on request, the same two renderings
- * `callidescope` itself prints — a diagram at a prompt is source someone can
- * paste somewhere that draws it, and markdown is what reads well as terminal
- * text. JSON carries the same data with nothing rendered.
+ * Markdown by default, mermaid on request, as `callidescope` prints them.
+ * Mermaid is paste-ready source; markdown reads well as terminal text.
+ * JSON carries the same data unrendered.
  */
 export declare class AddressReportService {
     private readonly mermaidReportService;
@@ -128,12 +127,10 @@ export declare interface FindOwnedFindingsArguments {
     readonly reports: readonly ProjectReport[];
 }
 
-/** Start marker of any anchored block this convention recognizes. Where a corrupted block must stop being replaced: at another block's territory. */
+/** Start marker of an anchored block. Replacement stops at other blocks. */
 export declare const FOREIGN_ANCHOR_PATTERN: RegExp;
 
-/**
- * Anything holding a frame list, such as a full `CallStack` or a path with no depth of its own.
- */
+/** Anything holding a frame list, such as a `CallStack`. */
 export declare interface FramedStack {
     readonly frames: readonly StackFrame[];
 }
@@ -147,7 +144,7 @@ export declare const HEADROOM_BUCKET_FOUR_PLUS = "4+";
 /** Bucket holding the projects one frame from their own limit. */
 export declare const HEADROOM_BUCKET_ONE = "1";
 
-/** The order the scoreboard prints buckets, tightest first. Fixed, so an empty bucket still prints as zero. */
+/** Scoreboard bucket order, tightest first. Fixed, so empty ones still print. */
 export declare const HEADROOM_BUCKET_ORDER: readonly ["over limit", "0 — at limit", "1", "2–3", "4+", "no stacks"];
 
 /** Bucket holding the projects whose deepest stack broke their own limit. */
@@ -156,13 +153,10 @@ export declare const HEADROOM_BUCKET_OVER_LIMIT = "over limit";
 /** Bucket holding the projects two or three frames from their own limit. */
 export declare const HEADROOM_BUCKET_TWO_TO_THREE = "2\u20133";
 
-/** Bucket for projects measuring no stack. Not the widest headroom bucket: such a limit gates nothing, the opposite finding. */
+/** Bucket for projects with no stack. Such a limit gates nothing. */
 export declare const HEADROOM_BUCKET_UNMEASURED = "no stacks";
 
-/**
- * Values beside a log line rather than inside it: counts and durations change
- * per occurrence, so they stay queryable fields.
- */
+/** Values beside the log line, kept as queryable fields. */
 declare interface LogData {
     [key: string]: unknown;
     /** How many things the operation handled. */
@@ -176,11 +170,10 @@ declare interface LogData {
 }
 
 /**
- * Transient logger, so each injecting class gets its own instance. Each
- * consumer calls `setContext(ClassName.name)`. Backed by pino: JSON in
- * production, pretty-printed in development. Messages start with an emoji
- * naming the subject, then a verb in present progressive or past tense.
- * Varying values such as counts go in `data`, so messages stay groupable.
+ * Transient logger, so each injecting class gets its own instance. Consumers
+ * call `setContext(ClassName.name)`. Backed by pino: JSON in production,
+ * pretty-printed in development. Messages start with an emoji naming the subject,
+ * then a present or past-tense verb. Varying values such as counts go in `data`.
  */
 declare @Injectable({ scope: Scope.TRANSIENT })
 class LoggerService
@@ -198,7 +191,7 @@ implements LoggerServiceContract
     private static readonly isProduction =
     process.env["NODE_ENV"] === "production";
 
-    /** Built on first use, so `logToStandardError` can still choose the destination after import. */
+    /** Built lazily, so `logToStandardError` can still set the destination. */
     private static rootLogger: pino.Logger | undefined;
 
     /** Whether lines go to standard error instead of standard output. */
@@ -458,7 +451,7 @@ implements LoggerServiceContract
     }
 }
 
-/** The public logger shape used to type test doubles without importing its service. */
+/** Public logger shape, for test doubles without the service. */
 declare interface LoggerServiceContract extends ConsoleLogger {
     /** Normalizes unknown errors into a stable message and timestamped log line. */
     buildErrorLogEntry(
@@ -473,10 +466,10 @@ declare interface LoggerServiceContract extends ConsoleLogger {
     info(message: unknown, context?: string, data?: LogData): void;
 }
 
-/** Heading over stacks deeper than their project allows. A constant, so a reader grepping a failed run finds the same text in both renderings. */
+/** Heading for stacks deeper than allowed, identical in both renderings. */
 export declare const MARKDOWN_DEEP_STACKS_HEADING = "Call stacks over the depth limit";
 
-/** How each anchored destination draws its stacks. One list, so `mermaid` can never start printing trees by accident. */
+/** How each anchored destination draws stacks. Keeps `mermaid` from printing trees. */
 export declare const MARKDOWN_DESTINATION_RENDERINGS: readonly [readonly ["markdown", "tree"], readonly ["mermaid", "diagram"]];
 
 /** Header of the depth-headroom scoreboard. */
@@ -497,9 +490,8 @@ export declare const MARKDOWN_WIDE_CALLABLES_HEADING = "Callables over the bread
 /**
  * Renders a run, or one project's slice of it, as markdown.
  *
- * Markdown rather than a bespoke text format because the same rendering has to
- * serve three places — a terminal, a report file, and a section spliced into a
- * project's own README — and only one of those can read anything else.
+ * Markdown serves a terminal, a report file, and a section spliced into a
+ * project's README alike. Only markdown reads well in all three.
  */
 export declare class MarkdownReportService {
     private readonly mermaidReportService;
@@ -558,19 +550,16 @@ export declare class MarkdownReportService {
     renderStacks(args: RenderStacksArguments): string;
 }
 
-/** Callables a diagram draws before it stops accepting stacks. GitHub refuses mermaid blocks past 50,000 characters; whole stacks drop, never trimmed. */
+/** Callables a diagram draws, since GitHub caps mermaid at 50,000 characters. */
 export declare const MAXIMUM_DIAGRAM_NODES = 300;
 
-/** Opens every diagram, left to right: the direction a stack reads and a wide, shallow graph fits a page. */
+/** Opens every diagram left to right, the way a stack reads. */
 export declare const MERMAID_FLOWCHART_HEADER = "flowchart LR";
 
 /** What mermaid would read as syntax inside a node label. */
 export declare const MERMAID_LABEL_ESCAPES: ReadonlyMap<string, string>;
 
-/**
- * A diagram under construction. Mutable on purpose, since nodes and edges accumulate across every
- * stack drawn.
- */
+/** A diagram under construction. Mutable, since stacks add nodes and edges. */
 export declare interface MermaidDiagram {
     readonly edges: Set<string>;
     readonly identifiersByCallable: Map<CallableId, string>;
@@ -606,7 +595,7 @@ export declare class MermaidReportService {
     }): string;
 }
 
-/** Frames a stack needs before a report carries it. A single frame is a callable that calls nothing, not a call stack. */
+/** Fewest frames a reported stack needs; one frame is a callable. */
 export declare const MINIMUM_STACK_FRAMES = 2;
 
 /** Raised when the anchor helper is asked to write a file nothing named. */
@@ -656,10 +645,9 @@ export declare class OutputMarkdownModule {
 /**
  * Splices a generated block into a markdown file, between two anchors.
  *
- * Staleness is decided by comparing the extracted block against the
- * regenerated one, byte for byte. A file with no anchors, or no file at all,
- * counts as stale rather than as an error, so check mode reports the same thing
- * whether the block drifted or was never written.
+ * Staleness compares the extracted block with the regenerated one, byte for byte.
+ * A missing file or anchor counts as stale, not as an error, so check mode
+ * reports drift and absence alike.
  */
 export declare class OutputMarkdownService {
     private readonly logger;
@@ -701,13 +689,13 @@ export declare interface OwnedFindings {
     readonly wideCallables: readonly WideCallableFinding[];
 }
 
-/** A message split into the emoji the console shows and the prose telemetry stores. */
+/** Message split into emoji and the prose telemetry stores. */
 declare interface ParsedLogMessage {
     emoji: string | undefined;
     text: string;
 }
 
-/** One project's row in the index, and the numbers the scoreboard buckets it by. */
+/** One project's index row and the scoreboard's bucketing numbers. */
 export declare interface ProjectIndexRow {
     readonly deepest: number;
     readonly headroom: number;
@@ -725,9 +713,8 @@ export declare class ProjectReportsModule {
 /**
  * Scopes a run's findings to the project each one came from.
  *
- * A section embedded in a project's README should describe that project, not
- * the workspace it happens to sit in, so everything here is keyed on the
- * project the entry point — or the reported callable — belongs to.
+ * A project's README section should describe that project, not the workspace it
+ * sits in, so everything is keyed on the owning project of the entry point or callable.
  */
 export declare class ProjectReportsService {
     private readonly pathsService;
@@ -806,9 +793,7 @@ declare interface RenderDepthReportsArguments {
     readonly reports: readonly DepthReport[];
 }
 
-/**
- * Arguments for rendering only the findings a gate weighs, not the whole run it measured.
- */
+/** Arguments for rendering only the findings a gate weighs. */
 export declare interface RenderFindingsArguments extends OwnedFindings {
     readonly previewCount: number;
 }
@@ -864,13 +849,11 @@ export declare class ReportFindingsModule {
 }
 
 /**
- * Weighs every finding a run can produce, and fails on the ones it was asked
- * to gate.
+ * Weighs every finding a run produces, failing on the ones it gates.
  *
- * Kept away from `CallidescopeCommand` itself, the same reason `RunPlanService`
- * is: what a run does with what it found is a question this service answers on
- * its own — through `this.logger` alone — leaving the command to orchestrate
- * the trace rather than weigh its output.
+ * Kept apart from `CallidescopeCommand`, as `RunPlanService` is: this service
+ * decides on its own what a run does with its findings, through `this.logger`,
+ * leaving the command to orchestrate the trace.
  */
 export declare class ReportFindingsService {
     private readonly logger;
@@ -938,19 +921,19 @@ export declare class ReportService {
     }): string;
 }
 
-/** Stands in for the workspace root when it is itself a traced project. */
+/** Names the workspace root when it is a traced project. */
 export declare const ROOT_PROJECT_LABEL = ".";
 
-/** Ends a sentence when the next one starts. The capital after the space tells a break from `e.g.` or a dotted identifier. */
+/** Sentence break: a capital must follow, so `e.g.` does not split. */
 export declare const SENTENCE_END_PATTERN: RegExp;
 
-/** Characters of signature a frame prints before collapsing the parameters. Long injected constructors would otherwise break the stack's shape. */
+/** Signature characters a frame prints before parameters collapse. */
 export declare const SIGNATURE_LIMIT = 80;
 
-/** How a report draws its stacks. Narrower than the output format: `json` is a different report, not a drawing of this one. */
+/** How a report draws stacks. Excludes `json`, which is no drawing. */
 export declare type StackRendering = "diagram" | "tree";
 
-/** Characters of documentation prose a printed frame keeps. The tree orients a reader; the JSON report keeps the whole comment. */
+/** Documentation characters a printed frame keeps. JSON keeps all of it. */
 export declare const SUMMARY_LIMIT = 120;
 
 /** Introduces the documentation line printed under a frame. */
@@ -982,10 +965,7 @@ export declare interface SyncJsonArguments extends BuildReportArguments {
     readonly check: boolean;
 }
 
-/**
- * Arguments for syncing the configured markdown destination. The markdown arrives already
- * rendered; this only decides where it lands.
- */
+/** Arguments for syncing the markdown destination, already rendered. */
 export declare interface SyncMarkdownArguments {
     readonly check: boolean;
     readonly content: string;
@@ -1010,10 +990,11 @@ export declare interface SyncProjectSectionsArguments {
 export declare const TRUNCATION_SUFFIX = "\u2026";
 
 /**
- * Renders what a whole run says about the projects in it, rather than one callable or stack.
+ * Renders what a whole run says about the projects in it.
  *
- * Its two sections are the index and the scoreboard: which project holds what, and how much room
- * each has before its own limit stops it. Both key on each project's resolved limit.
+ * Two sections: the index and the scoreboard, showing which project holds what
+ * and how much room each has before its own limit stops it. Both key on each
+ * project's resolved limit.
  */
 export declare class WorkspaceReportService {
     constructor();

package/package.json

@@ -4,9 +4,9 @@
     "url": "https://github.com/organizzolini/codebase/issues"
   },
   "dependencies": {
-    "@callidescope/configuration": "0.0.79",
-    "@callidescope/core": "0.0.78",
-    "@callidescope/graph": "0.0.78",
+    "@callidescope/configuration": "0.0.81",
+    "@callidescope/core": "0.0.80",
+    "@callidescope/graph": "0.0.80",
     "@nestjs/common": "^11.1.21 || ^12.0.1",
     "pino": "^10.3.1",
     "pino-pretty": "^13.1.3",
@@ -63,5 +63,5 @@
     "strict": true
   },
   "types": "./dist/src/index.d.ts",
-  "version": "0.0.78"
+  "version": "0.0.80"
 }