Files
orca/src/shared/host-setting-overrides.ts
Neil 77f23b013f refactor(shared): drop the shared/types barrel and import from the real modules (#14447)
#14397 split `shared/types.ts` into 46 per-domain modules but kept the path as
a re-export barrel so the import sites did not have to change. This removes
the barrel: every consumer now imports from the module that actually declares
the type, and `src/shared/types.ts` is deleted.

Barrels hide where a type lives, make every consumer look like it depends on
the whole domain, and let an unrelated edit invalidate a module that ~2,000
files transitively import.

2,323 import declarations across 2,321 files. Rewritten mechanically: each
specifier was resolved to an absolute path via the TypeScript AST and
recomputed, rather than string-substituted, so alias forms (`@/../../shared/
types`) and per-specifier `type` modifiers survive.

Four cases the mechanical pass had to handle, each found by a gate rather than
by reading the diff:

- Modules inside `src/shared` import the barrel as `./types`, not
  `shared/types`. A pre-filter on the latter string skipped 176 of them and
  left imports dangling at a deleted file, which surfaced as confusing
  `Property 'x' is optional in type 'Repo' but required in Pick<Repo, ...>`
  errors rather than "module not found".
- The barrel RENAMED one type on the way through
  (`WorkspaceSource as WorkspaceCreateTelemetrySource`), so the original name
  in the owning module has to be re-aliased at each consumer.
- Three test files put `;(globalThis as ...)` on the line after the import.
  TypeScript parses that `;` as the import statement's terminator, so
  replacing through `statement.getEnd()` deletes it and breaks ASI. The
  rewrite now stops at the module specifier.
- A file that already imported directly from a module got a SECOND import
  from it, because the barrel re-exported those same names — which trips
  `import/no-duplicates` under `--deny-warnings`. A post-pass merges
  declarations sharing a specifier and type-only-ness; the `import type` plus
  `import` pair from one module is left alone, since that form is allowed.

Splitting one barrel import into several genuinely adds lines, which pushed
`terminal-layout-pty-ownership.ts` to 301 counted lines: its 107-character
import must wrap, and neither local type collapses onto one line (101 and 116
characters). Rather than contort a type declaration to fit a line budget,
`collectLeafIds` and `pruneLeaves` move to `terminal-pane-layout-tree.ts` —
they are pure structural operations on the layout tree and independent of PTY
ownership. `visible-worktrees.ts` similarly loses its own mini-barrel
re-export of `isDefaultBranchWorkspace`, with the four real consumers
repointed at the declaring module. No `max-lines` bypass added.

Verified: cold `tsc --noEmit` green on node, cli, and web (buildinfo deleted
first — these projects are `composite: true` and reuse stale caches); the full
`pnpm lint` green, not just bare oxlint — the narrower local check is what let
the duplicate imports reach CI; max-lines ratchet OK at 344.
2026-08-13 22:48:24 -07:00

102 lines
3.7 KiB
TypeScript

import type { ExecutionHostId } from './execution-host'
import type { GlobalSettings } from './global-settings-types'
/** Per-host overrides for client preferences that genuinely vary by execution
* host. NARROW by design: only settings whose value is meaningless to share
* across hosts belong here.
* - `displayLabel`: a client-side rename for the host shown in sidebar/pickers.
* - `defaultWorktreeLocation`: the host's root worktree directory; a remote
* SSH/runtime host has a different filesystem layout than the local Mac, so
* the client `workspaceDir` default cannot apply unchanged. */
export type HostSettingOverrides = {
displayLabel?: string
defaultWorktreeLocation?: string
}
// Why: per-host preferences follow `effective = host override ?? client default`.
// These pure helpers centralize that rule so the UI, registry, and tests share a
// single implementation instead of re-deriving the fallback at each call site.
export type HostSettingOverrideKey = keyof HostSettingOverrides
type HostSettingsSlice = Pick<GlobalSettings, 'hostSettingOverrides'>
function normalize(value: string | undefined): string | undefined {
const trimmed = value?.trim()
return trimmed ? trimmed : undefined
}
/** Returns the host's override for `key` if present and non-empty, else `undefined`. */
export function getHostSettingOverride(
settings: HostSettingsSlice | null | undefined,
hostId: ExecutionHostId,
key: HostSettingOverrideKey
): string | undefined {
return normalize(settings?.hostSettingOverrides?.[hostId]?.[key])
}
/** `host override ?? client default`. Unknown hosts and cleared overrides fall back. */
export function getEffectiveHostSetting(
settings: HostSettingsSlice | null | undefined,
hostId: ExecutionHostId,
key: HostSettingOverrideKey,
clientDefault: string
): string {
return getHostSettingOverride(settings, hostId, key) ?? clientDefault
}
/** Pure update: returns the next `hostSettingOverrides` map with the override set.
* An empty/whitespace value clears the key instead of persisting blank text. */
export function setHostSettingOverride(
settings: HostSettingsSlice | null | undefined,
hostId: ExecutionHostId,
key: HostSettingOverrideKey,
value: string
): Partial<Record<ExecutionHostId, HostSettingOverrides>> {
const normalized = normalize(value)
if (normalized === undefined) {
return clearHostSettingOverride(settings, hostId, key)
}
const current = settings?.hostSettingOverrides ?? {}
return {
...current,
[hostId]: { ...current[hostId], [key]: normalized }
}
}
/** Pure update: returns the next map with the key removed, dropping the host
* entry entirely once it has no remaining overrides. */
export function clearHostSettingOverride(
settings: HostSettingsSlice | null | undefined,
hostId: ExecutionHostId,
key: HostSettingOverrideKey
): Partial<Record<ExecutionHostId, HostSettingOverrides>> {
const current = settings?.hostSettingOverrides
const hostOverrides = current?.[hostId]
if (!current || !hostOverrides || !(key in hostOverrides)) {
return current ?? {}
}
const { [key]: _removed, ...remaining } = hostOverrides
const next = { ...current }
if (Object.keys(remaining).length === 0) {
delete next[hostId]
} else {
next[hostId] = remaining
}
return next
}
/** Builds the `displayLabel` lookup map the host registry consumes. */
export function getHostDisplayLabelOverrides(
settings: HostSettingsSlice | null | undefined
): ReadonlyMap<ExecutionHostId, string> {
const result = new Map<ExecutionHostId, string>()
for (const [hostId, overrides] of Object.entries(settings?.hostSettingOverrides ?? {})) {
const label = normalize(overrides?.displayLabel)
if (label) {
result.set(hostId as ExecutionHostId, label)
}
}
return result
}