gloomberb 0.5.1 → 0.6.0

package/src/plugins/builtin/help.tsx

@@ -1,51 +1,58 @@
-import { TextAttributes } from "@opentui/core";
+import { Box, ScrollBox, Text, useUiHost } from "../../ui";
+import { TextAttributes } from "../../ui";
 import { useState } from "react";
 import type { ReactNode } from "react";
-import type { GloomPlugin, PaneProps } from "../../types/plugin";
+import type { CommandDef, GloomPlugin, KeyboardShortcut, PaneProps } from "../../types/plugin";
 import { colors, hoverBg } from "../../theme/colors";
 import { getSharedRegistry } from "../registry";
+import { usePluginAppActions } from "../plugin-runtime";
+import { commands as coreCommands } from "../../components/command-bar/command-registry";
+import { detectShortcutPlatform, formatPrimaryShortcut, getShortcutDisplayMode } from "../../utils/shortcut-labels";
 
 function ShortcutBadge({ label }: { label: string }) {
   return (
-    <box backgroundColor={colors.selected}>
-      <text fg={colors.selectedText} attributes={TextAttributes.BOLD}>
+    <Box backgroundColor={colors.selected}>
+      <Text fg={colors.selectedText} attributes={TextAttributes.BOLD}>
         {` ${label} `}
-      </text>
-    </box>
+      </Text>
+    </Box>
   );
 }
 
 function ShortcutRow({
   badges,
   description,
-  compact,
 }: {
   badges: string[];
   description: string;
-  compact: boolean;
 }) {
   return (
-    <box flexDirection={compact ? "column" : "row"} gap={1}>
-      <box flexDirection="row" gap={1} flexShrink={0}>
+    <Box flexDirection="row" gap={1}>
+      <Box flexDirection="row" gap={1} flexShrink={0}>
         {badges.map((badge) => <ShortcutBadge key={badge} label={badge} />)}
-      </box>
-      <box flexGrow={1}>
-        <text fg={colors.text}>{description}</text>
-      </box>
-    </box>
+      </Box>
+      <Box flexGrow={1}>
+        <Text fg={colors.text} wrapText>{description}</Text>
+      </Box>
+    </Box>
   );
 }
 
 function HelpSection({ title, children }: { title: string; children: ReactNode }) {
   return (
-    <box flexDirection="column">
-      <text fg={colors.textBright} attributes={TextAttributes.BOLD}>{title}</text>
-      <box height={1} />
+    <Box flexDirection="column" marginTop={1}>
+      <Text fg={colors.textBright} attributes={TextAttributes.BOLD}>{title}</Text>
       {children}
-    </box>
+    </Box>
   );
 }
 
+interface HelpShortcutEntry {
+  id: string;
+  badges: string[];
+  description: string;
+}
+
 function ActionButton({
   id,
   label,
@@ -60,7 +67,7 @@ function ActionButton({
   onPress: () => void;
 }) {
   return (
-    <box
+    <Box
       backgroundColor={hovered ? hoverBg() : colors.panel}
       onMouseMove={() => onHover(id)}
       onMouseOut={() => onHover(null)}
@@ -70,15 +77,15 @@ function ActionButton({
         onPress();
       }}
     >
-      <text fg={hovered ? colors.textBright : colors.text}>{` ${label} `}</text>
-    </box>
+      <Text fg={hovered ? colors.textBright : colors.text}>{` ${label} `}</Text>
+    </Box>
   );
 }
 
 function resolveWindowTemplates(registry: ReturnType<typeof getSharedRegistry>) {
   if (!registry || !registry.paneTemplates) return [];
 
-  const disabledPlugins = new Set(registry.getConfigFn?.().disabledPlugins ?? []);
+  const disabledPlugins = resolveDisabledPlugins(registry);
   const allPlugins = registry.allPlugins ?? new Map<string, { name?: string }>();
 
   return [...registry.paneTemplates.values()]
@@ -106,37 +113,149 @@ function resolveWindowTemplates(registry: ReturnType<typeof getSharedRegistry>)
     ));
 }
 
+function resolveDisabledPlugins(registry: ReturnType<typeof getSharedRegistry>): Set<string> {
+  try {
+    return new Set(registry?.getConfigFn?.().disabledPlugins ?? []);
+  } catch {
+    return new Set();
+  }
+}
+
+function formatPlaceholder(value: string | undefined): string | null {
+  return value ? `<${value}>` : null;
+}
+
+function withPluginName(description: string | undefined, pluginName: string | null | undefined): string {
+  const base = description?.trim() || "Run command";
+  return pluginName ? `${base} (${pluginName})` : base;
+}
+
+function resolveCommandShortcuts(registry: ReturnType<typeof getSharedRegistry>): HelpShortcutEntry[] {
+  const coreRows: HelpShortcutEntry[] = coreCommands
+    .filter((command) => command.prefix.trim().length > 0)
+    .map((command) => ({
+      id: `core:${command.id}`,
+      badges: [
+        command.prefix.toUpperCase(),
+        formatPlaceholder(command.argPlaceholder),
+      ].filter((value): value is string => !!value),
+      description: command.description,
+    }));
+
+  if (!registry || !registry.commands) return coreRows;
+
+  const disabledPlugins = resolveDisabledPlugins(registry);
+  const allPlugins = registry.allPlugins ?? new Map<string, { name?: string }>();
+  const pluginRows = [...registry.commands.values()]
+    .filter((command: CommandDef) => command.shortcut?.trim().length)
+    .filter((command: CommandDef) => {
+      const pluginId = registry.getCommandPluginId?.(command.id);
+      if (pluginId && disabledPlugins.has(pluginId)) return false;
+      return !(command.hidden?.() ?? false);
+    })
+    .map((command: CommandDef) => {
+      const pluginId = registry.getCommandPluginId?.(command.id);
+      const pluginName = pluginId ? allPlugins.get(pluginId)?.name : null;
+      return {
+        id: `plugin-command:${command.id}`,
+        badges: [
+          command.shortcut!.toUpperCase(),
+          formatPlaceholder(command.shortcutArg?.placeholder),
+        ].filter((value): value is string => !!value),
+        description: withPluginName(command.label, pluginName),
+      };
+    })
+    .sort((left, right) => (
+      left.badges.join(" ").localeCompare(right.badges.join(" "))
+      || left.description.localeCompare(right.description)
+    ));
+
+  return [...coreRows, ...pluginRows];
+}
+
+function formatShortcutKey(shortcut: KeyboardShortcut): string {
+  const key = shortcut.key.length === 1
+    ? shortcut.key.toUpperCase()
+    : shortcut.key[0]!.toUpperCase() + shortcut.key.slice(1);
+  return [
+    shortcut.ctrl ? "Ctrl" : null,
+    shortcut.shift ? "Shift" : null,
+    key,
+  ].filter((value): value is string => !!value).join("+");
+}
+
+function resolvePluginShortcuts(registry: ReturnType<typeof getSharedRegistry>): HelpShortcutEntry[] {
+  if (!registry || !registry.shortcuts) return [];
+
+  const disabledPlugins = resolveDisabledPlugins(registry);
+  const allPlugins = registry.allPlugins ?? new Map<string, { name?: string }>();
+  return [...registry.shortcuts.values()]
+    .filter((shortcut: KeyboardShortcut) => {
+      const pluginId = registry.getShortcutPluginId?.(shortcut.id);
+      return !pluginId || !disabledPlugins.has(pluginId);
+    })
+    .map((shortcut: KeyboardShortcut) => {
+      const pluginId = registry.getShortcutPluginId?.(shortcut.id);
+      const pluginName = pluginId ? allPlugins.get(pluginId)?.name : null;
+      return {
+        id: `plugin-shortcut:${shortcut.id}`,
+        badges: [formatShortcutKey(shortcut)],
+        description: withPluginName(shortcut.description, pluginName),
+      };
+    })
+    .sort((left, right) => (
+      left.badges.join(" ").localeCompare(right.badges.join(" "))
+      || left.description.localeCompare(right.description)
+    ));
+}
+
 export function HelpPane({ width, height }: PaneProps) {
   const registry = getSharedRegistry();
-  const compact = width < 78;
+  const { openCommandBar, showWidget } = usePluginAppActions();
   const [hoveredAction, setHoveredAction] = useState<string | null>(null);
+  const commandShortcuts = resolveCommandShortcuts(registry);
+  const pluginShortcuts = resolvePluginShortcuts(registry);
   const windowTemplates = resolveWindowTemplates(registry);
+  const uiHost = useUiHost();
+  const isDesktopWeb = uiHost.kind === "desktop-web";
+  const shortcutPlatform = detectShortcutPlatform();
+  const shortcutDisplayMode = getShortcutDisplayMode(uiHost.kind);
+  const platformShortcut = (keys: string | readonly string[]) => formatPrimaryShortcut(keys, shortcutPlatform, shortcutDisplayMode);
+  const commandBarBadges = shortcutDisplayMode === "terminal"
+    ? ["Ctrl+P", "`"]
+    : ["Ctrl+P", platformShortcut("K"), "`"];
+  const copyBadges = shortcutDisplayMode === "terminal"
+    ? ["Ctrl+Shift+C"]
+    : [platformShortcut("C")];
+  const pasteBadges = shortcutDisplayMode === "terminal"
+    ? ["Ctrl+Shift+V"]
+    : [platformShortcut("V")];
 
   const openDebugLog = () => {
-    registry?.showWidget("debug");
+    showWidget("debug");
   };
 
   const openLayoutActions = () => {
-    registry?.openCommandBarFn("LAY ");
+    openCommandBar("LAY ");
   };
 
   const openPluginManager = () => {
-    registry?.openCommandBarFn("PL ");
+    openCommandBar("PL ");
   };
 
   return (
-    <box flexDirection="column" width={width} height={height}>
-      <scrollbox flexGrow={1} scrollY>
-        <box flexDirection="column" padding={1}>
-          <box flexDirection="column" gap={1}>
-            <text fg={colors.textBright} attributes={TextAttributes.BOLD}>How To Use Gloomberb</text>
-            <box flexDirection="column">
-              <text fg={colors.textDim}>Gloomberb is command-bar first.</text>
-              <text fg={colors.textDim}>Use the keyboard for speed, and the mouse for windows.</text>
-            </box>
-          </box>
-
-          <box flexDirection={compact ? "column" : "row"} gap={1}>
+    <Box flexDirection="column" width={width} height={height}>
+      <ScrollBox flexGrow={1} scrollY>
+        <Box flexDirection="column" padding={1}>
+          <Box flexDirection="column" gap={1}>
+            <Text fg={colors.textBright} attributes={TextAttributes.BOLD}>How To Use Gloomberb</Text>
+            <Box flexDirection="column">
+              <Text fg={colors.textDim}>Gloomberb is command-bar first.</Text>
+              <Text fg={colors.textDim}>Use the keyboard for speed, and the mouse for windows.</Text>
+            </Box>
+          </Box>
+
+          <Box flexDirection="row" gap={1}>
             <ActionButton
               id="debug"
               label="Open Debug Log"
@@ -158,91 +277,156 @@ export function HelpPane({ width, height }: PaneProps) {
               onHover={setHoveredAction}
               onPress={openPluginManager}
             />
-          </box>
+          </Box>
 
           <HelpSection title="Command Bar">
             <ShortcutRow
-              badges={["Ctrl+P", "`"]}
-              description="Open the command bar from anywhere."
-              compact={compact}
+              badges={commandBarBadges}
+              description="Open or toggle the command bar from anywhere."
+            />
+            <ShortcutRow
+              badges={["<ticker>"]}
+              description="Search for a ticker or open the best matching security."
+            />
+            <ShortcutRow
+              badges={["Up/Down", "Ctrl+P/N"]}
+              description="Move through command bar results."
             />
             <ShortcutRow
-              badges={["help"]}
-              description="Open this help window directly."
-              compact={compact}
+              badges={["Enter", "Shift+Enter"]}
+              description="Run the selected result or its secondary action."
             />
             <ShortcutRow
-              badges={["T <ticker>"]}
-              description="Search for a ticker or company and open it."
-              compact={compact}
+              badges={["Tab"]}
+              description="Accept an inferred shortcut argument from the focused ticker."
             />
             <ShortcutRow
-              badges={["NP", "PS", "PL"]}
-              description="Create panes, edit pane settings, and manage plugins."
-              compact={compact}
+              badges={["Esc", "`"]}
+              description="Close the command bar."
             />
           </HelpSection>
 
+          <HelpSection title="Command Prefixes">
+            {commandShortcuts.map((shortcut) => (
+              <ShortcutRow
+                key={shortcut.id}
+                badges={shortcut.badges}
+                description={shortcut.description}
+              />
+            ))}
+          </HelpSection>
+
           <HelpSection title="Window Templates">
             {windowTemplates.length > 0 ? windowTemplates.map((template) => (
               <ShortcutRow
                 key={template.id}
                 badges={template.badges}
                 description={template.description}
-                compact={compact}
               />
             )) : (
-              <text fg={colors.textDim}>No shortcut window templates are currently registered.</text>
+              <Text fg={colors.textDim}>No shortcut window templates are currently registered.</Text>
             )}
           </HelpSection>
 
-          <HelpSection title="Move Around">
+          {pluginShortcuts.length > 0 && (
+            <HelpSection title="Plugin Shortcuts">
+              {pluginShortcuts.map((shortcut) => (
+                <ShortcutRow
+                  key={shortcut.id}
+                  badges={shortcut.badges}
+                  description={shortcut.description}
+                />
+              ))}
+            </HelpSection>
+          )}
+
+          <HelpSection title="Global Keys">
             <ShortcutRow
               badges={["Tab", "Shift+Tab"]}
               description="Move focus between panes and floating windows."
-              compact={compact}
             />
             <ShortcutRow
-              badges={["Ctrl+W"]}
-              description="Close the focused pane, docked or floating."
-              compact={compact}
-            />
-            <ShortcutRow
-              badges={["j", "k"]}
-              description="Move through lists in most panes. Arrow keys also work."
-              compact={compact}
+              badges={["Ctrl+1-9"]}
+              description="Switch saved layouts by number."
             />
             <ShortcutRow
               badges={["r", "Shift+R"]}
               description="Refresh the focused ticker or refresh everything."
-              compact={compact}
+            />
+            <ShortcutRow
+              badges={["a"]}
+              description="Open ticker actions for the focused ticker."
+            />
+            <ShortcutRow
+              badges={["q"]}
+              description="Quit the terminal app."
+            />
+            <ShortcutRow
+              badges={copyBadges}
+              description="Copy the active terminal selection."
+            />
+            <ShortcutRow
+              badges={pasteBadges}
+              description="Paste clipboard text into the active input."
+            />
+            <ShortcutRow
+              badges={["u"]}
+              description="Install an available app update when one is shown."
             />
           </HelpSection>
 
-          <HelpSection title="Layout System">
+          <HelpSection title="Pane Management">
             <ShortcutRow
-              badges={["LAY"]}
+              badges={[platformShortcut("W")]}
+              description="Close the focused pane, docked or floating."
+            />
+            <ShortcutRow
+              badges={[platformShortcut(",")]}
+              description="Edit settings for the focused pane."
+            />
+            <ShortcutRow
+              badges={[platformShortcut(["Shift", "D"])]}
+              description="Dock or float the focused pane."
+            />
+            {isDesktopWeb && (
+              <ShortcutRow
+                badges={[platformShortcut(["Shift", "O"])]}
+                description="Pop the focused pane out to a desktop window."
+              />
+            )}
+            <ShortcutRow
+              badges={[platformShortcut(["Shift", "L"])]}
               description="Open layout actions."
-              compact={compact}
             />
-            <text fg={colors.text}>Docked panes stay in the saved layout.</text>
-            <box flexDirection="column">
-              <text fg={colors.text}>Floating panes can be dragged by the title bar</text>
-              <text fg={colors.text}>and resized from the lower-right corner.</text>
-            </box>
-            <text fg={colors.text}>Run Gridlock All Windows if the layout gets messy.</text>
+            <ShortcutRow
+              badges={[platformShortcut(["Shift", "G"])]}
+              description="Gridlock all windows."
+            />
+            <ShortcutRow
+              badges={["Esc"]}
+              description="Cancel an active pane drag."
+            />
+          </HelpSection>
+
+          <HelpSection title="Layout System">
+            <Text fg={colors.text}>Docked panes stay in the saved layout.</Text>
+            <Box flexDirection="column">
+              <Text fg={colors.text}>Floating panes can be dragged by the title bar</Text>
+              <Text fg={colors.text}>and resized from the lower-right corner.</Text>
+            </Box>
+            <Text fg={colors.text}>Use Layout Actions for split, move, duplicate, undo, redo, and layout presets.</Text>
           </HelpSection>
 
           <HelpSection title="If There Is A Bug">
-            <text fg={colors.text}>Open Debug Log, then run Export Debug Log from the command bar.</text>
-            <box flexDirection="column">
-              <text fg={colors.text}>The file lands in ~/Downloads. Include steps, ticker or layout, plugin,</text>
-              <text fg={colors.text}>and a screenshot if it is visual.</text>
-            </box>
+            <Text fg={colors.text}>Open Debug Log, then run Export Debug Log from the command bar.</Text>
+            <Box flexDirection="column">
+              <Text fg={colors.text}>The file lands in ~/Downloads. Include steps, ticker or layout, plugin,</Text>
+              <Text fg={colors.text}>and a screenshot if it is visual.</Text>
+            </Box>
           </HelpSection>
-        </box>
-      </scrollbox>
-    </box>
+        </Box>
+      </ScrollBox>
+    </Box>
   );
 }
 

package/src/plugins/builtin/holders/index.test.ts

@@ -0,0 +1,45 @@
+import { expect, test } from "bun:test";
+import { buildTreemap, buildTreemapRects } from "./index";
+import type { HolderRecord } from "../../../types/financials";
+
+function holder(name: string, value: number): HolderRecord & { id: string } {
+  return {
+    id: name,
+    ownerType: "institution",
+    name,
+    value,
+  };
+}
+
+test("groups large holders using terminal cell aspect instead of full-height strips", () => {
+  const rows = [
+    holder("Vanguard", 56.19),
+    holder("BlackRock", 52.3),
+    holder("State Street", 26.56),
+    holder("Geode", 13.3),
+    holder("Morgan Stanley", 8.88),
+    holder("Norges Bank", 8.16),
+    holder("JPMorgan", 7.41),
+    holder("Price", 7.21),
+    holder("UBS", 6.6),
+    holder("Northern Trust", 5.89),
+    holder("Capital Research", 5),
+    holder("Wells Fargo", 4.8),
+  ];
+  const tiles = buildTreemap(rows, 150, 40, 18 / 8);
+
+  expect(tiles[0]).toMatchObject({ row: expect.objectContaining({ name: "Vanguard" }), x: 0, y: 0 });
+  expect(tiles[1]).toMatchObject({ row: expect.objectContaining({ name: "BlackRock" }), x: 0 });
+  expect(tiles[1]!.y).toBeGreaterThan(0);
+  expect(tiles[0]!.height).toBeLessThan(40);
+  expect(tiles[1]!.height).toBeLessThan(40);
+  expect(tiles[0]!.width).toBe(tiles[1]!.width);
+
+  const rects = buildTreemapRects(rows, 150, 40, 18 / 8);
+  expect(rects[0]).toMatchObject({ row: expect.objectContaining({ name: "Vanguard" }), x: 0, y: 0 });
+  expect(rects[1]).toMatchObject({ row: expect.objectContaining({ name: "BlackRock" }), x: 0 });
+  expect(rects[1]!.y).toBeGreaterThan(0);
+  expect(rects[0]!.height).toBeLessThan(40);
+  expect(rects[1]!.height).toBeLessThan(40);
+  expect(rects[0]!.width).toBeCloseTo(rects[1]!.width, 8);
+});