From 9f4dd18379850ee0c054dcbb892348dd6095e513 Mon Sep 17 00:00:00 2001 From: robin Date: Thu, 8 Jan 2026 11:07:35 +0100 Subject: [PATCH] doc: add builtins --- doc/artio.txt | 104 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 103 insertions(+), 1 deletion(-) diff --git a/doc/artio.txt b/doc/artio.txt index dae542a..eb712e4 100644 --- a/doc/artio.txt +++ b/doc/artio.txt @@ -44,7 +44,7 @@ INSTALLATION ============================================================================== -CONFIGURATION *artio-config* +CONFIGURATION *artio-config* Options ~ @@ -131,4 +131,106 @@ Example ~ vim.keymap.set("n", "fo", "(artio-oldfiles)") < +============================================================================== + +API *artio-api* + +artio.resume() *artio-resume* + + resume the last closed picker. does not work across neovim + restarts/sessions. + + Plug: `(artio-resume)`. + +API-BUILTINS + +artio builtins are for general editor use. they are accessible through +`require('artio.builtins')`. + +builtins.builtins() *artio-builtins* + + list of all builtins. + + Plug: `(artio-builtins)`. + +builtins.files() *artio-files* + + list all files within the current directory. + + Plug: `(artio-files)`. + +builtins.grep() *artio-grep* + + grep in the current directory. + runs `rg` if available; uses `grep` as a fallback. + + Plug: `(artio-grep)`. + +builtins.oldfiles() *artio-oldfiles* + + list all files in |v:oldfiles|; recently accessed files in neovim. these are + stored in |shada| memory. + + Plug: `(artio-oldfiles)`. + +builtins.buffergrep() *artio-buffergrep* + + grep in the current buffer. uses the default sorter to match lines. + + Plug: `(artio-buffergrep)`. + +builtins.helptags() *artio-helptags* + + list all help tags. behaves like |:help|. + + Plug: `(artio-helptags)`. + +builtins.buffers() *artio-buffers* + + list all open buffers. behaves like |:buffers|. + + Plug: `(artio-buffers)`. + +builtins.smart() *artio-smart* + + uses the regular files picker as a base + - boosts items in the bufferlist + - proportionally boosts items that match closely to the current file in + proximity within the filesystem + + Plug: `(artio-smart)`. + +builtins.colorschemes() *artio-colorschemes* + + list all colorschemes by finding all `colors/*.{vim,lua}` files in the + runtime. + + Plug: `(artio-colorschemes)`. + +builtins.highlights() *artio-highlights* + + list all highlights. behaves like |:highlight|. + + Plug: `(artio-highlights)`. + +builtins.diagnostics({buffer}) *artio-diagnostics* + + list all diagnostics. uses diagnostics from |vim.diagnostic.get()|. + uses all diagnostics in the workspace if no buffer is specified. + + Plug: `(artio-diagnostics)`. + +builtins.diagnostics_buffer({buffer}) *artio-diagnostics-buffer* + + list all diagnostics for the given buffer. uses diagnostics from + |vim.diagnostic.get()|. uses the current buffer if no buffer is specified. + + Plug: `(artio-diagnostics-buffer)`. + +builtins.keymaps() *artio-keymaps* + + list all keymaps. uses formatted data from |nvim_get_keymap()|. + + Plug: `(artio-keymaps)`. + vim:tw=78:ts=8:noet:ft=help:norl: -- 2.51.2