FilesExpand file tree

main

/

types.lua

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

547 lines (456 loc) · 21.1 KB

main

/

types.lua

Copy path

Top

File metadata and controls

• Code
• Blame

547 lines (456 loc) · 21.1 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

---@class OpencodeDiagnostic

---@field message string

---@field severity number

---@field lnum number

---@field col number

---@field end_lnum? number

---@field end_col? number

---@field source? string

---@field code? string|number

---@field user_data? any

---@class OpencodeConfigFile

---@field theme string

---@field autoshare boolean

---@field autoupdate boolean

---@field model string

---@field agent table<string, table>

---@field mcp table<string, table>

---@field mode table<string, table>

---@field command table<string, table>

---@field plugin table[]

---@field username string

---@class OpencodeProject

---@field id string

---@field worktree string

---@field vcs string

---@field time { created: number }

---@class OpencodePath

---@field state string

---@field config string

---@field worktree string

---@field directory string

---@class OpencodeCommand

---@field description string

---@field agent string

---@field model string

---@field template string

---@class OpencodeUICommand

---@field desc string

---@field completions? string[]|function

---@field sub_completions? string[]

---@field fn function

---@class SessionRevertInfo

---@field messageID string

---@field partID? string

---@field snapshot string

---@field diff string

---@class SessionShareInfo

---@field url string

---@class Session

---@field workspace string

---@field title string

---@field time { created: number, updated: number }

---@field id string

---@field parentID string|nil

---@field revert? SessionRevertInfo

---@field share? SessionShareInfo

---@class OpencodeKeymapEntry

---@field [1] string # Function name

---@field mode? string|string[] # Mode(s) for the keymap

---@field desc? string # Keymap description

---@class OpencodeKeymapEditor : table<string, OpencodeKeymapEntry>

---@class OpencodeKeymapInputWindow : table<string, OpencodeKeymapEntry>

---@class OpencodeKeymapOutputWindow : table<string, OpencodeKeymapEntry>

---@class OpencodeKeymap

---@field editor OpencodeKeymapEditor

---@field input_window OpencodeKeymapInputWindow

---@field output_window OpencodeKeymapOutputWindow

---@field session_picker OpencodeSessionPickerKeymap

---@field timeline_picker OpencodeTimelinePickerKeymap

---@field history_picker OpencodeHistoryPickerKeymap

---@field quick_chat OpencodeQuickChatKeymap

---@class OpencodeSessionPickerKeymap

---@field delete_session OpencodeKeymapEntry

---@field new_session OpencodeKeymapEntry

---@field rename_session OpencodeKeymapEntry

---@class OpencodeTimelinePickerKeymap

---@field undo OpencodeKeymapEntry

---@field fork OpencodeKeymapEntry

---@class OpencodeHistoryPickerKeymap

---@field delete_entry OpencodeKeymapEntry

---@field clear_all OpencodeKeymapEntry

---@class OpencodeQuickChatKeymap

---@field cancel OpencodeKeymapEntry

---@class OpencodeCompletionFileSourcesConfig

---@field enabled boolean

---@field preferred_cli_tool 'server'|'fd'|'fdfind'|'rg'|'git'

---@field ignore_patterns string[]

---@field max_files number

---@field max_display_length number

---@class OpencodeCompletionConfig

---@field file_sources OpencodeCompletionFileSourcesConfig

---@class OpencodeLoadingAnimationConfig

---@field frames string[]

---@class OpencodeUIConfig

---@field position 'right'|'left'|'current' # Position of the UI (default: 'right')

---@field input_position 'bottom'|'top' # Position of the input window (default: 'bottom')

---@field window_width number

---@field zoom_width number

---@field input_height number

---@field picker_width number|nil # Default width for all pickers (nil uses current window width)

---@field display_model boolean

---@field display_context_size boolean

---@field display_cost boolean

---@field window_highlight string

---@field icons { preset: 'text'|'nerdfonts', overrides: table<string,string> }

---@field loading_animation OpencodeLoadingAnimationConfig

---@field output OpencodeUIOutputConfig

---@field input { text: { wrap: boolean } }

---@field completion OpencodeCompletionConfig

---@field highlights? OpencodeHighlightConfig

---@field picker OpencodeUIPickerConfig

---@class OpencodeHighlightConfig

---@field vertical_borders? { tool?: { fg?: string, bg?: string }, user?: { fg?: string, bg?: string }, assistant?: { fg?: string, bg?: string } }

---@class OpencodeUIOutputRenderingConfig

---@field markdown_debounce_ms number

---@field on_data_rendered (fun(buf: integer, win: integer)|boolean)|nil

---@field event_throttle_ms number

---@field event_collapsing boolean

---@class OpencodeUIOutputConfig

---@field tools { show_output: boolean, show_reasoning_output: boolean }

---@field rendering OpencodeUIOutputRenderingConfig

---@field always_scroll_to_bottom boolean

---@class OpencodeUIPickerConfig

---@field snacks_layout? snacks.picker.layout.Config

--- TODO: add more picker-specific presets

---@class OpencodeContextConfig

---@field enabled boolean

---@field cursor_data { enabled: boolean, context_lines?: number }

---@field diagnostics { enabled:boolean, info: boolean, warning: boolean, error: boolean, only_closest: boolean}

---@field current_file { enabled: boolean }

---@field selection { enabled: boolean }

---@field agents { enabled: boolean }

---@field buffer { enabled: boolean }

---@field git_diff { enabled: boolean }

---@class OpencodeDebugConfig

---@field enabled boolean

---@field capture_streamed_events boolean

---@field show_ids boolean

---@field quick_chat {keep_session: boolean, set_active_session: boolean}

---@class OpencodeHooks

---@field on_file_edited? fun(file: string): nil

---@field on_session_loaded? fun(session: Session): nil

---@field on_done_thinking? fun(session: Session): nil

---@field on_permission_requested? fun(session: Session): nil

---@class OpencodeProviders

---@field [string] string[]

---@class OpencodeConfigModule

---@field defaults OpencodeConfig

---@field values OpencodeConfig

---@field setup fun(opts?: OpencodeConfig): nil

---@field get_key_for_function fun(scope: 'editor'|'input_window'|'output_window', function_name: string): string|nil

---@class OpencodeQuickChatConfig

---@field default_model? string -- Use current model if nil

---@field default_agent? string -- Use current mode if nil

---@field instructions? string[] -- Custom instructions for quick chat

---@class OpencodeConfig

---@field preferred_picker 'telescope' | 'fzf' | 'mini.pick' | 'snacks' | 'select' | nil

---@field preferred_completion 'blink' | 'nvim-cmp' | 'vim_complete' | nil -- Preferred completion strategy for mentons and commands

---@field default_global_keymaps boolean

---@field default_mode 'build' | 'plan' | string -- Default mode

---@field default_system_prompt string | nil

---@field keymap_prefix string

---@field opencode_executable 'opencode' | string -- Command run for calling opencode

---@field keymap OpencodeKeymap

---@field ui OpencodeUIConfig

---@field context OpencodeContextConfig

---@field debug OpencodeDebugConfig

---@field prompt_guard? fun(mentioned_files: string[]): boolean

---@field hooks OpencodeHooks

---@field legacy_commands boolean

---@field quick_chat OpencodeQuickChatConfig

---@class MessagePartState

---@field input TaskToolInput|BashToolInput|FileToolInput|TodoToolInput|GlobToolInput|GrepToolInput|WebFetchToolInput|ListToolInput|QuestionToolInput Input data for the tool

---@field metadata TaskToolMetadata|ToolMetadataBase|WebFetchToolMetadata|BashToolMetadata|FileToolMetadata|GlobToolMetadata|GrepToolMetadata|ListToolMetadata|QuestionToolMetadata Metadata about the tool execution

---@field time { start: number, end: number } Timestamps for tool use

---@field status string Status of the tool use (e.g., 'running', 'completed', 'failed')

---@field title string Title of the tool use

---@field output string Output of the tool use, if applicable

---@field error? string Error message if the part failed

---@class ToolMetadataBase

---@field error boolean|nil Whether the tool execution resulted in an error

---@field message string|nil Optional status or error message

---@class TaskToolMetadata: ToolMetadataBase

---@field summary TaskToolSummaryItem[]

---@field sessionId string|nil Child session ID

---@class WebFetchToolMetadata: ToolMetadataBase

---@field http_status number|nil HTTP response status code

---@field content_type string|nil Content type of the response

---@class BashToolMetadata: ToolMetadataBase

---@field output string|nil

---@class FileToolMetadata: ToolMetadataBase

---@field diff string|nil The diff of changes made to the file

---@field file_type string|nil Detected file type/extension

---@field line_count number|nil Number of lines in the file

---@class GlobToolMetadata: ToolMetadataBase

---@field truncated boolean|nil

---@field count number|nil

---@class GrepToolMetadata: ToolMetadataBase

---@field truncated boolean|nil

---@field matches number|nil

---@class BashToolInput

---@field command string The command to execute

---@field description string Description of what the command does

---@class FileToolInput

---@field filePath string The path to the file

---@field content? string Content to write (for write tool)

---@class TodoToolInput

---@field todos { id: string, content: string, status: 'pending'|'in_progress'|'completed'|'cancelled', priority: 'high'|'medium'|'low' }[]

---@class ListToolInput

---@field path string The directory path to list

---@class ListToolMetadata: ToolMetadataBase

---@field truncated boolean|nil

---@field count number|nil

---@class GlobToolInput

---@field pattern string The glob pattern to match files against

---@field path? string Optional directory to search in

---@class ListToolOutput

---@field output string The raw output string from the list tool

---@class GrepToolInput

---@field pattern? string The glob pattern to match

---@field path? string Optional directory to search in

---@field include? string Optional file type to include (e.g., '*.lua')

---@class WebFetchToolInput

---@field url string The URL to fetch content from

---@field format 'text'|'markdown'|'html'

---@field timeout? number Optional timeout in seconds (max 120)

---@class TaskToolInput

---@field prompt string The subtask prompt

---@field description string Description of the subtask

---@field subagent_type string The type of specialized agent to use

---@class TaskToolSummaryItem

---@field id string Tool call ID

---@field tool string Tool name

---@field state { status: string, title?: string }

-- Question types

---@class OpencodeQuestionOption

---@field label string Display text

---@field description string Explanation of choice

---@class OpencodeQuestionInfo

---@field question string Complete question

---@field header string Very short label (max 12 chars)

---@field options OpencodeQuestionOption[] Available choices

---@field multiple? boolean Allow selecting multiple choices

---@class OpencodeQuestionRequest

---@field id string Question request ID

---@field sessionID string Session ID

---@field questions OpencodeQuestionInfo[] Questions to ask

---@field tool? { messageID: string, callID: string }

---@class QuestionToolInput

---@field questions OpencodeQuestionInfo[] Questions that were asked

---@class QuestionToolMetadata: ToolMetadataBase

---@field answers string[][] Array of answer arrays (one per question)

---@field truncated boolean Whether the results were truncated

---@class MessageTokenCount

---@field reasoning number

---@field input number

---@field output number

---@field cache { write: number, read: number }

---@class OutputMetadata

---@field msg_idx number|nil Message index in session

---@field part_idx number|nil Part index in message

---@field role 'user'|'assistant'|'system'|nil Message role

---@field type 'text'|'tool'|'header'|'patch'|'step-start'|nil Message part type

---@field snapshot? string|nil snapshot commit hash

---@class OutputAction

---@field text string Action text

---@field type 'diff_revert_all'|'diff_revert_selected_file'|'diff_open'|'diff_restore_snapshot_file'|'diff_restore_snapshot_all'|'select_child_session' Type of action

---@field args? string[] Optional arguments for the command

---@field key string keybinding for the action

---@field display_line number Line number to display the action

---@field range? { from: number, to: number } Optional range for the action

---@alias OutputExtmarkType vim.api.keyset.set_extmark & {start_col:0}

---@alias OutputExtmark OutputExtmarkType|fun():OutputExtmarkType

---@class OpencodeMessage

---@field info MessageInfo Metadata about the message

---@field parts OpencodeMessagePart[] Parts that make up the message

---@field references CodeReference[]|nil Parsed file references from text parts (cached)

---@field system string|nil System message content

---@class MessageInfo

---@field id string Unique message identifier

---@field sessionID string Unique session identifier

---@field tokens MessageTokenCount Token usage statistics

---@field system string[] System messages

---@field time { created: number, completed: number } Timestamps

---@field cost number Cost of the message

---@field path { cwd: string, root: string } Working directory paths

---@field modelID string Model identifier

---@field providerID string Provider identifier

---@field role 'user'|'assistant'|'system' Role of the message sender

---@field system_role string|nil Role defined in system messages

---@field mode string|nil Agent or mode identifier

---@field error table

---@class RestorePoint

---@field id string Unique restore point identifier

---@field from_snapshot_id string|nil ID of the snapshot this restore point is based on

---@field files string[] List of file paths included in the restore point

---@field deleted_files string[] List of files that were deleted in this restore point

---@field created_at number Timestamp when the restore point was created

---@class OpencodeSnapshotPatch

---@field hash string Unique identifier for the snapshot

---@field files string[] List of file paths included in the snapshot

---@class OpenOpts

---@field focus? 'input' | 'output'

---@field start_insert? boolean

---@field new_session? boolean

---@class SendMessageOpts

---@field new_session? boolean

---@field context? OpencodeContextConfig

---@field model? string

---@field agent? string

---@field variant? string

---@field system? string

---@class CompletionContext

---@field trigger_char string The character that triggered completion

---@field input string The current input text

---@field cursor_pos number Current cursor position

---@field line string The full current line text

---@class CompletionItem

---@field label string Display text for the completion item

---@field kind string Type of completion item (e.g., 'file', 'subagent')

---@field kind_icon string Icon representing the kind

---@field kind_hl? string Highlight group for the kind

---@field detail string Additional detail text

---@field documentation string Documentation text

---@field insert_text string Text to insert when selected

---@field source_name string Name of the completion source

---@field priority? number Optional priority for individual item sorting (lower numbers have higher priority)

---@field data table Additional data associated with the item

---@class CompletionSource

---@field name string Name of the completion source

---@field priority number Priority for ordering sources

---@field complete fun(context: CompletionContext): Promise<CompletionItem[]> Function to generate completion items

---@field on_complete fun(item: CompletionItem): nil Optional callback when item is selected

---@class OpencodeContext

---@field current_file OpencodeContextFile|nil

---@field cursor_data OpencodeContextCursorData|nil

---@field mentioned_files string[]|nil

---@field mentioned_subagents string[]|nil

---@field selections OpencodeContextSelection[]|nil

---@field linter_errors OpencodeDiagnostic[]|nil

---@class OpencodeContextSelection

---@field file OpencodeContextFile

---@field content string|nil

---@field lines string|nil

---@class OpencodeContextCursorData

---@field line number

---@field column number

---@field line_content string

---@field lines_before string[]

---@field lines_after string[]

---@class OpencodeContextFile

---@field path string

---@field name string

---@field extension string

---@field sent_at? number

---@class OpencodeMessagePartSourceText

---@field start number

---@field value string

---@field ['end'] number

---@class OpencodeMessagePartSource

---@field path string|nil

---@field type string|nil

---@field text OpencodeMessagePartSourceText|nil

---@field value string|nil

---@class OpencodeMessagePart

---@field type 'text'|'file'|'agent'|'tool'|'step-start'|'patch'|'reasoning'|string

---@field id string|nil Unique identifier for tool use parts

---@field text string|nil

---@field tool string|nil Name of the tool being used

---@field state MessagePartState|nil State information for tool use parts

---@field filename string|nil

---@field mime string|nil

---@field url string|nil

---@field source OpencodeMessagePartSource|nil

---@field name string|nil

---@field synthetic boolean|nil

---@field snapshot string|nil Snapshot commit hash

---@field sessionID string|nil Session identifier

---@field messageID string|nil Message identifier

---@field callID string|nil Call identifier (used for tools)

---@field hash string|nil Hash identifier for patch parts

---@field files string[]|nil List of file paths for patch parts

---@field time { start: number, end?: number }|nil Timestamps for the part

---@class OpencodeModelModalities

---@field input ('text'|'image'|'audio'|'video')[] Supported input modalities

---@field output ('text')[] Supported output modalities

---@class OpencodeModelCost

---@field input number Cost per input token

---@field output number Cost per output token

---@field cache_read number|nil Cost per cache read token

---@field cache_write number|nil Cost per cache write token

---@class OpencodeModelLimits

---@field context number Maximum context length in tokens

---@field output number Maximum output length in tokens

---@class OpencodeModelVariant

---@field reasoningEffort string Reasoning effort level (e.g., "low", "medium", "high")

---@class OpencodeModel

---@field id string Unique identifier for the model

---@field name string Human-readable name of the model

---@field attachment boolean Whether the model supports file attachments

---@field reasoning boolean Whether the model supports reasoning/thinking

---@field temperature boolean Whether the model supports temperature parameter

---@field tool_call boolean Whether the model supports tool calling

---@field knowledge string|nil Knowledge cutoff date (e.g., "2024-04")

---@field release_date string Release date in YYYY-MM-DD format

---@field last_updated string Last updated date in YYYY-MM-DD format

---@field modalities OpencodeModelModalities Supported input/output modalities

---@field open_weights boolean Whether the model has open weights

---@field limit OpencodeModelLimits Token limits for the model

---@field cost OpencodeModelCost Pricing information for the model

---@field variants table<string, OpencodeModelVariant>|nil Model variants with different configurations

---@class OpencodeProvider

---@field id string Unique identifier for the provider

---@field env string[] Required environment variables for authentication

---@field npm string NPM package name for the provider SDK

---@field api string|nil Base API URL for the provider

---@field name string Human-readable name of the provider

---@field doc string|nil Documentation URL for the provider

---@field models table<string, OpencodeModel> Map of model ID to model configuration

---@class OpencodeProvidersResponse

---@field providers OpencodeProvider[] List of available providers

---@field default table<string, string> Map of provider ID to default model ID

---@class OpencodeToolListItem

---@field id string Tool identifier

---@field description string Tool description

---@field parameters any JSON schema parameters for the tool

---@alias OpencodeToolList OpencodeToolListItem[]

---@class OpencodeAgentPermissionBash

---@field [string] string Permission level ('allow', 'deny', etc.)

---@class OpencodeAgentPermission

---@field edit string Permission level for edit operations

---@field webfetch string Permission level for web fetch operations

---@field bash OpencodeAgentPermissionBash Bash command permissions

---@class OpencodeAgentModel

---@field providerID string Provider identifier

---@field modelID string Model identifier

---@class OpencodeAgent

---@field name string Unique identifier for the agent

---@field description string Human-readable description of the agent

---@field tools table<string, boolean> Map of tool names to availability

---@field options table Additional configuration options

---@field permission OpencodeAgentPermission Permissions for various operations

---@field mode 'primary'|'subagent'|'all' Agent execution mode

---@field builtIn boolean Whether this is a built-in agent

---@field model OpencodeAgentModel|nil Optional model configuration

---@field prompt string|nil Optional custom prompt for the agent

---@field temperature number|nil Optional temperature setting

---@class OpencodeSlashCommand

---@field slash_cmd string The command trigger (e.g., "/help")

---@field desc string|nil Description of the command

---@field fn fun(args:string[]):nil Function to execute the command

---@field args boolean Whether the command accepts arguments

---@class OpencodeRevertSummary

---@field messages number Number of messages reverted

---@field tool_calls number Number of tool calls reverted

---@field files table<string, {additions: number, deletions: number}> Summary of file changes reverted