bendns' repos / helix
Unnamed repository; edit this file 'description' to name the repository. 
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

Configuration

To override global configuration parameters, create a config.toml file located in your config directory:

  • Linux and Mac: ~/.config/helix/config.toml
  • Windows: %AppData%\helix\config.toml

Hint: You can easily open the config file by typing :config-open within Helix normal mode.

Example config:

theme = "onedark"

[editor]
line-number = "relative"
mouse = false

[editor.cursor-shape]
insert = "bar"
normal = "block"
select = "underline"

[editor.file-picker]
hidden = false

Editor

[editor] Section

Key Description Default
scrolloff Number of lines of padding around the edge of the screen when scrolling. 3
mouse Enable mouse mode. true
middle-click-paste Middle click paste support. true
scroll-lines Number of lines to scroll per scroll wheel step. 3
shell Shell to use when running external commands. Unix: ["sh", "-c"]
Windows: ["cmd", "/C"]
line-number Line number display: absolute simply shows each line's number, while relative shows the distance from the current line. When unfocused or in insert mode, relative will still show absolute line numbers. absolute
gutters Gutters to display: Available are diagnostics and line-numbers, note that diagnostics also includes other features like breakpoints ["diagnostics", "line-numbers"]
auto-completion Enable automatic pop up of auto-completion. true
auto-format Enable automatic formatting on save. true
idle-timeout Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. 400
completion-trigger-len The min-length of word under cursor to trigger autocompletion 2
auto-info Whether to display infoboxes true
true-color Set to true to override automatic detection of terminal truecolor support in the event of a false negative. false
rulers List of column positions at which to display the rulers. Can be overridden by language specific rulers in languages.toml file. []

[editor.lsp] Section

Key Description Default
display-messages Display LSP progress messages below statusline[^1] false

[^1]: A progress spinner is always shown in the statusline beside the file path.

[editor.cursor-shape] Section

Defines the shape of cursor in each mode. Note that due to limitations of the terminal environment, only the primary cursor can change shape. Valid values for these options are block, bar, underline, or none.

Key Description Default
normal Cursor shape in normal mode block
insert Cursor shape in insert mode block
select Cursor shape in select mode block

[editor.file-picker] Section

Sets options for file picker and global search. All but the last key listed in the default file-picker configuration below are IgnoreOptions: whether hidden files and files listed within ignore files are ignored by (not visible in) the helix file picker and global search. There is also one other key, max-depth available, which is not defined by default.

Key Description Default
hidden Enables ignoring hidden files. true
parents Enables reading ignore files from parent directories. true
ignore Enables reading .ignore files. true
git-ignore Enables reading .gitignore files. true
git-global Enables reading global .gitignore, whose path is specified in git's config: core.excludefile option. true
git-exclude Enables reading .git/info/exclude files. true
max-depth Set with an integer value for maximum depth to recurse. Defaults to None.

[editor.auto-pairs] Section

Enables automatic insertion of pairs to parentheses, brackets, etc. Can be a simple boolean value, or a specific mapping of pairs of single characters.

To disable auto-pairs altogether, set auto-pairs to false:

[editor]
auto-pairs = false # defaults to `true`

The default pairs are (){}[]''""`</code>, but these can be customized by settingauto-pairs` to a TOML table:

[editor.auto-pairs]
'(' = ')'
'{' = '}'
'[' = ']'
'"' = '"'
'`' = '`'
'<' = '>'

Additionally, this setting can be used in a language config. Unless the editor setting is false, this will override the editor config in documents with this language.

Example languages.toml that adds <> and removes ''

[[language]]
name = "rust"

[language.auto-pairs]
'(' = ')'
'{' = '}'
'[' = ']'
'"' = '"'
'`' = '`'
'<' = '>'

[editor.search] Section

Search specific options.

Key Description Default
smart-case Enable smart case regex searching (case insensitive unless pattern contains upper case characters) true
wrap-around Whether the search should wrap after depleting the matches true

[editor.whitespace] Section

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

Key Description Default
render Whether to render whitespace. May either be "all" or "none", or a table with sub-keys space, tab, and newline. "none"
characters Literal characters to use when rendering whitespace. Sub-keys may be any of tab, space, nbsp or newline See example below

Example

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

[editor.whitespace.characters]
space = "·"
nbsp = "⍽"
tab = "→"
newline = "⏎"