ketraterm-completion/io.github.ketraterm.completion.api/TerminalCompletionRequest

TerminalCompletionRequest

data class TerminalCompletionRequest @JvmOverloads constructor(val commandLine: String, val cursorOffset: Int, val workingDirectoryUri: String? = null, val profileId: String? = null, val shellCapabilities: TerminalShellCapabilities = PLAIN)

Immutable command-line context used to request completion candidates.

Hosts should construct one request per popup refresh from the visible command line and live host metadata. The completion module treats the request as read-only input and never mutates terminal state.

Throws

IllegalArgumentException

if cursorOffset is outside commandLine, or splits a UTF-16 surrogate pair.

Constructors

TerminalCompletionRequest

@JvmOverloads

constructor(commandLine: String, cursorOffset: Int, workingDirectoryUri: String? = null, profileId: String? = null, shellCapabilities: TerminalShellCapabilities = PLAIN)

Properties

commandLine

val commandLine: String

full command-line text known to the host.

cursorOffset

val cursorOffset: Int

UTF-16 cursor offset within commandLine. The offset must be a scalar boundary and must not split a surrogate pair.

profileId

val profileId: String?

optional host profile id used by host-owned ranking data.

shellCapabilities

val shellCapabilities: TerminalShellCapabilities

resolved shell lexical and replacement policy.

workingDirectoryUri

val workingDirectoryUri: String?

optional current working directory URI.