diff options
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/api.txt | 4 | ||||
| -rw-r--r-- | runtime/doc/lua.txt | 22 | ||||
| -rw-r--r-- | runtime/doc/news.txt | 3 |
3 files changed, 27 insertions, 2 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 04825381ff..289788f036 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -1971,8 +1971,8 @@ nvim_get_option_value({name}, {*opts}) *nvim_get_option_value()* Implies {scope} is "local". • filetype: |filetype|. Used to get the default option for a specific filetype. Cannot be used with any other option. - Note: this is expensive, it is recommended to cache this - value. + Note: this will trigger |ftplugin| and all |FileType| + autocommands for the corresponding filetype. Return: ~ Option value diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 611f2e0d32..e7dcc79f4a 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -2206,6 +2206,28 @@ add({filetypes}) *vim.filetype.add()* • {filetypes} (table) A table containing new filetype maps (see example). +get_option({filetype}, {option}) *vim.filetype.get_option()* + Get the default option value for a {filetype}. + + The returned value is what would be set in a new buffer after 'filetype' + is set, meaning it should respect all FileType autocmds and ftplugin + files. + + Example: >lua + vim.filetype.get_option('vim', 'commentstring') +< + + Note: this uses |nvim_get_option_value()| but caches the result. This + means |ftplugin| and |FileType| autocommands are only triggered once and + may not reflect later changes. + + Parameters: ~ + • {filetype} string Filetype + • {option} string Option name + + Return: ~ + string|boolean|integer: Option value + match({args}) *vim.filetype.match()* Perform filetype detection. diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index b7d5694802..5ac6db6f84 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -213,6 +213,9 @@ The following new APIs or features were added. • |nvim_get_option_value()| now has a `filetype` option so it can return the default option for a specific filetype. +• |vim.filetype.get_option()| to get the default option value for a specific + filetype. This is a wrapper around |nvim_get_option_value()| with caching. + ============================================================================== CHANGED FEATURES *news-changes* |