patram 0.11.0 → 0.12.0

package/lib/output/renderers/json.js

@@ -103,7 +103,7 @@ function renderJsonShowOutput(output_view) {
 
 /**
  * @param {OutputNodeItem} output_item
- * @returns {{ '$class': string, '$id': string, '$path'?: string, derived?: Record<string, boolean | number | string | null>, derived_summary?: string, fields: Record<string, string | string[]>, title: string }}
+ * @returns {{ '$class': string, '$id': string, '$path'?: string, fields: Record<string, string | string[]>, title: string }}
  */
 function formatJsonQueryItem(output_item) {
   return formatJsonNodeItem(output_item);
@@ -111,10 +111,10 @@ function formatJsonQueryItem(output_item) {
 
 /**
  * @param {OutputNodeItem} output_item
- * @returns {{ '$class': string, '$id': string, '$path'?: string, derived?: Record<string, boolean | number | string | null>, derived_summary?: string, fields: Record<string, string | string[]>, title: string }}
+ * @returns {{ '$class': string, '$id': string, '$path'?: string, fields: Record<string, string | string[]>, title: string }}
  */
 function formatJsonNodeItem(output_item) {
-  /** @type {{ '$class': string, '$id': string, '$path'?: string, derived?: Record<string, boolean | number | string | null>, derived_summary?: string, fields: Record<string, string | string[]>, title: string }} */
+  /** @type {{ '$class': string, '$id': string, '$path'?: string, fields: Record<string, string | string[]>, title: string }} */
   const query_item = {
     $class: output_item.node_kind,
     $id: output_item.id,
@@ -126,16 +126,6 @@ function formatJsonNodeItem(output_item) {
     query_item.$path = output_item.path;
   }
 
-  if (output_item.derived_summary) {
-    query_item.derived_summary = output_item.derived_summary.name;
-    query_item.derived = Object.fromEntries(
-      output_item.derived_summary.fields.map((field) => [
-        field.name,
-        field.value,
-      ]),
-    );
-  }
-
   return query_item;
 }
 
@@ -159,10 +149,10 @@ function formatJsonStoredQuery(output_item) {
 
 /**
  * @param {OutputResolvedLinkItem} output_item
- * @returns {{ label: string, reference: number, target: { '$class': string, '$id': string, '$path'?: string, derived?: Record<string, boolean | number | string | null>, derived_summary?: string, fields: Record<string, string | string[]>, title: string } }}
+ * @returns {{ label: string, reference: number, target: { '$class': string, '$id': string, '$path'?: string, fields: Record<string, string | string[]>, title: string } }}
  */
 function formatJsonResolvedLink(output_item) {
-  /** @type {{ label: string, reference: number, target: { '$class': string, '$id': string, '$path'?: string, derived?: Record<string, boolean | number | string | null>, derived_summary?: string, fields: Record<string, string | string[]>, title: string } }} */
+  /** @type {{ label: string, reference: number, target: { '$class': string, '$id': string, '$path'?: string, fields: Record<string, string | string[]>, title: string } }} */
   const resolved_link = {
     reference: output_item.reference,
     label: output_item.label,
@@ -178,16 +168,5 @@ function formatJsonResolvedLink(output_item) {
     resolved_link.target.$path = output_item.target.path;
   }
 
-  if (output_item.target.derived_summary) {
-    resolved_link.target.derived_summary =
-      output_item.target.derived_summary.name;
-    resolved_link.target.derived = Object.fromEntries(
-      output_item.target.derived_summary.fields.map((field) => [
-        field.name,
-        field.value,
-      ]),
-    );
-  }
-
   return resolved_link;
 }

package/lib/output/renderers/plain.js

@@ -1,38 +1,53 @@
+/* eslint-disable max-lines */
 /**
  * @import { OutputNodeItem, OutputResolvedLinkItem, OutputStoredQueryItem, OutputView, QueryOutputView, RefsOutputView, ShowOutputView } from '../output-view.types.ts';
  */
 
 import {
-  formatOutputNodeMetadataRows,
-  formatResolvedLinkMetadataRows,
+  formatOutputNodeStoredMetadataRow,
+  formatResolvedLinkStoredMetadataRow,
 } from '../format-output-metadata.js';
+import {
+  formatCompactMetadataLabel,
+  formatCompactTitleRow,
+  getCompactLeftTitleWidth,
+  wrapCompactBodyText,
+} from '../compact-layout.js';
 import { formatNodeHeader } from '../format-node-header.js';
-import { formatOutputItemBlock } from '../format-output-item-block.js';
-import { layoutIncomingReferenceLines } from '../layout-incoming-references.js';
+import { formatStoredQueryBlock } from '../format-stored-query-block.js';
+import {
+  collectIncomingRefHeaders,
+  createIncomingTreeRenderOptions,
+  layoutIncomingReferenceLines,
+} from '../layout-incoming-references.js';
 import { layoutIncomingSummaryLines } from '../layout-incoming-summary-lines.js';
-import { layoutStoredQueries } from '../layout-stored-queries.js';
+import {
+  formatResolvedLinkBodyLines,
+  formatResolvedLinkHeader,
+} from '../resolved-link-layout.js';
 
 /**
  * Render the canonical plain output for one output view.
  *
  * @param {OutputView} output_view
+ * @param {{ is_tty?: boolean, terminal_width?: number }=} render_options
  * @returns {string}
  */
-export function renderPlainOutput(output_view) {
+export function renderPlainOutput(output_view, render_options = {}) {
   if (output_view.command === 'query') {
-    return renderPlainQueryOutput(output_view);
+    return renderPlainQueryOutput(output_view, render_options);
   }
 
   if (output_view.command === 'queries') {
-    return renderPlainStoredQueries(output_view);
+    return renderPlainStoredQueries(output_view, render_options);
   }
 
   if (output_view.command === 'refs') {
-    return renderPlainRefsOutput(output_view);
+    return renderPlainRefsOutput(output_view, render_options);
   }
 
   if (output_view.command === 'show') {
-    return renderPlainShowOutput(output_view);
+    return renderPlainShowOutput(output_view, render_options);
   }
 
   throw new Error('Unsupported output view command.');
@@ -40,20 +55,31 @@ export function renderPlainOutput(output_view) {
 
 /**
  * @param {QueryOutputView} output_view
+ * @param {{ is_tty?: boolean, terminal_width?: number }} render_options
  * @returns {string}
  */
-function renderPlainQueryOutput(output_view) {
+function renderPlainQueryOutput(output_view, render_options) {
   const footer = renderPlainQueryFooter(output_view.summary, output_view.hints);
 
   if (output_view.items.length === 0) {
     return renderPlainEmptyQuery(footer);
   }
 
+  const left_title_width = getCompactLeftTitleWidth(
+    output_view.items.map((output_item) => formatNodeHeader(output_item)),
+  );
+  const output_blocks = output_view.items.map((output_item) =>
+    formatPlainNodeItem(output_item, {
+      ...render_options,
+      left_title_width,
+    }),
+  );
+
   if (footer.length === 0) {
-    return `${output_view.items.map(formatPlainNodeItem).join('\n\n')}\n`;
+    return `${output_blocks.join('\n\n')}\n`;
   }
 
-  return `${output_view.items.map(formatPlainNodeItem).join('\n\n')}\n\n${footer}\n`;
+  return `${output_blocks.join('\n\n')}\n\n${footer}\n`;
 }
 
 /**
@@ -70,36 +96,46 @@ function renderPlainEmptyQuery(footer) {
 
 /**
  * @param {Extract<OutputView, { command: 'queries' }>} output_view
+ * @param {{ is_tty?: boolean, terminal_width?: number }} render_options
  * @returns {string}
  */
-function renderPlainStoredQueries(output_view) {
+function renderPlainStoredQueries(output_view, render_options) {
   if (output_view.items.length === 0) {
     return '';
   }
 
-  const output_lines = layoutStoredQueries(output_view.items).map(
-    formatPlainStoredQueryLine,
+  const output_blocks = output_view.items.map((output_item) =>
+    formatPlainStoredQueryBlock(output_item, render_options),
   );
 
   if (output_view.hints.length === 0) {
-    return `${output_lines.join('\n')}\n`;
+    return `${output_blocks.join('\n')}\n`;
   }
 
-  return `${output_lines.join('\n')}\n${output_view.hints.join('\n')}\n`;
+  return `${output_blocks.join('\n')}\n${output_view.hints.join('\n')}\n`;
 }
 
 /**
  * @param {ShowOutputView} output_view
+ * @param {{ is_tty?: boolean, terminal_width?: number }} render_options
  * @returns {string}
  */
-function renderPlainShowOutput(output_view) {
+function renderPlainShowOutput(output_view, render_options) {
   const rendered_source = trimTrailingLineBreaks(output_view.rendered_source);
   const incoming_summary = renderPlainIncomingSummary(output_view);
 
   if (output_view.items.length === 0 && incoming_summary.length === 0) {
     return `${rendered_source}\n`;
   }
-  const summary_blocks = output_view.items.map(formatPlainResolvedLinkItem);
+  const left_title_width = getCompactLeftTitleWidth(
+    output_view.items.map(formatResolvedLinkHeader),
+  );
+  const summary_blocks = output_view.items.map((output_item) =>
+    formatPlainResolvedLinkItem(output_item, {
+      ...render_options,
+      left_title_width,
+    }),
+  );
 
   if (incoming_summary.length > 0) {
     summary_blocks.push(incoming_summary);
@@ -110,11 +146,27 @@ function renderPlainShowOutput(output_view) {
 
 /**
  * @param {RefsOutputView} output_view
+ * @param {{ is_tty?: boolean, terminal_width?: number }} render_options
  * @returns {string}
  */
-function renderPlainRefsOutput(output_view) {
-  const node_summary = formatPlainNodeItem(output_view.node);
-  const output_lines = layoutIncomingReferenceLines(output_view.incoming);
+function renderPlainRefsOutput(output_view, render_options) {
+  const left_title_width = getCompactLeftTitleWidth(
+    collectIncomingRefHeaders(output_view),
+  );
+  const incoming_render_options =
+    createIncomingTreeRenderOptions(render_options);
+  const node_summary = formatPlainNodeItem(output_view.node, {
+    ...render_options,
+    left_title_width,
+  });
+  const output_lines = layoutIncomingReferenceLines(output_view.incoming, {
+    format_node_block(output_item) {
+      return formatPlainNodeItem(output_item, {
+        ...incoming_render_options,
+        left_title_width,
+      });
+    },
+  });
 
   if (output_lines.length === 0) {
     return `${node_summary}\n\nNo incoming references.\n`;
@@ -125,13 +177,51 @@ function renderPlainRefsOutput(output_view) {
 
 /**
  * @param {OutputNodeItem} output_item
+ * @param {{ is_tty?: boolean, left_title_width: number, terminal_width?: number }} render_options
  * @returns {string}
  */
-function formatPlainNodeItem(output_item) {
-  return formatOutputItemBlock({
-    header: formatNodeHeader(output_item),
-    metadata_rows: formatOutputNodeMetadataRows(output_item),
-    title: output_item.title,
+function formatPlainNodeItem(output_item, render_options) {
+  const metadata_label = formatStoredMetadataLabel(
+    formatOutputNodeStoredMetadataRow(output_item),
+  );
+  /** @type {string[]} */
+  const output_lines = [
+    formatCompactTitleRow({
+      is_tty: render_options.is_tty,
+      left_title: formatNodeHeader(output_item),
+      left_title_width: render_options.left_title_width,
+      right_title: metadata_label,
+      terminal_width: render_options.terminal_width,
+    }),
+  ];
+
+  output_lines.push(`  ${output_item.title}`);
+
+  if (output_item.description) {
+    for (const description_line of wrapCompactBodyText(
+      output_item.description,
+      render_options,
+    )) {
+      output_lines.push(
+        description_line.length > 0 ? `  ${description_line}` : '',
+      );
+    }
+  }
+
+  return output_lines.join('\n');
+}
+
+/**
+ * @param {OutputStoredQueryItem} output_item
+ * @param {{ is_tty?: boolean, terminal_width?: number }} render_options
+ * @returns {string}
+ */
+function formatPlainStoredQueryBlock(output_item, render_options) {
+  return formatStoredQueryBlock(output_item, render_options, {
+    format_line: formatPlainStoredQueryLine,
+    format_name(text) {
+      return text;
+    },
   });
 }
 
@@ -145,15 +235,33 @@ function formatPlainStoredQueryLine(line_segments) {
 
 /**
  * @param {OutputResolvedLinkItem} output_item
+ * @param {{ is_tty?: boolean, left_title_width: number, terminal_width?: number }} render_options
  * @returns {string}
  */
-function formatPlainResolvedLinkItem(output_item) {
-  return formatOutputItemBlock({
-    header: `[${output_item.reference}] ${output_item.target.kind} ${output_item.target.path ?? output_item.target.id}`,
-    metadata_rows: formatResolvedLinkMetadataRows(output_item.target),
-    metadata_indent: '    ',
-    title: output_item.target.title,
-  });
+function formatPlainResolvedLinkItem(output_item, render_options) {
+  const metadata_label = formatStoredMetadataLabel(
+    formatResolvedLinkStoredMetadataRow(output_item.target),
+  );
+  /** @type {string[]} */
+  const output_lines = [
+    formatCompactTitleRow({
+      is_tty: render_options.is_tty,
+      left_title: formatResolvedLinkHeader(output_item),
+      left_title_width: render_options.left_title_width,
+      right_title: metadata_label,
+      terminal_width: render_options.terminal_width,
+    }),
+  ];
+
+  output_lines.push(
+    ...formatResolvedLinkBodyLines(output_item, {
+      body_indent: '    ',
+      is_tty: render_options.is_tty,
+      terminal_width: render_options.terminal_width,
+    }),
+  );
+
+  return output_lines.join('\n');
 }
 
 /**
@@ -179,6 +287,18 @@ function hasIncomingSummary(incoming_summary) {
   return Object.keys(incoming_summary).length > 0;
 }
 
+/**
+ * @param {string | undefined} metadata_row
+ * @returns {string | undefined}
+ */
+function formatStoredMetadataLabel(metadata_row) {
+  if (!metadata_row) {
+    return undefined;
+  }
+
+  return formatCompactMetadataLabel([metadata_row]);
+}
+
 /**
  * @param {string} value
  * @returns {string}