Editor

This chapter explains editor settings in depth. For the complete, canonical list of every setting and default, see the config.toml reference.

• [editor] Section
• [editor.breadcrumb] Section
• [editor.clipboard] Section
• [editor.statusline] Section
• [editor.lsp] Section
• [terminal.launcher] Section
• [editor.inline-blame] Section
• [editor.cursor.shape] Section
• [editor.file-picker] Section
• [editor.file-explorer] Section
• [editor.buffer-picker] Section
• [editor.auto-pairs] Section
• [editor.files.auto-save] Section
• [editor.search] Section
• [editor.whitespace] Section
• [editor.indent-guides] Section
• [editor.gutters] Section
  • [editor.gutters.line-numbers] Section
  • [editor.gutters.diagnostics] Section
  • [editor.gutters.diff] Section
  • [editor.gutters.spacer] Section
  • [editor.gutters.code-action-hint] Section
• [editor.soft-wrap] Section
• [editor.indent.smart-tab] Section
• [editor.diagnostics.inline] Section
• [editor.completion.word] Section
• [editor.spelling] Section
• [editor.workspace-trust] Section

[editor] Section

[editor.breadcrumb] Section

Allows configuration of the breadcrumb navigation bar.

[editor.breadcrumb]
enable = true
# full: crates > term > src > commands > typed.rs > TypableCommand > name
# file: typed.rs > TypableCommand > name
# none: TypableCommand > name
path = "full" # one of: full, file, none

The bar is displayed at the top of the view.

[editor.clipboard] Section

Mitos can be configured either to use a builtin clipboard configuration or to use a provided command.

For instance, setting it to use OSC 52 termcodes, the configuration would be:

[editor]
clipboard.provider = "termcode"

Alternatively, Mitos can be configured to use arbitrary commands for clipboard integration:

[editor.clipboard.provider.custom]
yank = { command = "cat",  args = ["test.txt"] }
paste = { command = "tee",  args = ["test.txt"] }
yank-primary = { command = "cat",  args = ["test-primary.txt"] } # optional
paste-primary = { command = "tee",  args = ["test-primary.txt"] } # optional

For custom commands the contents of the yank/paste is communicated over stdin/stdout.

[editor.statusline] Section

Allows configuring the statusline at the bottom of each view. Set global = true to show a single statusline at the bottom of the editor for the focused view. Use :toggle statusline.global to switch between the two layouts at runtime.

The configuration distinguishes between two areas of the status line:

[ ... ... LEFT ... ... | ... ... RIGHT ... ... ]

Statusline elements can be defined as follows:

[editor.statusline]
left = ["mode", "spinner"]
right = ["diagnostics", "selections", "position", "file-encoding", "file-line-ending", "file-type"]
separator = "│"
mode.normal = "NORMAL"
mode.insert = "INSERT"
mode.select = "SELECT"
diagnostics = ["warning", "error"]
workspace-diagnostics = ["warning", "error"]

The [editor.statusline] key takes the following sub-keys:

The following statusline elements can be configured:

[editor.lsp] Section

Terminal capability overrides are configured separately under [terminal]: true-color, undercurl, and keyboard.kitty-protocol. See the terminal configuration reference.

[terminal.launcher] Section

Configures the external terminal command used by features such as DAP runInTerminal requests.

Mitos automatically uses a tmux split inside tmux, a WezTerm split when its Unix socket is available, Windows Terminal when found on Windows, or Conhost as the Windows fallback. On other terminals this setting is unset unless configured.

[editor.inline-blame] Section

Inline Git blame shows who last changed a line and the associated commit information at the end of the line. It is available for files tracked by Git and is hidden by default.

To show blame for the current line, add this to your config.toml:

[editor.inline-blame]
show = "cursor-line"

show can be one of the following:

• "all-lines": Display blame on all visible nonempty lines.
• "cursor-line": Display blame on the primary cursor’s line.
• "never": Hide inline blame.

Press Space + B to toggle inline blame off and on. The toggle preserves your choice of "all-lines" or "cursor-line". If you have not chosen a display mode, turning it on uses "cursor-line".

Blank lines and lines with uncommitted changes do not show inline blame.

To show the current line’s blame in the status area, run blame_line from the command palette (Space + ?).

format

Use format to choose which commit details appear in the blame message. For example:

[editor.inline-blame]
show = "cursor-line"
format = "{author}: {title}"

The following placeholders are available:

• {author}: Commit author name.
• {date}: Commit author date.
• {time-ago}: Relative time since the commit.
• {title}: Commit title.
• {body}: Commit body.
• {commit}: Abbreviated commit hash.
• {email}: Commit author email.

[editor.cursor.shape] Section

Defines the shape of cursor in each mode. Valid values for these options are block, bar, underline, or hidden.

💡 Due to limitations of the terminal environment, only the primary cursor can change shape.

[editor.file-picker] Section

Set options for file picker and global search. Ignoring a file means it is not visible in the Mitos file picker and global search.

All git related options are only enabled in a git repository.

Ignore files can be placed locally as .ignore or put in your home directory as ~/.ignore. They support the usual ignore and negative ignore (unignore) rules used in .gitignore files.

Additionally, you can use Mitos-specific ignore files by creating a local .mitos/ignore file in the current workspace or a global ignore file located in your Mitos config directory:

• Linux and Mac: ~/.config/mitos/ignore
• Windows: %AppData%\mitos\ignore

Example:

# unignore in file picker and global search
!.github/
!.gitignore
!.gitattributes

[editor.file-explorer] Section

In addition to the options for the file picker and global search, a similar set of options is presented to configure the file explorer separately. However, unlike the file picker, the defaults are set to avoid ignoring most files.

Note that the ignore files consulted by the file explorer when ignore is set to true are the same ones used by the file picker, including the aforementioned Mitos-specific ignore files.

[editor.buffer-picker] Section

Set options for buffer picker.

Example

[editor.buffer-picker]
start-position = "previous"

[editor.auto-pairs] Section

Automatic delimiter pairing uses an enable flag and an optional pairs map. Omit the map to use the built-in pairs, or provide opening and closing characters:

[editor.auto-pairs]
enable = true
pairs = { '(' = ')', '[' = ']', '{' = '}', '"' = '"' }

Set enable = false to disable pairing. The same table is supported per language. See the configuration reference for defaults and compatibility shorthands.

[editor.files.auto-save] Section

Control auto save behavior.

[editor.search] Section

Search specific options.

[editor.whitespace] Section

Options for rendering whitespace with visible characters. Use :set whitespace.render all to temporarily enable visible whitespace.

Example

[editor.whitespace]
render = "all"
# or control each character
[editor.whitespace.render]
space = "all"
tab = "all"
nbsp = "none"
nnbsp = "none"
newline = "none"

[editor.whitespace.characters]
space = "·"
nbsp = "⍽"
nnbsp = "␣"
tab = "→"
newline = "⏎"
tabpad = "·" # Tabs will look like "→···" (depending on tab width)

[editor.indent-guides] Section

Options for rendering vertical indent guides.

Example:

[editor.indent-guides]
render = true
character = "╎" # Some characters that work well: "▏", "┆", "┊", "⸽"
skip-levels = 1

[editor.gutters] Section

For simplicity, editor.gutters accepts an array of gutter types, which will use default settings for all gutter components.

[editor]
gutters = ["diff", "diagnostics", "line-numbers", "spacer"]

To customize the behavior of gutters, the [editor.gutters] section must be used. This section contains top level settings, as well as settings for specific gutter components as subsections.

Example:

[editor.gutters]
layout = ["diff", "diagnostics", "line-numbers", "spacer"]

[editor.gutters.line-numbers] Section

Options for the line number gutter

Example:

[editor.gutters.line-numbers]
min-width = 1

[editor.gutters.diagnostics] Section

Currently unused

[editor.gutters.diff] Section

The diff gutter option displays colored bars indicating whether a git diff represents that a line was added, removed or changed. These colors are controlled by the theme attributes diff.plus, diff.minus and diff.delta.

Other diff providers will eventually be supported by a future plugin system.

There are currently no options for this section.

[editor.gutters.spacer] Section

Currently unused

[editor.gutters.code-action-hint] Section

The code-action-hint gutter option displays an indicator for whether a code action is available at current selection.

There are currently no options for this section.

[editor.soft-wrap] Section

Options for soft wrapping lines that exceed the view width:

Example:

[editor.soft-wrap]
enable = true
max-wrap = 25 # increase value to reduce forced mid-word wrapping
max-indent-retain = 0
wrap-indicator = ""  # set wrap-indicator to "" to hide it

[editor.indent.smart-tab] Section

Options for navigating and editing using tab key.

Due to lack of support for S-tab in some terminals, the default keybindings don’t fully embrace smart-tab editing experience. If you enjoy smart-tab navigation and a terminal that supports the Enhanced Keyboard protocol, consider setting extra keybindings:

[keys.normal]
tab = "move_parent_node_end"
S-tab = "move_parent_node_start"

[keys.insert]
S-tab = "move_parent_node_start"

[keys.select]
tab = "extend_parent_node_end"
S-tab = "extend_parent_node_start"

[editor.diagnostics.inline] Section

Options for rendering diagnostics inside the text like shown below

fn main() {
  let foo = bar;
            └─ no such value in this scope
}

The allowed values for cursor-line and other-lines are: error, warning, info, hint.

The (first) diagnostic with the highest severity that is not shown inline is rendered at the end of the line (as long as its severity is higher than the diagnostics.end-of-line.severity config option):

fn main() {
  let baz = 1;
  let foo = bar; a local variable with a similar name exists: baz
            └─ no such value in this scope
}

[editor.spelling] Section

Spell checking is opt-in. See the editor.spelling configuration reference for settings and Spell checking for dictionaries, corrections, and personal word lists.

[editor.completion.word] Section

Options for controlling completion of words from open buffers.

Example:

[editor.completion.word]
enable = true
# Set the trigger length lower so that words are completed more often
trigger-length = 4

[editor.workspace-trust] Section

Controls implicit workspace trust. See the workspace trust chapter for the full feature.

Example:

[editor.workspace-trust]
# Even if `false`, the statusline `[⚠]` indicator is still shown.
prompt = false

# "none":     prompt for every workspace.
# "servers":  trust LSP and DAP launches but still gate local config and git;
#             .mitos/config.toml, .mitos/languages.toml, etc. need :workspace-trust.
# "insecure": trust everything (discouraged).
level = "servers"

# Discouraged: skips .mitos/ change detection and trusts anything that lands
# under a matching path. `~` and environment variables are expanded.
trusted = ["~/src/github.com/me/*"]

1. In most cases, you also need to enable the auto-format setting under languages.toml. You can find the reasoning here. ↩

2. By default, a progress spinner is shown in the statusline beside the file path. ↩ ↩2

3. You may also have to activate them in the language server config for them to appear, not just in Mitos. Inlay hints in Mitos are still being improved on and may be a little bit laggy/janky under some circumstances. Please report any bugs you see so we can fix them! ↩