robinwobin.dev
minimal extui fuzzy finder for neovim
doc: fix tag alignment
+23
-23
doc/artio.txt
+23
-23
doc/artio.txt
···
3
3
4
4
==============================================================================
5
5
6
-
FEATURES *artio-features*
6
+
FEATURES *artio-features*
7
7
8
8
Requires Neovim `>= 0.12`
9
9
···
44
44
45
45
==============================================================================
46
46
47
-
CONFIGURATION *artio-config*
47
+
CONFIGURATION *artio-config*
48
48
49
49
Options ~
50
50
···
133
133
134
134
==============================================================================
135
135
136
-
API *artio-api*
136
+
API *artio-api*
137
137
138
-
artio.pick({opts}) *artio.pick()*
138
+
artio.pick({opts}) *artio.pick()*
139
139
140
140
create a new picker |artio.Picker| and start it.
141
141
···
146
146
})
147
147
<
148
148
149
-
artio.generic({items}, {props}) *artio.generic()*
149
+
artio.generic({items}, {props}) *artio.generic()*
150
150
151
151
creates a generic picker from the given items and props.
152
152
uses the default |artio.sorter| function.
153
153
154
-
*artio.select()*
154
+
*artio.select()*
155
155
artio.select({items}, {opts}, {on_choice}, {start_opts?})
156
156
157
157
the |vim.ui.select| interface implemented for artio.
158
158
adds an optional `{start_opts?}` argument that accepts artio specific
159
159
options.
160
160
161
-
artio.resume() *artio.resume()*
161
+
artio.resume() *artio.resume()*
162
162
163
163
resume the last closed picker. does not work across neovim
164
164
restarts/sessions.
165
165
166
166
Plug: `<Plug>(artio-resume)`.
167
167
168
-
API-PICKER *artio-api-picker*
168
+
API-PICKER *artio-api-picker*
169
169
170
170
*artio.Picker*
171
171
a picker is a special table that holds the state of the picker.
···
206
206
- {mappings}? (`table<string, string>`)
207
207
mappings from the user config.
208
208
209
-
API-SORTER *artio-api-sorter*
209
+
API-SORTER *artio-api-sorter*
210
210
211
211
*artio.Picker.sorter*
212
212
a function that takes an array of |artio.Picker.item| and an input string
···
235
235
- {v} (`any`)
236
236
- {text} (`string`)
237
237
238
-
artio.sorter({items}, {input}) *artio.sorter()*
238
+
artio.sorter({items}, {input}) *artio.sorter()*
239
239
240
240
the default sorter provides support for pattern matching. a `/.../` match at
241
241
the start of the input will limit the fuzzy sorter to items matching the
···
248
248
artio builtins are for general editor use. they are accessible through
249
249
`require('artio.builtins')`.
250
250
251
-
builtins.builtins() *artio-builtins*
251
+
builtins.builtins() *artio-builtins*
252
252
253
253
list of all builtins.
254
254
255
255
Plug: `<Plug>(artio-builtins)`.
256
256
257
-
builtins.files() *artio-files*
257
+
builtins.files() *artio-files*
258
258
259
259
list all files within the current directory.
260
260
261
261
Plug: `<Plug>(artio-files)`.
262
262
263
-
builtins.grep() *artio-grep*
263
+
builtins.grep() *artio-grep*
264
264
265
265
grep in the current directory.
266
266
runs `rg` if available; uses `grep` as a fallback.
267
267
268
268
Plug: `<Plug>(artio-grep)`.
269
269
270
-
builtins.oldfiles() *artio-oldfiles*
270
+
builtins.oldfiles() *artio-oldfiles*
271
271
272
272
list all files in |v:oldfiles|; recently accessed files in neovim. these are
273
273
stored in |shada| memory.
274
274
275
275
Plug: `<Plug>(artio-oldfiles)`.
276
276
277
-
builtins.buffergrep() *artio-buffergrep*
277
+
builtins.buffergrep() *artio-buffergrep*
278
278
279
279
grep in the current buffer. uses the default sorter to match lines.
280
280
281
281
Plug: `<Plug>(artio-buffergrep)`.
282
282
283
-
builtins.helptags() *artio-helptags*
283
+
builtins.helptags() *artio-helptags*
284
284
285
285
list all help tags. behaves like |:help|.
286
286
287
287
Plug: `<Plug>(artio-helptags)`.
288
288
289
-
builtins.buffers() *artio-buffers*
289
+
builtins.buffers() *artio-buffers*
290
290
291
291
list all open buffers. behaves like |:buffers|.
292
292
293
293
Plug: `<Plug>(artio-buffers)`.
294
294
295
-
builtins.smart() *artio-smart*
295
+
builtins.smart() *artio-smart*
296
296
297
297
uses the regular files picker as a base
298
298
- boosts items in the bufferlist
···
301
301
302
302
Plug: `<Plug>(artio-smart)`.
303
303
304
-
builtins.colorschemes() *artio-colorschemes*
304
+
builtins.colorschemes() *artio-colorschemes*
305
305
306
306
list all colorschemes by finding all `colors/*.{vim,lua}` files in the
307
307
runtime.
308
308
309
309
Plug: `<Plug>(artio-colorschemes)`.
310
310
311
-
builtins.highlights() *artio-highlights*
311
+
builtins.highlights() *artio-highlights*
312
312
313
313
list all highlights. behaves like |:highlight|.
314
314
315
315
Plug: `<Plug>(artio-highlights)`.
316
316
317
-
builtins.diagnostics({buffer}) *artio-diagnostics*
317
+
builtins.diagnostics({buffer}) *artio-diagnostics*
318
318
319
319
list all diagnostics. uses diagnostics from |vim.diagnostic.get()|.
320
320
uses all diagnostics in the workspace if no buffer is specified.
321
321
322
322
Plug: `<Plug>(artio-diagnostics)`.
323
323
324
-
builtins.diagnostics_buffer({buffer}) *artio-diagnostics-buffer*
324
+
builtins.diagnostics_buffer({buffer}) *artio-diagnostics-buffer*
325
325
326
326
list all diagnostics for the given buffer. uses diagnostics from
327
327
|vim.diagnostic.get()|. uses the current buffer if no buffer is specified.
328
328
329
329
Plug: `<Plug>(artio-diagnostics-buffer)`.
330
330
331
-
builtins.keymaps() *artio-keymaps*
331
+
builtins.keymaps() *artio-keymaps*
332
332
333
333
list all keymaps. uses formatted data from |nvim_get_keymap()|.
334
334