gloomberb 0.16.2 → 0.16.4

package/src/cli/commands/system.ts

@@ -1,13 +1,16 @@
 import { join } from "path";
 import { VERSION } from "../../version";
 import { saveConfig } from "../../data/config/store";
+import { builtinPluginGroupMembers } from "../../plugins/ownership";
 import type { TelemetryConfig } from "../../types/config";
 import type { CliCommandDef } from "../../types/plugin";
 import { withCliServices, withConfigData } from "../context";
 import { CLI_COMMAND_GROUPS } from "../help";
 import { dryRunNote, formatBytes, formatStatusCell } from "../helpers";
 import { cliStyles, cliTerminalWidth, renderSection, renderTable, wrapText } from "../../utils/cli-output";
+import { getThemeIds } from "../../theme/themes";
 import { requireArg } from "./command-utils";
+import { describeThemeId, requireThemeId, themeListNote, themeListRows, themeName } from "./themes";
 import {
   applyKeybindingCliSet,
   describeKeybindingsForCli,
@@ -22,12 +25,25 @@ const TELEMETRY_CONFIG_KEYS = {
   "telemetry.attention": "attention",
 } as const satisfies Record<string, keyof TelemetryConfig>;
 type TelemetryConfigKey = keyof typeof TELEMETRY_CONFIG_KEYS;
-const EDITABLE_CONFIG_KEYS = ["baseCurrency", "refreshIntervalMinutes", "theme", "valueFlashingEnabled", ...Object.keys(TELEMETRY_CONFIG_KEYS)];
+/** The one-time GitHub star line in the terminal's status bar. */
+const STAR_PROMPT_CONFIG_KEY = "starPrompt.enabled";
+const EDITABLE_CONFIG_KEYS = [
+  "baseCurrency",
+  "refreshIntervalMinutes",
+  "theme",
+  "valueFlashingEnabled",
+  ...Object.keys(TELEMETRY_CONFIG_KEYS),
+  STAR_PROMPT_CONFIG_KEY,
+];
 
 function isTelemetryConfigKey(key: string): key is TelemetryConfigKey {
   return Object.prototype.hasOwnProperty.call(TELEMETRY_CONFIG_KEYS, key);
 }
 
+function isBooleanConfigKey(key: string): boolean {
+  return key === "valueFlashingEnabled" || key === STAR_PROMPT_CONFIG_KEY || isTelemetryConfigKey(key);
+}
+
 function describeConfigValue(value: unknown): string {
   if (value == null) return "nothing";
   if (Array.isArray(value)) return value.length > 0 ? value.join(", ") : "nothing";
@@ -136,6 +152,12 @@ export function createSystemCliCommands(): CliCommandDef[] {
           checks.push({ check: "database", status: "ok", detail: join(services.dataDir, ".gloomberb-cache.db") });
           checks.push({ check: "plugins", status: "ok", detail: String(services.services.pluginRegistry.allPlugins.size) });
           checks.push({ check: "capabilities", status: "ok", detail: String(services.services.pluginRegistry.capabilities.manifests().length) });
+          const theme = services.config.theme;
+          checks.push({
+            check: "theme",
+            status: themeName(theme) ? "ok" : "warn",
+            detail: themeName(theme) ? describeThemeId(theme) : `${describeThemeId(theme)}. Pick one with gloomberb config set theme <id>.`,
+          });
         });
       } catch (error) {
         checks.push({ check: "runtime", status: "error", detail: error instanceof Error ? error.message : String(error) });
@@ -160,8 +182,11 @@ export function createSystemCliCommands(): CliCommandDef[] {
         "config list",
         "config get <key>",
         "config set <key> <value>",
+        "config themes",
+        "config set theme <id>",
         "config set telemetry.crashReports false",
         "config set telemetry.usage false",
+        "config set starPrompt.enabled false",
         "config get keybindings",
         "config set keybindings.actions.<action> <keys>|null|default",
         "config set keybindings.commands.<keys> <command>|null",
@@ -169,9 +194,16 @@ export function createSystemCliCommands(): CliCommandDef[] {
       sections: [{
         title: "Editable keys",
         lines: [`${EDITABLE_CONFIG_KEYS.join(", ")}, and keybindings.*`],
+      }, {
+        title: "Themes",
+        lines: [
+          `theme takes one of these ids, or its name as config themes lists it: ${getThemeIds().join(", ")}.`,
+        ],
       }],
       examples: [
         "config",
+        "config themes",
+        "config set theme colorblind",
         "config set baseCurrency EUR",
         "config get keybindings",
         "config set keybindings.actions.ticker-search \"Ctrl+T\"",
@@ -180,6 +212,24 @@ export function createSystemCliCommands(): CliCommandDef[] {
     },
     execute: async (args, ctx) => {
       const action = args[0] ?? "list";
+      // Listing the themes needs no data folder, so it works before the first run.
+      if (action === "themes") {
+        let current: string | null = null;
+        try {
+          current = await withConfigData(ctx, ({ config }) => config.theme);
+        } catch {
+          current = null;
+        }
+        ctx.printResult({ data: themeListRows(current) }, {
+          textColumns: [
+            { key: "id", header: "ID", shrink: false },
+            { key: "name", header: "Name", shrink: false },
+            { key: "appearance", header: "Look" },
+            { key: "note", header: "Note", format: (_value, row) => themeListNote(row as ReturnType<typeof themeListRows>[number]) },
+          ],
+        });
+        return;
+      }
       await withConfigData(ctx, async (context) => {
         const safeConfig: Record<string, unknown> = {
           dataDir: context.config.dataDir,
@@ -197,6 +247,7 @@ export function createSystemCliCommands(): CliCommandDef[] {
           "telemetry.crashReports": context.config.telemetry?.crashReports !== false,
           "telemetry.usage": context.config.telemetry?.usage !== false,
           "telemetry.attention": context.config.telemetry?.attention === true,
+          [STAR_PROMPT_CONFIG_KEY]: context.config.starPrompt?.enabled !== false,
         };
 
         if (action === "list") {
@@ -205,6 +256,7 @@ export function createSystemCliCommands(): CliCommandDef[] {
               key,
               header: key,
               ...(key === KEYBINDINGS_CONFIG_KEY ? { format: summarizeKeybindings } : {}),
+              ...(key === "theme" ? { format: (value: unknown) => describeThemeId(String(value)) } : {}),
             })),
           });
           return;
@@ -214,6 +266,13 @@ export function createSystemCliCommands(): CliCommandDef[] {
           if (!Object.prototype.hasOwnProperty.call(safeConfig, key)) {
             ctx.fail(`Unknown config key "${key}".`, `Keys: ${Object.keys(safeConfig).join(", ")}`);
           }
+          if (key === "theme") {
+            const id = String(safeConfig.theme);
+            ctx.printResult({ data: { key, value: id, name: themeName(id) } }, {
+              text: () => describeThemeId(id),
+            });
+            return;
+          }
           ctx.printResult({ data: { key, value: safeConfig[key] } }, {
             text: (data) => key === KEYBINDINGS_CONFIG_KEY ? renderKeybindings(data.value) : describeConfigValue(data.value),
           });
@@ -244,24 +303,37 @@ export function createSystemCliCommands(): CliCommandDef[] {
           if (!EDITABLE_CONFIG_KEYS.includes(key)) {
             ctx.fail(`Config key "${key}" is not editable from the CLI.`, `Editable keys: ${EDITABLE_CONFIG_KEYS.join(", ")}, keybindings.*`);
           }
-          if (isTelemetryConfigKey(key) && value !== "true" && value !== "false") {
+          if ((isTelemetryConfigKey(key) || key === STAR_PROMPT_CONFIG_KEY) && value !== "true" && value !== "false") {
             ctx.fail(`Usage: gloomberb config set ${key} true|false`);
           }
-          const parsedValue = key === "refreshIntervalMinutes"
-            ? Number(value)
-            : key === "valueFlashingEnabled" || isTelemetryConfigKey(key)
-              ? value === "true"
-              : value;
+          // A display name may come unquoted: config set theme White Phosphor.
+          const parsedValue = key === "theme"
+            ? requireThemeId(args.slice(2).join(" "))
+            : key === "refreshIntervalMinutes"
+              ? Number(value)
+              : isBooleanConfigKey(key)
+                ? value === "true"
+                : value;
           const nextConfig = isTelemetryConfigKey(key)
             ? { ...context.config, telemetry: { ...context.config.telemetry, [TELEMETRY_CONFIG_KEYS[key]]: parsedValue as boolean } }
-            : { ...context.config, [key]: parsedValue };
+            : key === STAR_PROMPT_CONFIG_KEY
+              ? { ...context.config, starPrompt: { ...context.config.starPrompt, enabled: parsedValue as boolean } }
+              : { ...context.config, [key]: parsedValue };
           if (!ctx.cliOptions.dryRun) await saveConfig(nextConfig);
-          ctx.printResult({ data: { changed: !ctx.cliOptions.dryRun, dryRun: ctx.cliOptions.dryRun, key, value: parsedValue } }, {
-            text: (data) => `Set ${key} to ${describeConfigValue(data.value)}.${dryRunNote(data.dryRun)}`,
+          ctx.printResult({
+            data: {
+              changed: !ctx.cliOptions.dryRun,
+              dryRun: ctx.cliOptions.dryRun,
+              key,
+              value: parsedValue,
+              ...(key === "theme" ? { name: themeName(String(parsedValue)) } : {}),
+            },
+          }, {
+            text: (data) => `Set ${key} to ${key === "theme" ? describeThemeId(String(data.value)) : describeConfigValue(data.value)}.${dryRunNote(data.dryRun)}`,
           });
           return;
         }
-        ctx.fail("Usage: gloomberb config list|get|set");
+        ctx.fail("Usage: gloomberb config list|get|set|themes");
       });
     },
   };
@@ -422,19 +494,27 @@ export function createSystemCliCommands(): CliCommandDef[] {
         }
         if (action === "enable" || action === "disable") {
           const id = requireArg(args[1], `Usage: gloomberb plugin ${action} <id>`, ctx);
-          const plugin = services.services.pluginRegistry.allPlugins.get(id);
-          if (!plugin) ctx.fail(`Plugin "${id}" is not available.`);
-          if (plugin?.toggleable !== true) ctx.fail(`Plugin "${id}" is part of the application and cannot be disabled.`);
+          // A retired id that now names a group of built-ins switches all of them.
+          const targetIds = builtinPluginGroupMembers(id) ?? [id];
+          for (const targetId of targetIds) {
+            const plugin = services.services.pluginRegistry.allPlugins.get(targetId);
+            if (!plugin) ctx.fail(`Plugin "${targetId}" is not available.`);
+            if (plugin?.toggleable !== true) ctx.fail(`Plugin "${targetId}" is part of the application and cannot be disabled.`);
+          }
           const disabled = new Set(services.config.disabledPlugins ?? []);
-          const before = disabled.has(id);
-          if (action === "enable") disabled.delete(id);
-          else disabled.add(id);
+          const isOff = () => targetIds.every((targetId) => disabled.has(targetId));
+          const isOn = () => targetIds.every((targetId) => !disabled.has(targetId));
+          const unchanged = action === "enable" ? isOn() : isOff();
+          for (const targetId of targetIds) {
+            if (action === "enable") disabled.delete(targetId);
+            else disabled.add(targetId);
+          }
           const nextConfig = { ...services.config, disabledPlugins: [...disabled] };
           if (!ctx.cliOptions.dryRun) await saveConfig(nextConfig);
-          ctx.printResult({ data: { changed: before !== disabled.has(id) && !ctx.cliOptions.dryRun, dryRun: ctx.cliOptions.dryRun, id, enabled: !disabled.has(id) } }, {
+          ctx.printResult({ data: { changed: !unchanged && !ctx.cliOptions.dryRun, dryRun: ctx.cliOptions.dryRun, id, enabled: isOn() } }, {
             text: (data) => {
               const state = data.enabled ? "on" : "off";
-              if (before === disabled.has(id)) return `${id} is already ${state}.`;
+              if (unchanged) return `${id} is already ${state}.`;
               return `Turned ${id} ${state}.${dryRunNote(data.dryRun)}`;
             },
           });

package/src/cli/commands/themes.ts

@@ -0,0 +1,64 @@
+import { DEFAULT_THEME, listThemes, resolveThemeId, themes, type ThemeSummary } from "../../theme/themes";
+import { fail } from "../errors";
+
+const THEME_TRAIT_NOTES = { "high-contrast": "high contrast", "colorblind-safe": "color-blind safe" } as const;
+
+/** `white (White Phosphor)`, or what the app shows instead of an id it does not know. */
+export function describeThemeId(id: string): string {
+  const theme = themes[id];
+  if (theme) return `${id} (${theme.name})`;
+  return `${id}, not a theme: the app shows ${describeThemeId(DEFAULT_THEME)}`;
+}
+
+/** Every id with its name, from the registry, for an error that has to say what would have worked. */
+function themeChoicesText(): string {
+  const choices = listThemes().map(({ id, name }) => `${id} (${name})`).join(", ");
+  return `Themes: ${choices}. gloomberb config themes lists them with notes.`;
+}
+
+/**
+ * The id `input` names, by id or display name in any case. Anything else
+ * fails with the closest id when there is one, and every id with its name.
+ */
+export function requireThemeId(input: string): string {
+  const lookup = resolveThemeId(input);
+  if (lookup.ok) return lookup.id;
+  const hint = lookup.suggestion ? ` Did you mean ${describeThemeId(lookup.suggestion)}?` : "";
+  return fail(`Unknown theme "${input.trim()}".${hint}`, themeChoicesText());
+}
+
+export interface ThemeListRow extends Record<string, unknown> {
+  id: string;
+  name: string;
+  appearance: ThemeSummary["appearance"];
+  colorblindSafe: boolean;
+  highContrast: boolean;
+  default: boolean;
+  current: boolean;
+}
+
+export function themeListRows(currentThemeId: string | null): ThemeListRow[] {
+  return listThemes().map((theme) => ({
+    id: theme.id,
+    name: theme.name,
+    appearance: theme.appearance,
+    colorblindSafe: theme.traits.includes("colorblind-safe"),
+    highContrast: theme.traits.includes("high-contrast"),
+    default: theme.id === DEFAULT_THEME,
+    current: theme.id === currentThemeId,
+  }));
+}
+
+export function themeListNote(row: ThemeListRow): string {
+  const notes: string[] = [];
+  if (row.highContrast) notes.push(THEME_TRAIT_NOTES["high-contrast"]);
+  if (row.colorblindSafe) notes.push(THEME_TRAIT_NOTES["colorblind-safe"]);
+  if (row.default) notes.push("default");
+  if (row.current) notes.push("current");
+  return notes.join(", ");
+}
+
+/** The name of a theme id the registry knows, null for one it does not. */
+export function themeName(id: string): string | null {
+  return themes[id]?.name ?? null;
+}