Skip to content

Commit 1adb91f

Browse files
simonkleebornmw
authored andcommitted
feat(tui): add primary and both copy modes to terminal.copy
1 parent 4dbd0dd commit 1adb91f

13 files changed

Lines changed: 168 additions & 140 deletions

File tree

‎packages/tui/src/app.tsx‎

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { Service, type Endpoint } from "@opencode/client/effect/service"
77
import { OpenCode, type SessionInfo } from "@opencode/client"
88
import { Global } from "@opencode/util/global"
99
import { noTimeoutFetch } from "@opencode/util/no-timeout-fetch"
10-
import { ClipboardProvider, useClipboard, type ClipboardService } from "./context/clipboard"
10+
import { ClipboardProvider, useClipboard } from "./context/clipboard"
1111
import { LogProvider, type LogSink } from "./context/log"
1212
import { ExitProvider, useExit } from "./context/exit"
1313
import { EpilogueProvider } from "./context/epilogue"
@@ -32,7 +32,6 @@ import {
3232
onCleanup,
3333
batch,
3434
Show,
35-
type JSX,
3635
} from "solid-js"
3736
import {
3837
TuiLifecycleProvider,
@@ -110,7 +109,7 @@ import { StorageProvider, useStorage } from "./context/storage"
110109
import { SessionTerminalsProvider } from "./context/session-terminals"
111110
import { PanelProvider, usePanel } from "./context/panel"
112111
import { SessionFrame } from "./component/session-frame"
113-
import { createTuiClipboard, type OwnedClipboardService } from "./clipboard"
112+
import { createTuiClipboard } from "./clipboard"
114113

115114
const appGlobalBindingCommands = ["session.list", "session.new", "open.menu"] as const
116115

@@ -369,13 +368,13 @@ export const run = Effect.fn("Tui.run")(function* (input: TuiInput) {
369368
skipInitialLoading: Boolean(process.env.OPENCODE_FAST_BOOT),
370369
}}
371370
>
372-
<ArgsProvider {...input.args}>
373-
<ConfigProvider
374-
config={config}
375-
service={input.config}
376-
options={{ terminalSuspend: process.platform !== "win32" }}
377-
>
378-
<ConfigClipboardProvider clipboard={clipboard}>
371+
<ClipboardProvider value={clipboard}>
372+
<ArgsProvider {...input.args}>
373+
<ConfigProvider
374+
config={config}
375+
service={input.config}
376+
options={{ terminalSuspend: process.platform !== "win32" }}
377+
>
379378
<Keymap.Provider>
380379
<ToastProvider>
381380
<RouteProvider
@@ -437,9 +436,9 @@ export const run = Effect.fn("Tui.run")(function* (input: TuiInput) {
437436
</RouteProvider>
438437
</ToastProvider>
439438
</Keymap.Provider>
440-
</ConfigClipboardProvider>
441-
</ConfigProvider>
442-
</ArgsProvider>
439+
</ConfigProvider>
440+
</ArgsProvider>
441+
</ClipboardProvider>
443442
</TuiStartupProvider>
444443
</TuiTerminalEnvironmentProvider>
445444
</TuiLifecycleProvider>
@@ -468,15 +467,6 @@ export const run = Effect.fn("Tui.run")(function* (input: TuiInput) {
468467
})
469468
})
470469

471-
function ConfigClipboardProvider(props: { clipboard: OwnedClipboardService; children: JSX.Element }) {
472-
const config = useConfig()
473-
const clipboard: ClipboardService = {
474-
read: () => props.clipboard.read(),
475-
write: (text) => props.clipboard.write(text, { primary: config.data.terminal?.primary_selection === true }),
476-
}
477-
return <ClipboardProvider value={clipboard}>{props.children}</ClipboardProvider>
478-
}
479-
480470
function App() {
481471
const app = useTuiApp()
482472
const startup = useTuiStartup()
@@ -570,8 +560,7 @@ function App() {
570560
}
571561
})
572562

573-
const copyOnSelectEnabled = () =>
574-
(config.data.terminal?.copy ?? (process.platform === "win32" ? "manual" : "select")) === "select"
563+
const copyOnSelectEnabled = () => ["select", "both"].includes(Config.copyMode(config.data))
575564

576565
// Selection copy/dismiss must precede both app bindings and the terminal pane's raw key forwarding.
577566
const offSelectionKeys = keymap.intercept(
@@ -1396,7 +1385,7 @@ function App() {
13961385
onMouseUp={(event) => {
13971386
const url = clickedLink(renderer, event)
13981387
if (url) return void openUrl(url).catch(toast.error)
1399-
if (copyOnSelectEnabled()) Selection.copyOnSelectRelease(event, renderer, toast, clipboard)
1388+
Selection.copyOnSelectRelease(event, renderer, toast, clipboard, Config.copyMode(config.data))
14001389
}}
14011390
>
14021391
<box

‎packages/tui/src/clipboard.ts‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,7 @@ import {
88
} from "@opentui/core"
99
import type { ClipboardContent, ClipboardService } from "./context/clipboard"
1010

11-
export type OwnedClipboardService = Readonly<{
12-
read: ClipboardService["read"]
13-
write(text: string, options?: { primary?: boolean }): Promise<void>
14-
dispose(): Promise<void>
15-
}>
11+
export type OwnedClipboardService = Required<ClipboardService> & Readonly<{ dispose(): Promise<void> }>
1612

1713
export function createTuiClipboard(renderer: RendererClipboardBoundary): OwnedClipboardService {
1814
return createClipboardAdapter(
@@ -54,16 +50,12 @@ export function createClipboardAdapter(clipboard: CoreClipboardService): OwnedCl
5450
}
5551
throw new Error(`Unexpected clipboard MIME type: ${result.representation.mimeType}`)
5652
},
57-
async write(text, options) {
53+
async write(text, selections = ["clipboard"]) {
5854
// OpenTUI rejects NUL before any destination; host clipboard text cannot contain it.
5955
const payload = text.replaceAll("\0", "")
60-
const [result] = await Promise.all([
61-
clipboard.writeText(payload, { destination: "all-available", selection: "clipboard" }),
62-
// The primary selection is best effort; the clipboard result decides success.
63-
options?.primary
64-
? clipboard.writeText(payload, { destination: "all-available", selection: "primary" })
65-
: undefined,
66-
])
56+
const [result] = await Promise.all(
57+
selections.map((selection) => clipboard.writeText(payload, { destination: "all-available", selection })),
58+
)
6759
if (result.host.status === "written" || result.terminal.status === "attempted") return
6860
if (result.host.status === "failed") throw result.host.error
6961
throw new Error(`Clipboard write failed (host: ${result.host.status}, terminal: ${result.terminal.status})`)

‎packages/tui/src/component/devtools-bar.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import path from "node:path"
66
import { monitorEventLoopDelay } from "node:perf_hooks"
77
import { createMemo, createResource, createSignal, For, onCleanup, onMount, Show, type ParentProps } from "solid-js"
88
import { useClient } from "../context/client"
9-
import { useConfig } from "../config"
9+
import { copyMode, useConfig } from "../config"
1010
import { useData } from "../context/data"
1111
import { useLocation } from "../context/location"
1212
import { useRoute } from "../context/route"
@@ -89,7 +89,7 @@ export function DevToolsBar() {
8989
if (!panel() || keymap.mode.current() !== "base") return
9090
if (event.name !== "escape" && !(event.ctrl && event.name === "c")) return
9191
if (renderer.getSelection()?.getSelectedText()) {
92-
if ((config.data.terminal?.copy ?? (process.platform === "win32" ? "manual" : "select")) !== "select") return
92+
if (!["select", "both"].includes(copyMode(config.data))) return
9393
renderer.clearSelection()
9494
event.preventDefault()
9595
event.stopPropagation()

‎packages/tui/src/component/dialog-config.tsx‎

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { createMemo, createSignal } from "solid-js"
2-
import { useConfig, useNewDesigns } from "../config"
2+
import { copyMode, useConfig, useNewDesigns } from "../config"
33
import { useThemes } from "../context/theme"
44
import { useDialog, type DialogContext } from "../ui/dialog"
55
import { DialogSelect, DialogSelectChoice } from "../ui/dialog-select"
@@ -355,18 +355,9 @@ export const settings: Setting[] = [
355355
category: "Terminal",
356356
path: ["terminal", "copy"],
357357
description: "Whether selecting text copies it",
358-
default: process.platform === "win32" ? "manual" : "select",
359-
values: ["manual", "select"],
360-
keywords: ["selection", "clipboard"],
361-
},
362-
{
363-
title: "Primary selection",
364-
category: "Terminal",
365-
path: ["terminal", "primary_selection"],
366-
default: false,
367-
values: [false, true],
368-
labels: ["off", "on"],
369-
keywords: ["clipboard", "middle click", "linux", "x11", "wayland"],
358+
default: copyMode({}),
359+
values: ["manual", "select", "primary", "both"],
360+
keywords: ["selection", "clipboard", "primary selection", "middle click"],
370361
},
371362
{
372363
title: "Developer tools",

‎packages/tui/src/config/index.tsx‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,15 @@ export const Plugin = Schema.Union([
5757
export const DiffSource = Schema.Union([Vcs.Mode, Schema.Literal("turn")])
5858
export type DiffSource = Schema.Schema.Type<typeof DiffSource>
5959

60+
export const CopyMode = Schema.Literals(["manual", "select", "primary", "both"])
61+
export type CopyMode = Schema.Schema.Type<typeof CopyMode>
62+
63+
export function copyMode(config: Pick<Info, "terminal">): CopyMode {
64+
if (config.terminal?.copy) return config.terminal.copy
65+
if (process.platform === "win32") return "manual"
66+
return process.platform === "linux" ? "both" : "select"
67+
}
68+
6069
export const Cursor = Schema.Struct({
6170
style: Schema.optional(Schema.Literals(["block", "underline", "line", "default"])).annotate({
6271
description: "Cursor shape. Use 'default' to preserve the terminal setting",
@@ -131,11 +140,9 @@ export const Info = Schema.Struct({
131140
terminal: Schema.optional(
132141
Schema.Struct({
133142
title: Schema.optional(Schema.Boolean).annotate({ description: "Update the terminal window title" }),
134-
copy: Schema.optional(Schema.Literals(["manual", "select"])).annotate({
135-
description: "Copy text manually or immediately after selecting it",
136-
}),
137-
primary_selection: Schema.optional(Schema.Boolean).annotate({
138-
description: "Also copy text to the primary selection used by middle-click paste",
143+
copy: Schema.optional(CopyMode).annotate({
144+
description:
145+
"Copy text manually, or on selection to the clipboard ('select'), the primary selection for middle-click paste ('primary'), or both",
139146
}),
140147
}),
141148
).annotate({ description: "Terminal integration settings" }),

‎packages/tui/src/context/clipboard.tsx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1+
import type { ClipboardSelection } from "@opentui/core"
12
import { createContext, type JSX, useContext } from "solid-js"
23

34
export type ClipboardContent = Readonly<{ data: string; mime: string }>
5+
// The first selection decides whether a write succeeds; later selections are best effort.
6+
export type ClipboardSelections = readonly [ClipboardSelection, ...ClipboardSelection[]]
47
export type ClipboardService = Readonly<{
58
read(): Promise<ClipboardContent | undefined>
6-
write(text: string): Promise<void>
9+
write(text: string, selections?: ClipboardSelections): Promise<void>
710
}>
811

912
const ClipboardContext = createContext<ClipboardService>()

‎packages/tui/src/ui/dialog.tsx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { InputRenderable, MouseButton, Renderable, RGBA, TextAttributes } from "
1818
import { createStore } from "solid-js/store"
1919
import { useToast } from "./toast"
2020
import { useClipboard } from "../context/clipboard"
21-
import { useConfig, useNewDesigns } from "../config"
21+
import { copyMode, useConfig, useNewDesigns } from "../config"
2222
import { copy, copyOnSelectRelease } from "../util/selection"
2323

2424
export type DialogSize = "medium" | "large" | "xlarge"
@@ -448,8 +448,7 @@ export function DialogProvider(props: ParentProps) {
448448
const toast = useToast()
449449
const clipboard = useClipboard()
450450
const config = useConfig()
451-
const copyOnSelectEnabled = () =>
452-
(config.data.terminal?.copy ?? (process.platform === "win32" ? "manual" : "select")) === "select"
451+
const copyOnSelectEnabled = () => ["select", "both"].includes(copyMode(config.data))
453452

454453
return (
455454
<ctx.Provider value={value}>
@@ -466,7 +465,9 @@ export function DialogProvider(props: ParentProps) {
466465
evt.stopPropagation()
467466
}}
468467
onMouseUp={
469-
copyOnSelectEnabled() ? (event) => copyOnSelectRelease(event, renderer, toast, clipboard) : undefined
468+
copyMode(config.data) === "manual"
469+
? undefined
470+
: (event) => copyOnSelectRelease(event, renderer, toast, clipboard, copyMode(config.data))
470471
}
471472
>
472473
<Show when={value.stack.length}>

‎packages/tui/src/util/selection.ts‎

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { SelectionBehavior } from "@opentui/core"
2-
import type { ClipboardService } from "../context/clipboard"
2+
import type { CopyMode } from "../config"
3+
import type { ClipboardSelections, ClipboardService } from "../context/clipboard"
34

45
type Toast = {
56
show: (input: { message: string; variant: "info" | "success" | "warning" | "error" }) => void
@@ -36,12 +37,24 @@ export function copyOnSelectRelease(
3637
renderer: Renderer,
3738
toast: Toast,
3839
clipboard: ClipboardService,
40+
mode: CopyMode = "select",
3941
): boolean {
40-
if (!event.isDragging) return false
41-
return copy(renderer, toast, clipboard)
42+
if (!event.isDragging || mode === "manual") return false
43+
return copy(renderer, toast, clipboard, releaseSelections[mode])
4244
}
4345

44-
export function copy(renderer: Renderer, toast: Toast, clipboard: ClipboardService): boolean {
46+
const releaseSelections = {
47+
select: ["clipboard"],
48+
primary: ["primary"],
49+
both: ["clipboard", "primary"],
50+
} as const satisfies Record<Exclude<CopyMode, "manual">, ClipboardSelections>
51+
52+
export function copy(
53+
renderer: Renderer,
54+
toast: Toast,
55+
clipboard: ClipboardService,
56+
selections: ClipboardSelections = ["clipboard"],
57+
): boolean {
4558
const selection = renderer.getSelection()
4659
if (!selection) return false
4760
if (selection.isStart && selection.behavior === "cell") return false
@@ -53,10 +66,13 @@ export function copy(renderer: Renderer, toast: Toast, clipboard: ClipboardServi
5366
const clipboardText =
5467
focus?.getClipboardText && selection.selectedRenderables.includes(focus) ? focus.getClipboardText(text) : text
5568

56-
clipboard
57-
.write(clipboardText)
58-
.then(() => toast.show({ message: "Copied to clipboard", variant: "info" }))
59-
.catch(toast.error)
69+
const write = clipboard.write(clipboardText, selections)
70+
// Like a native selection, a primary-only update is silent and best effort.
71+
if (!selections.includes("clipboard")) {
72+
void write.catch(() => {})
73+
return true
74+
}
75+
write.then(() => toast.show({ message: "Copied to clipboard", variant: "info" })).catch(toast.error)
6076

6177
// Copy never clears selection, including empty releases: clearing also resets multi-click history.
6278
return true

‎packages/tui/test/clipboard.test.ts‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -141,44 +141,44 @@ test("rejects only when no clipboard route accepted the write", async () => {
141141
expect(writes).toEqual([["hello", { destination: "all-available", selection: "clipboard" }]])
142142
})
143143

144-
test("adds the primary selection on request without letting it decide success", async () => {
144+
test.each([
145+
{ selections: undefined, failed: "primary", writes: ["clipboard"], rejects: false },
146+
{ selections: ["clipboard", "primary"], failed: "primary", writes: ["clipboard", "primary"], rejects: false },
147+
{ selections: ["clipboard", "primary"], failed: "clipboard", writes: ["clipboard", "primary"], rejects: true },
148+
{ selections: ["primary"], failed: "clipboard", writes: ["primary"], rejects: false },
149+
{ selections: ["primary"], failed: "primary", writes: ["primary"], rejects: true },
150+
] as const)("the first selection decides the write: %o", async (input) => {
145151
const writes: string[] = []
146-
const failure = new Error("clipboard failed")
147-
const adapter = (failed: "clipboard" | "primary") =>
148-
createClipboardAdapter(
149-
createClipboard({
150-
host: {
151-
maxWriteBytes: 8 * 1024 * 1024,
152-
async read() {
153-
return { status: "empty" }
154-
},
155-
async writeText(text, options) {
156-
writes.push(`${options?.selection}:${text}`)
157-
return options?.selection === failed ? { status: "failed", error: failure } : { status: "written" }
158-
},
159-
async clear() {
160-
return { status: "cleared" }
161-
},
162-
async dispose() {},
152+
const failure = new Error("selection failed")
153+
const clipboard = createClipboardAdapter(
154+
createClipboard({
155+
host: {
156+
maxWriteBytes: 8 * 1024 * 1024,
157+
async read() {
158+
return { status: "empty" }
159+
},
160+
async writeText(_text, options) {
161+
writes.push(options?.selection ?? "clipboard")
162+
return options?.selection === input.failed ? { status: "failed", error: failure } : { status: "written" }
163+
},
164+
async clear() {
165+
return { status: "cleared" }
166+
},
167+
async dispose() {},
168+
},
169+
terminal: {
170+
remote: false,
171+
writeText() {
172+
return { status: "not-attempted", capability: "unsupported" }
163173
},
164-
terminal: {
165-
remote: false,
166-
writeText() {
167-
return { status: "not-attempted", capability: "unsupported" }
168-
},
169-
clear() {
170-
return { status: "not-attempted", capability: "unsupported" }
171-
},
174+
clear() {
175+
return { status: "not-attempted", capability: "unsupported" }
172176
},
173-
}),
174-
)
177+
},
178+
}),
179+
)
175180

176-
expect(await adapter("primary").write("plain")).toBeUndefined()
177-
expect(await adapter("primary").write("both", { primary: true })).toBeUndefined()
178-
expect(
179-
await adapter("clipboard")
180-
.write("both", { primary: true })
181-
.then(undefined, (error) => error),
182-
).toBe(failure)
183-
expect(writes).toEqual(["clipboard:plain", "clipboard:both", "primary:both", "clipboard:both", "primary:both"])
181+
const result = await clipboard.write("text", input.selections).then(undefined, (error) => error)
182+
expect(result).toBe(input.rejects ? failure : undefined)
183+
expect(writes).toEqual([...input.writes])
184184
})

0 commit comments

Comments
 (0)