dsh-brief-sidebar 0.3.0 → 0.4.0

package/src/client/index.tsx

@@ -1,144 +1,144 @@
-/**
- * Browser half: the task board tab, plus the shadow that hides the official
- * composer-band todo panel.
- *
- * Registration order matters and is deliberate:
- *
- * 1. **Dictionaries first.** Every later registration can render translated
- *    copy, and a dictionary that lands after the first paint would show raw
- *    keys for a frame.
- * 2. **Soft-dependency check.** `inject` already waits for `betterSidebar`, so
- *    the guard only fires in a composition that relaxes the inject list. It is
- *    kept because it is what stops the plugin from hiding the official panel
- *    when it has no board to replace it with.
- * 3. **Shadow the official dock.** Deliberately BEFORE the tab registration:
- *    the panel is the only other carrier of the list, so the replacement has to
- *    exist in the same activation.
- * 4. **Register the tab.**
- *
- * Every registration rides `ctx.effect(fn, label)` so its disposer is revoked on
- * fiber teardown (HMR / disable), which is also what makes the shadow
- * reversible: unload the plugin and the official dock renders again.
- *
- * Contract notes for the two surfaces touched here:
- * - better-sidebar tabs are hosted by DSH's native right Sidebar, so the tab
- *   body receives `TabComponentProps` (`ctx` + `scope` + `visible`) and NOT the
- *   framework's session-scoped slot props.
- * - `conversation.input.dock` is the DSH slot the official todo panel occupies;
- *   see `brief/dock-shadow.tsx` for why a lower priority wins the cell.
- */
-import { createElement } from 'react'
-import type { Context } from '@deepseek-ai/cordis'
-import type { BetterSidebarService, TabComponentProps } from 'dsh-better-sidebar/client/service'
-import { SummaryTab } from './SummaryTab'
-import { BriefIcon } from './BriefIcon'
-import { NS, dictionaries } from './locales'
-import { readTodos, unfinishedCount } from './brief/board'
-import { registerTodoDockShadow } from './brief/dock-shadow'
-import { TODOS_KEY } from './brief/use-todos'
-import { projectionSnapshot } from './use-projection'
-
-/**
- * Tab type id. Package-prefixed so it cannot collide with a built-in type.
- * Unchanged since the 0.1.0 board tab: the summary tab REPLACES the board tab
- * in place, so an opened or pinned tab survives the upgrade.
- */
-export const TAB_ID = 'dsh-brief-sidebar:board'
-
-/**
- * Position in the host's new-tab guide.
- *
- * Built-ins on this host generation sit at editor 10 / git 20 / subagent 30 /
- * sidechat 35 / terminal 40 / browser 50. 15 places a per-session task board
- * right after the editor, which is where a reader looks for session state.
- */
-export const TAB_ORDER = 15
-
-/** Services required before `apply` runs. */
-export const inject = ['betterSidebar', 'locale', 'slots']
-
-/**
- * Structural view of the DSH locale service — only the two members this plugin
- * calls. Declared locally on purpose: importing the real type would pull the
- * whole client type graph into a browser-only plugin for two signatures.
- */
-interface LocaleLike {
-  register(ns: string, dicts: Record<string, Record<string, string>>): () => void
-  bind(ns: string): (key: string) => string
-}
-
-/**
- * An effect body must return a disposer (cordis rejects `undefined` with a
- * `TypeError`), so a path that could not register anything returns this no-op
- * instead of nothing.
- */
-const NOOP = (): void => {}
-
-/**
- * Browser-face apply.
- *
- * @param ctx - the client root context.
- */
-export function apply(ctx: Context): void {
-  // 1. Plugin-owned dictionaries, in one registration.
-  const locale: LocaleLike | undefined = ctx.get('locale')
-  if (locale !== undefined) {
-    ctx.effect(() => locale.register(NS, dictionaries), 'dsh-brief-sidebar: dictionaries')
-  }
-
-  /**
-   * Translate one of our keys. `bind` returns a cached function that reads the
-   * ACTIVE locale at call time, so a language switch needs no re-apply; an
-   * unknown namespace or key falls back to the key itself rather than throwing
-   * inside a render.
-   */
-  const t = (key: string): string => {
-    if (locale === undefined) return key
-    try {
-      return locale.bind(NS)(key) || key
-    } catch {
-      return key
-    }
-  }
-
-  // 2. Soft dependency: without better-sidebar there is no place to show the
-  //    list, so the plugin stays inert and the official panel keeps rendering.
-  const bar: BetterSidebarService | undefined = ctx.get('betterSidebar')
-  if (bar === undefined) return
-
-  // 3. Hide the official composer-band panel (reversible on unload).
-  ctx.effect(() => registerTodoDockShadow(ctx) ?? NOOP, 'dsh-brief-sidebar: dock shadow')
-
-  // 4. The board.
-  ctx.effect(
-    () =>
-      bar.registerTab({
-        id: TAB_ID,
-        title: () => t('tab.title'),
-        description: () => t('tab.desc'),
-        icon: (size: number) => BriefIcon(size),
-        order: TAB_ORDER,
-        // Shorthand for `dedupeKey: () => id`: reopening focuses the existing tab.
-        single: true,
-        /**
-         * Unfinished count on the tab strip. Called on every tab-bar render, so
-         * it reads one snapshot and allocates no subscription; a completed list
-         * shows no badge at all.
-         */
-        badge: (badgeCtx, badgeScope) => {
-          const todos = readTodos(projectionSnapshot(badgeCtx, badgeScope.sessionId, TODOS_KEY))
-          if (todos === undefined) return null
-          const pending = unfinishedCount(todos)
-          return pending > 0 ? pending : null
-        },
-        component: (props: TabComponentProps) =>
-          createElement(SummaryTab, {
-            t,
-            ctx: props.ctx,
-            scope: props.scope,
-            visible: props.visible,
-          }),
-      }),
-    'dsh-brief-sidebar: tab',
-  )
-}
+/**
+ * Browser half: the task board tab, plus the shadow that hides the official
+ * composer-band todo panel.
+ *
+ * Registration order matters and is deliberate:
+ *
+ * 1. **Dictionaries first.** Every later registration can render translated
+ *    copy, and a dictionary that lands after the first paint would show raw
+ *    keys for a frame.
+ * 2. **Soft-dependency check.** `inject` already waits for `betterSidebar`, so
+ *    the guard only fires in a composition that relaxes the inject list. It is
+ *    kept because it is what stops the plugin from hiding the official panel
+ *    when it has no board to replace it with.
+ * 3. **Shadow the official dock.** Deliberately BEFORE the tab registration:
+ *    the panel is the only other carrier of the list, so the replacement has to
+ *    exist in the same activation.
+ * 4. **Register the tab.**
+ *
+ * Every registration rides `ctx.effect(fn, label)` so its disposer is revoked on
+ * fiber teardown (HMR / disable), which is also what makes the shadow
+ * reversible: unload the plugin and the official dock renders again.
+ *
+ * Contract notes for the two surfaces touched here:
+ * - better-sidebar tabs are hosted by DSH's native right Sidebar, so the tab
+ *   body receives `TabComponentProps` (`ctx` + `scope` + `visible`) and NOT the
+ *   framework's session-scoped slot props.
+ * - `conversation.input.dock` is the DSH slot the official todo panel occupies;
+ *   see `brief/dock-shadow.tsx` for why a lower priority wins the cell.
+ */
+import { createElement } from 'react'
+import type { Context } from '@deepseek-ai/cordis'
+import type { BetterSidebarService, TabComponentProps } from 'dsh-better-sidebar/client/service'
+import { SummaryTab } from './SummaryTab'
+import { BriefIcon } from './BriefIcon'
+import { NS, dictionaries } from './locales'
+import { readTodos, unfinishedCount } from './brief/board'
+import { registerTodoDockShadow } from './brief/dock-shadow'
+import { TODOS_KEY } from './brief/use-todos'
+import { projectionSnapshot } from './use-projection'
+
+/**
+ * Tab type id. Package-prefixed so it cannot collide with a built-in type.
+ * Unchanged since the 0.1.0 board tab: the summary tab REPLACES the board tab
+ * in place, so an opened or pinned tab survives the upgrade.
+ */
+export const TAB_ID = 'dsh-brief-sidebar:board'
+
+/**
+ * Position in the host's new-tab guide.
+ *
+ * Built-ins on this host generation sit at editor 10 / git 20 / subagent 30 /
+ * sidechat 35 / terminal 40 / browser 50. 15 places a per-session task board
+ * right after the editor, which is where a reader looks for session state.
+ */
+export const TAB_ORDER = 15
+
+/** Services required before `apply` runs. */
+export const inject = ['betterSidebar', 'locale', 'slots']
+
+/**
+ * Structural view of the DSH locale service — only the two members this plugin
+ * calls. Declared locally on purpose: importing the real type would pull the
+ * whole client type graph into a browser-only plugin for two signatures.
+ */
+interface LocaleLike {
+  register(ns: string, dicts: Record<string, Record<string, string>>): () => void
+  bind(ns: string): (key: string) => string
+}
+
+/**
+ * An effect body must return a disposer (cordis rejects `undefined` with a
+ * `TypeError`), so a path that could not register anything returns this no-op
+ * instead of nothing.
+ */
+const NOOP = (): void => {}
+
+/**
+ * Browser-face apply.
+ *
+ * @param ctx - the client root context.
+ */
+export function apply(ctx: Context): void {
+  // 1. Plugin-owned dictionaries, in one registration.
+  const locale: LocaleLike | undefined = ctx.get('locale')
+  if (locale !== undefined) {
+    ctx.effect(() => locale.register(NS, dictionaries), 'dsh-brief-sidebar: dictionaries')
+  }
+
+  /**
+   * Translate one of our keys. `bind` returns a cached function that reads the
+   * ACTIVE locale at call time, so a language switch needs no re-apply; an
+   * unknown namespace or key falls back to the key itself rather than throwing
+   * inside a render.
+   */
+  const t = (key: string): string => {
+    if (locale === undefined) return key
+    try {
+      return locale.bind(NS)(key) || key
+    } catch {
+      return key
+    }
+  }
+
+  // 2. Soft dependency: without better-sidebar there is no place to show the
+  //    list, so the plugin stays inert and the official panel keeps rendering.
+  const bar: BetterSidebarService | undefined = ctx.get('betterSidebar')
+  if (bar === undefined) return
+
+  // 3. Hide the official composer-band panel (reversible on unload).
+  ctx.effect(() => registerTodoDockShadow(ctx) ?? NOOP, 'dsh-brief-sidebar: dock shadow')
+
+  // 4. The board.
+  ctx.effect(
+    () =>
+      bar.registerTab({
+        id: TAB_ID,
+        title: () => t('tab.title'),
+        description: () => t('tab.desc'),
+        icon: (size: number) => BriefIcon(size),
+        order: TAB_ORDER,
+        // Shorthand for `dedupeKey: () => id`: reopening focuses the existing tab.
+        single: true,
+        /**
+         * Unfinished count on the tab strip. Called on every tab-bar render, so
+         * it reads one snapshot and allocates no subscription; a completed list
+         * shows no badge at all.
+         */
+        badge: (badgeCtx, badgeScope) => {
+          const todos = readTodos(projectionSnapshot(badgeCtx, badgeScope.sessionId, TODOS_KEY))
+          if (todos === undefined) return null
+          const pending = unfinishedCount(todos)
+          return pending > 0 ? pending : null
+        },
+        component: (props: TabComponentProps) =>
+          createElement(SummaryTab, {
+            t,
+            ctx: props.ctx,
+            scope: props.scope,
+            visible: props.visible,
+          }),
+      }),
+    'dsh-brief-sidebar: tab',
+  )
+}

package/src/client/locales.ts

@@ -1,78 +1,78 @@
-/**
- * Plugin-owned i18n dictionaries.
- *
- * Consumer plugins must NOT reach into better-sidebar's internal `t()` or its
- * `betterSidebar` dictionary namespace, so this plugin registers its own
- * namespace through the DSH `locale` service. `dsh-brief-sidebar` is outside the
- * `LocaleNamespaceMap` merge table, which is exactly what the untyped
- * `register(ns, dicts)` overload is for — but the dictionaries themselves stay
- * strictly paired: `zh` is the key-set source of truth and `en` is typed as
- * `Record<keyof typeof zh, string>`, so a missing or extra English key is a
- * COMPILE error rather than a runtime fallback to the raw key.
- *
- * Every key referenced anywhere in `src/**` must exist in both dictionaries;
- * `tests/purity.spec.ts` asserts that, so a typo in a `t('…')` call cannot
- * ship as an untranslated literal.
- */
-
-/** The namespace owned by this plugin (own vocabulary, own lifecycle). */
-export const NS = 'dsh-brief-sidebar'
-
-/** Simplified Chinese dictionary — the key-set source of truth. */
-export const zh = {
-  'tab.title': '概要',
-  'tab.desc': '当前会话的任务、产物与规划文件（只读）',
-  'section.progress': '进展',
-  'section.deliverables': '产物',
-  'board.empty': '当前没有任务',
-  'board.emptyHint': '模型调用 todo_write 之后，任务会出现在这里。',
-  'board.unavailable': '任务暂不可用',
-  'board.unavailableHint': '这个会话还没有收到 todo 数据；宿主推来第一帧后会自动显示。',
-  'status.pending': '待处理',
-  'status.inProgress': '进行中',
-  'status.completed': '已完成',
-  'deliverables.empty': '本回合暂无改动文件',
-  'deliverables.emptyHint': '会话里成功写入或修改文件后，它们会实时出现在这里。',
-  'deliverables.sessionTotal': '本会话共 {count} 个文件',
-  'deliverable.codeplanTag': '规划',
-}
-
-/** The key union: what a `t('…')` call may name inside this namespace. */
-export type BriefKey = keyof typeof zh
-
-/** English dictionary, checked complete against the zh key set. */
-export const en: Record<BriefKey, string> = {
-  'tab.title': 'Summary',
-  'tab.desc': 'Tasks, produced files and plan artifacts of this session (read-only)',
-  'section.progress': 'Progress',
-  'section.deliverables': 'Produced files',
-  'board.empty': 'No tasks yet',
-  'board.emptyHint': 'Tasks show up here once the model calls todo_write.',
-  'board.unavailable': 'Tasks unavailable',
-  'board.unavailableHint':
-    'This session has not received any todo data yet; the board fills in on the first frame.',
-  'status.pending': 'Pending',
-  'status.inProgress': 'In progress',
-  'status.completed': 'Done',
-  'deliverables.empty': 'No files changed in this turn',
-  'deliverables.emptyHint': 'Files written or edited successfully in the session appear here live.',
-  'deliverables.sessionTotal': '{count} files in this session',
-  'deliverable.codeplanTag': 'Plan',
-}
-
-/**
- * Both locales in the shape the locale service consumes. Registered in ONE
- * call: the registry rejects a duplicate `(namespace, locale)` pair and the
- * per-locale form would leave a half-registered namespace if the second call
- * threw.
- */
-export const dictionaries: Record<string, Record<string, string>> = { zh, en }
-
-/**
- * Expand the one `{count}` placeholder the deliverables totals line uses. The
- * locale binder is a plain key → string lookup (no interpolation machinery),
- * mirroring how `progressLine` composes its summary from parts.
- */
-export function expandCount(template: string, count: number): string {
-  return template.replace('{count}', String(count))
-}
+/**
+ * Plugin-owned i18n dictionaries.
+ *
+ * Consumer plugins must NOT reach into better-sidebar's internal `t()` or its
+ * `betterSidebar` dictionary namespace, so this plugin registers its own
+ * namespace through the DSH `locale` service. `dsh-brief-sidebar` is outside the
+ * `LocaleNamespaceMap` merge table, which is exactly what the untyped
+ * `register(ns, dicts)` overload is for — but the dictionaries themselves stay
+ * strictly paired: `zh` is the key-set source of truth and `en` is typed as
+ * `Record<keyof typeof zh, string>`, so a missing or extra English key is a
+ * COMPILE error rather than a runtime fallback to the raw key.
+ *
+ * Every key referenced anywhere in `src/**` must exist in both dictionaries;
+ * `tests/purity.spec.ts` asserts that, so a typo in a `t('…')` call cannot
+ * ship as an untranslated literal.
+ */
+
+/** The namespace owned by this plugin (own vocabulary, own lifecycle). */
+export const NS = 'dsh-brief-sidebar'
+
+/** Simplified Chinese dictionary — the key-set source of truth. */
+export const zh = {
+  'tab.title': '概要',
+  'tab.desc': '当前会话的任务、产物与规划文件（只读）',
+  'section.progress': '进展',
+  'section.deliverables': '产物',
+  'board.empty': '当前没有任务',
+  'board.emptyHint': '模型调用 todo_write 之后，任务会出现在这里。',
+  'board.unavailable': '任务暂不可用',
+  'board.unavailableHint': '这个会话还没有收到 todo 数据；宿主推来第一帧后会自动显示。',
+  'status.pending': '待处理',
+  'status.inProgress': '进行中',
+  'status.completed': '已完成',
+  'deliverables.empty': '本回合暂无改动文件',
+  'deliverables.emptyHint': '会话里成功写入或修改文件后，它们会实时出现在这里。',
+  'deliverables.sessionTotal': '本会话共 {count} 个文件',
+  'deliverable.codeplanTag': '规划',
+}
+
+/** The key union: what a `t('…')` call may name inside this namespace. */
+export type BriefKey = keyof typeof zh
+
+/** English dictionary, checked complete against the zh key set. */
+export const en: Record<BriefKey, string> = {
+  'tab.title': 'Summary',
+  'tab.desc': 'Tasks, produced files and plan artifacts of this session (read-only)',
+  'section.progress': 'Progress',
+  'section.deliverables': 'Produced files',
+  'board.empty': 'No tasks yet',
+  'board.emptyHint': 'Tasks show up here once the model calls todo_write.',
+  'board.unavailable': 'Tasks unavailable',
+  'board.unavailableHint':
+    'This session has not received any todo data yet; the board fills in on the first frame.',
+  'status.pending': 'Pending',
+  'status.inProgress': 'In progress',
+  'status.completed': 'Done',
+  'deliverables.empty': 'No files changed in this turn',
+  'deliverables.emptyHint': 'Files written or edited successfully in the session appear here live.',
+  'deliverables.sessionTotal': '{count} files in this session',
+  'deliverable.codeplanTag': 'Plan',
+}
+
+/**
+ * Both locales in the shape the locale service consumes. Registered in ONE
+ * call: the registry rejects a duplicate `(namespace, locale)` pair and the
+ * per-locale form would leave a half-registered namespace if the second call
+ * threw.
+ */
+export const dictionaries: Record<string, Record<string, string>> = { zh, en }
+
+/**
+ * Expand the one `{count}` placeholder the deliverables totals line uses. The
+ * locale binder is a plain key → string lookup (no interpolation machinery),
+ * mirroring how `progressLine` composes its summary from parts.
+ */
+export function expandCount(template: string, count: number): string {
+  return template.replace('{count}', String(count))
+}