Skip to content

refactor: cleanup and split formatters in multiple modules #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sudo-tee merged 7 commits into from
Mar 9, 2026
Merged

refactor: cleanup and split formatters in multiple modules #310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
77b1ae4
feat: add line numbers to diff
sudo-tee Mar 6, 2026
f3fe636
tests(renderer): regenerate tests that contains diffs
sudo-tee Mar 6, 2026
3617941
refactor(formatter): split tool rendering into per-tool modules
sudo-tee Mar 6, 2026
f20f99e
refactor(formatter): split tool formatters into individual modules
sudo-tee Mar 7, 2026
f0dadf1
feat: add tool type check for formatters
sudo-tee Mar 8, 2026
a667bb9
chore: cleanup README
sudo-tee Mar 9, 2026
555a8c4
chore: formatters cleanup
sudo-tee Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,6 @@ Install the plugin with your favorite package manager. See the [Configuration](#

## ⚙️ Configuration

> **Note**: The keymap configuration structure has been updated. Old keymaps (`keymap.global` and `keymap.window`) will be mapped to the new format (`keymap.editor`, `keymap.input_window`, `keymap.output_window`) but you should update your config to the new format. See [Keymap Configuration](#keymap-configuration) below for details.

```lua
-- Default configuration with all available options
require('opencode').setup({
Expand Down Expand Up @@ -298,7 +296,7 @@ require('opencode').setup({
},
diagnostics = {
info = false, -- Include diagnostics info in the context (default to false
warn = true, -- Include diagnostics warnings in the context
warning = true, -- Include diagnostics warnings in the context
error = true, -- Include diagnostics errors in the context
only_closest = false, -- If true, only diagnostics for cursor/selection
},
Expand Down Expand Up @@ -345,7 +343,7 @@ require('opencode').setup({
},
quick_chat = {
default_model = nil, -- works better with a fast model like gpt-4.1
default_agent = 'plan', -- plan ensure no file modifications by default
default_agent = nil, -- Uses the current mode when nil
instructions = nil, -- Use built-in instructions if nil
},
})
Expand All @@ -360,7 +358,7 @@ The keymap configuration has been restructured for better organization and clari
- **`output_window`**: Keymaps specific to the output window
- **`permission`**: Special keymaps for responding to permission requests (available in input/output windows when there's a pending permission)

**Backward Compatibility**: The plugin automatically maps configurations that use `keymap.global` and `keymap.window` to the new structure. A deprecation warning will be shown during migration. Update your configuration to use the new structure to remove the warning.
Configure keymaps with the current nested tables directly: `keymap.editor`, `keymap.input_window`, and `keymap.output_window`.

Each keymap entry is a table consising of:

Expand Down Expand Up @@ -670,7 +668,7 @@ You can pass additional options when running a prompt via command or API:
- `current_file`
- `selection`
- `diagnostics.info`
- `diagnostics.warn`
- `diagnostics.warning`
- `diagnostics.error`
- `cursor_data`

Expand All @@ -680,7 +678,7 @@ Run a prompt in a new session using the Plan agent and disabling current file co

```vim
:Opencode run new_session "Please help me plan a new feature" agent=plan context.current_file.enabled=false
:Opencode run "Fix the bug in the current file" model=github-copilot/claude-sonned-4
:Opencode run "Fix the bug in the current file" model=github-copilot/claude-sonnet-4
```

## 👮 Permissions
Expand All @@ -694,8 +692,8 @@ Opencode can issue permission requests for potentially destructive operations (f

### Responding to Permission Requests

- **Respond via keys:** In the input window press `a` to accept once, `A` to accept and remember (accept all), or `d` to deny. These window keys are configurable in `ui.keymap.window.permission_*`.
- **Global keymaps:** There are also global keymaps to respond outside the input window: `<leader>opa` (accept once), `<leader>opA` (accept all), `<leader>opd` (deny). These are configurable in `keymap.global.permission_*`.
- **Respond via the dialog:** Focus the Opencode window, move with `j`/`k` or arrow keys, then confirm with `<CR>`. Number shortcuts `1-3` also work for the visible options.
- **Command:** Use `:Opencode permission accept`, `:Opencode permission accept_all`, or `:Opencode permission deny`. You can pass an index to target a specific queued permission.
- **API:** Programmatic responses are available: `require('opencode.api').permission_accept()`, `require('opencode.api').permission_accept_all()`, `require('opencode.api').permission_deny()` which map to responses `"once"`, `"always"`, and `"reject"` respectively.
- **Behavior:** `accept once` allows the single requested action, `accept all` grants persistent permission for similar requests in the current session, and `deny` rejects the request.

Expand All @@ -722,7 +720,7 @@ Supported pickers include [`fzf-lua`](https://github.com/ibhagwan/fzf-lua), [`te

### Context bar

You can quiclkly see the current context items in the context bar at the top of the input window:
You can quickly see the current context items in the context bar at the top of the input window:

<div align="center">
<img src="https://i.imgur.com/vGgu6br.png" alt="Opencode.nvim context bar" width="90%" />
Expand Down Expand Up @@ -772,7 +770,7 @@ Press `<M-m>` (Alt+M) in the input window to switch between agents during a sess

You can create custom agents through your opencode config file. Each agent can have its own:

- Agentl configuration
- Agent configuration
- Custom prompt
- Enabled/disabled tools
- And more
Expand Down
Loading