@kud/gh-ink 0.53.0 → 0.54.0

package/dist/index.d.ts

@@ -66,19 +66,26 @@ type SidebarRow = {
      */
     url?: string;
 };
+/**
+ * Plain data, deliberately: a host caches its last fetch to disk and paints it
+ * on the next launch, and this rides along in that file. A function on it would
+ * not survive the round trip, so the host's words for `live` travel as a prop
+ * on `SidePanel` instead — vocabulary is configuration, not data that goes
+ * stale.
+ */
 type Sidebar = {
     /** Heading for the rail. The host's vocabulary, never ours. */
     title: string;
     rows: SidebarRow[];
-    /**
-     * What to call `live` on screen, in the host's words — `4 on board` and `off
-     * board` on a ticket cockpit, say. Takes the number rather than a word pair
-     * because the two states need not share a sentence shape: "off board" has no
-     * N in it. `live` itself stays a number, so the absent-draws-nothing contract
-     * and the host's sort are untouched.
-     */
-    liveLabel?: (live: number) => string;
 };
+/**
+ * What to call `live` on screen, in the host's words — `4 on board` and `off
+ * board` on a ticket cockpit, say. Takes the number rather than a word pair
+ * because the two states need not share a sentence shape: "off board" has no
+ * N in it. `live` itself stays a number, so the absent-draws-nothing contract
+ * and the host's sort are untouched.
+ */
+type LiveLabel = (live: number) => string;
 /**
  * The rail's width, INCLUDING its rule and padding. Exported because the list
  * beside it has to shrink by exactly this much: every row in that list truncates
@@ -91,8 +98,18 @@ type Sidebar = {
  * word and left the rail listing keys with an ellipsis after them. The key line
  * was never the constraint — the label is what makes a key readable, and a rail
  * you cannot read is forty columns spent on nothing.
+ *
+ * Widened again once the label became the row's first line: at 45 usable
+ * columns a real epic title still lost its last two words. But a 200-column
+ * terminal has room to give where a 120-column one does not — at 120 a rail
+ * this wide leaves the list 52 columns, which elides a PR title past its own
+ * key. So this is the CEILING, and `railWidth` sizes the rail to the frame:
+ * a third of it, never below the 52 the grid was laid out for, never above.
  */
-declare const SIDEBAR_COLS = 52;
+declare const SIDEBAR_COLS = 64;
+declare const MIN_SIDEBAR_COLS = 52;
+/** How wide the rail is in a frame of `cols` — pass the same number to `width`. */
+declare const railWidth: (cols: number) => number;
 /**
  * The plain-text facts of a row, for a host or a test that wants them as one
  * string: how far through, then how much is moving. Either half may be missing
@@ -100,7 +117,7 @@ declare const SIDEBAR_COLS = 52;
  * counted, because "nothing is moving" is exactly the thing a roadmap is read
  * to notice.
  */
-declare const counts: (row: SidebarRow, liveLabel?: (live: number) => string) => string;
+declare const counts: (row: SidebarRow, liveLabel?: LiveLabel) => string;
 /**
  * How many rows fit in `height` — one fewer than would physically fit whenever
  * that means anything is left over, to buy the line that says so.
@@ -126,8 +143,11 @@ declare const railCapacity: (height: number, rows: number) => number;
  * the arrows are pointed at this rail at all, are the host's state — which is
  * what lets a screen with two focus regions have exactly one of them lit.
  */
-declare const SidePanel: ({ sidebar, height, focused, cursor, }: {
+declare const SidePanel: ({ sidebar, liveLabel, width, height, focused, cursor, }: {
     sidebar: Sidebar;
+    liveLabel?: LiveLabel;
+    /** From `railWidth`, so the list beside it can subtract the same number. */
+    width?: number;
     height?: number;
     /** The arrows are pointed here, so this rail draws the cursor. */
     focused?: boolean;
@@ -192,12 +212,20 @@ type CachedCockpit = {
     login: string;
     at: number;
     budget?: InboxBudget;
+    /**
+     * The rail, when the host supplied one. Cached beside the rows because it is
+     * painted beside them: a launch that trusts the cache never refetches, so a
+     * rail left out of the file is a rail that does not exist until the next
+     * refresh — `i` did nothing and the footer did not even offer it.
+     */
+    sidebar?: Sidebar;
 };
 declare const readCache: (key: string) => CachedCockpit | null;
 declare const writeCache: (key: string, data: {
     sections: Section[];
     login: string;
     budget?: InboxBudget;
+    sidebar?: Sidebar;
 }) => void;
 
 type DetailContext = {
@@ -386,7 +414,7 @@ declare const ActionMenu: ({ item, actions, cursor, }: {
     cursor: number;
 }) => React.JSX.Element;
 declare const signatureOf: (sections: Section[]) => string;
-declare const App: ({ fetcher, cacheKey, title, detailFor, origin, jiraBase, jiraKeyRe, jiraTransitions, hasCiStatus, ciJob, ciFetcher, ciPollMs, watchPath, watchDebounceMs, watchJitterMs, extensions, tabHelp, emptyHint, }: {
+declare const App: ({ fetcher, cacheKey, title, detailFor, origin, jiraBase, jiraKeyRe, jiraTransitions, hasCiStatus, ciJob, ciFetcher, ciPollMs, watchPath, watchDebounceMs, watchJitterMs, extensions, tabHelp, emptyHint, liveLabel, }: {
     fetcher: () => Promise<{
         sections: Section[];
         login: string;
@@ -409,6 +437,13 @@ declare const App: ({ fetcher, cacheKey, title, detailFor, origin, jiraBase, jir
         sidebar?: Sidebar;
     }>;
     cacheKey?: string;
+    /**
+     * What the rail calls a row's `live` count, in this host's words — `4 on
+     * board` / `off board` on a ticket cockpit. A prop rather than part of the
+     * fetch result because it is vocabulary, not data: it never goes stale, and
+     * a function would not survive the cache the sidebar is painted from.
+     */
+    liveLabel?: LiveLabel;
     title?: string;
     detailFor?: (ctx: DetailContext) => React.ReactNode;
     /** A two-way repo split, and what to call the side on screen. See OriginSplit. */
@@ -461,4 +496,4 @@ declare const matchesFilter: (repo: string, filter: RepoFilter) => boolean;
  */
 declare const parsePatterns: (value: string) => string[];
 
-export { type Action, ActionMenu, App, COLS, CiStatusLine, type CiStatusState, CommentsPanel, type CommentsPanelProps, type DetailContext, type ExplainSection, type ExtensionTarget, HealthPanel, type HealthPanelProps, type InboxBudget, type InboxExtension, type JiraTransition, type RepoFilter, SIDEBAR_COLS, SidePanel, type Sidebar, type SidebarRow, budgetNotice, buildActions, buildCheckoutCmd, clipboard, counts, drillCmd, explainGhAction, explainItem, fitCount, gapsAbove, healthColor, healthDisplay, healthGlyph, healthLegend, itermRun, jumpToRepo, jumpToRepoPane, matchesFilter, maxViewStart, moveCursor, openInTab, parsePatterns, railCapacity, readCache, renderMarkdown, reposInSections, resolveRepoPath, runHere, runInPane, runInPaneHorizontal, sameCiStatusState, signatureOf, toCiStatusState, truncate, useActionMenu, windowCount, withHeaders, withoutItem, workCount, writeCache };
+export { type Action, ActionMenu, App, COLS, CiStatusLine, type CiStatusState, CommentsPanel, type CommentsPanelProps, type DetailContext, type ExplainSection, type ExtensionTarget, HealthPanel, type HealthPanelProps, type InboxBudget, type InboxExtension, type JiraTransition, type LiveLabel, MIN_SIDEBAR_COLS, type RepoFilter, SIDEBAR_COLS, SidePanel, type Sidebar, type SidebarRow, budgetNotice, buildActions, buildCheckoutCmd, clipboard, counts, drillCmd, explainGhAction, explainItem, fitCount, gapsAbove, healthColor, healthDisplay, healthGlyph, healthLegend, itermRun, jumpToRepo, jumpToRepoPane, matchesFilter, maxViewStart, moveCursor, openInTab, parsePatterns, railCapacity, railWidth, readCache, renderMarkdown, reposInSections, resolveRepoPath, runHere, runInPane, runInPaneHorizontal, sameCiStatusState, signatureOf, toCiStatusState, truncate, useActionMenu, windowCount, withHeaders, withoutItem, workCount, writeCache };

package/dist/index.js

@@ -585,18 +585,19 @@ var HealthPanel = ({
     ] }) }) : note ? /* @__PURE__ */ jsx(Box, { marginTop: 1, children: /* @__PURE__ */ jsx(Text, { color: colors.success, children: "  " + note }) }) : null
   ] });
 };
-var SIDEBAR_COLS = 52;
+var SIDEBAR_COLS = 64;
+var MIN_SIDEBAR_COLS = 52;
+var railWidth = (cols) => Math.max(MIN_SIDEBAR_COLS, Math.min(SIDEBAR_COLS, Math.round(cols / 3)));
 var RULE = 1;
 var PAD = 2;
-var CONTENT = SIDEBAR_COLS - RULE - PAD;
+var contentOf = (width) => width - RULE - PAD;
 var MARKS = 4;
-var LABEL_COLS = CONTENT - MARKS;
 var FACTS_INDENT = 6;
 var KEY_COLS = 10;
 var BAR_COLS = 10;
 var FRACTION_COLS = 5;
 var GUTTER = "  ";
-var LIVE_COLS = CONTENT - FACTS_INDENT - KEY_COLS - BAR_COLS - FRACTION_COLS - GUTTER.length * 3;
+var FACTS_FIXED = FACTS_INDENT + KEY_COLS + BAR_COLS + FRACTION_COLS + GUTTER.length * 3;
 var defaultLiveLabel = (live) => live === 0 ? "nothing live" : `${live} live`;
 var fractionOf = (row) => row.done !== void 0 && row.total !== void 0 ? `${row.done}/${row.total}` : "";
 var counts = (row, liveLabel = defaultLiveLabel) => [fractionOf(row), row.live !== void 0 ? liveLabel(row.live) : ""].filter(Boolean).join(" \xB7 ");
@@ -634,18 +635,22 @@ var Progress = ({ row }) => {
 };
 var SidePanel = ({
   sidebar,
+  liveLabel = defaultLiveLabel,
+  width = SIDEBAR_COLS,
   height,
   focused = false,
   cursor = 0
 }) => {
-  const liveLabel = sidebar.liveLabel ?? defaultLiveLabel;
+  const content = contentOf(width);
+  const labelCols = content - MARKS;
+  const liveCols = content - FACTS_FIXED;
   const capacity = height === void 0 ? sidebar.rows.length : railCapacity(height, sidebar.rows.length);
   const start = focused && cursor >= capacity ? Math.min(cursor - capacity + 1, sidebar.rows.length - capacity) : 0;
   const shown = sidebar.rows.slice(start, start + capacity);
   const hidden = sidebar.rows.length - shown.length;
   const focus = focused ? "  \u25CF focus" : "";
   const rule = "\u254C".repeat(
-    Math.max(0, CONTENT - [...sidebar.title].length - focus.length - 1)
+    Math.max(0, content - [...sidebar.title].length - focus.length - 1)
   );
   return (
     // A rule down the left rather than a full box: the rail's other three edges
@@ -658,7 +663,7 @@ var SidePanel = ({
       Box,
       {
         flexDirection: "column",
-        width: SIDEBAR_COLS,
+        width,
         flexShrink: 0,
         height,
         borderStyle: "single",
@@ -679,12 +684,12 @@ var SidePanel = ({
               /* @__PURE__ */ jsxs(Box, { children: [
                 /* @__PURE__ */ jsx(Text, { color: colors.info, children: active ? "\u276F " : "  " }),
                 /* @__PURE__ */ jsx(Text, { color: colors.accent, bold: true, children: row.wantsYou ? "\u2190 " : "  " }),
-                /* @__PURE__ */ jsx(Text, { bold: active, children: truncateWords(row.label, LABEL_COLS) })
+                /* @__PURE__ */ jsx(Text, { bold: active, children: truncateWords(row.label, labelCols) })
               ] }),
               /* @__PURE__ */ jsxs(Box, { paddingLeft: FACTS_INDENT, children: [
                 /* @__PURE__ */ jsx(Text, { color: colors.secondary, children: row.key.padEnd(KEY_COLS) + GUTTER }),
                 /* @__PURE__ */ jsx(Progress, { row }),
-                /* @__PURE__ */ jsx(Text, { children: GUTTER + (row.live !== void 0 ? liveLabel(row.live).slice(0, LIVE_COLS) : "") })
+                /* @__PURE__ */ jsx(Text, { children: GUTTER + (row.live !== void 0 ? liveLabel(row.live).slice(0, liveCols) : "") })
               ] })
             ] }, row.key);
           }),
@@ -757,7 +762,8 @@ var readCache = (key) => {
       sections: raw.sections,
       login: raw.login ?? "",
       at: raw.at ?? 0,
-      budget: raw.budget
+      budget: raw.budget,
+      ...Array.isArray(raw.sidebar?.rows) ? { sidebar: raw.sidebar } : {}
     };
   } catch {
     return null;
@@ -2401,7 +2407,8 @@ var BrowseScreen = ({
   onLeave,
   transients,
   onTabChange,
-  sidebar
+  sidebar,
+  liveLabel
 }) => {
   const { rows } = useWindowSize();
   const { exit } = useApp();
@@ -2525,7 +2532,8 @@ var BrowseScreen = ({
   const railRows = sidebar?.rows ?? [];
   const railActive = showRail && railFocus && railRows.length > 0;
   const railAt = Math.min(railCursor, Math.max(0, railRows.length - 1));
-  const listCols = showRail ? COLS - SIDEBAR_COLS : COLS;
+  const railCols = railWidth(COLS);
+  const listCols = showRail ? COLS - railCols : COLS;
   const [sparkFrame, setSparkFrame] = useState(0);
   const sparkling = (mergedUrls?.length ?? 0) > 0 || (leavingUrls?.length ?? 0) > 0 || // Any MARKED TAB, not just rows on screen. The scope used to be this tab's
   // own items, which was right while the animation lived on the rows and is
@@ -3152,6 +3160,8 @@ var BrowseScreen = ({
             SidePanel,
             {
               sidebar,
+              liveLabel,
+              width: railCols,
               height: listHeight,
               focused: railActive,
               cursor: railAt
@@ -3214,7 +3224,8 @@ var App = ({
   watchJitterMs = 0,
   extensions,
   tabHelp,
-  emptyHint
+  emptyHint,
+  liveLabel
 }) => {
   const { rows } = useWindowSize();
   const [state, setState] = useState({ phase: "loading" });
@@ -3391,6 +3402,7 @@ var App = ({
       displayedKey.current = signatureOf(cached.sections);
       displayedSections.current = cached.sections;
       setFetchedAt(cached.at);
+      if (cached.sidebar) setSidebar(cached.sidebar);
       setState({
         phase: "browse",
         sections: cached.sections,
@@ -3435,6 +3447,7 @@ var App = ({
           const shared = cacheKey ? readCache(cacheKey) : null;
           if (shared && shared.at > firedAt) {
             receive({ sections: shared.sections, login: shared.login });
+            if (shared.sidebar) setSidebar(shared.sidebar);
             setFetchedAt(shared.at);
             return;
           }
@@ -3579,6 +3592,7 @@ var App = ({
         transients,
         onTabChange: setVisibleTab,
         sidebar,
+        liveLabel,
         ciStatusState: hasCiStatus ? ciStatusState : void 0,
         ciJob,
         tabHelp,
@@ -3631,4 +3645,4 @@ var matchesFilter = (repo, filter) => {
 };
 var parsePatterns = (value) => value.split(",").map((p) => p.trim()).filter(Boolean);
 
-export { ActionMenu, App, COLS, CiStatusLine, CommentsPanel, HealthPanel, SIDEBAR_COLS, SidePanel, budgetNotice, buildActions, buildCheckoutCmd, clipboard, counts, drillCmd, explainGhAction, explainItem, fitCount, gapsAbove, healthColor, healthDisplay, healthGlyph, healthLegend, itermRun, jumpToRepo, jumpToRepoPane, matchesFilter, maxViewStart, moveCursor, openInTab, parsePatterns, railCapacity, readCache, renderMarkdown, reposInSections, resolveRepoPath, runHere, runInPane, runInPaneHorizontal, sameCiStatusState, signatureOf, toCiStatusState, truncate, useActionMenu, windowCount, withHeaders, withoutItem, workCount, writeCache };
+export { ActionMenu, App, COLS, CiStatusLine, CommentsPanel, HealthPanel, MIN_SIDEBAR_COLS, SIDEBAR_COLS, SidePanel, budgetNotice, buildActions, buildCheckoutCmd, clipboard, counts, drillCmd, explainGhAction, explainItem, fitCount, gapsAbove, healthColor, healthDisplay, healthGlyph, healthLegend, itermRun, jumpToRepo, jumpToRepoPane, matchesFilter, maxViewStart, moveCursor, openInTab, parsePatterns, railCapacity, railWidth, readCache, renderMarkdown, reposInSections, resolveRepoPath, runHere, runInPane, runInPaneHorizontal, sameCiStatusState, signatureOf, toCiStatusState, truncate, useActionMenu, windowCount, withHeaders, withoutItem, workCount, writeCache };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kud/gh-ink",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "description": "Ink components for rendering GitHub PR review comments and health — controlled, presentation-only, built on @kud/ink-ui and fed by @kud/gh.",
   "type": "module",
   "main": "dist/index.js",