diff options
| -rw-r--r-- | README.md | 11 | ||||
| -rw-r--r-- | doc/conform.txt | 8 | ||||
| -rw-r--r-- | lua/conform/init.lua | 2 |
3 files changed, 20 insertions, 1 deletions
@@ -15,6 +15,7 @@ Lightweight yet powerful formatter plugin for Neovim - [format(opts, callback)](#formatopts-callback) - [list_formatters(bufnr)](#list_formattersbufnr) - [list_all_formatters()](#list_all_formatters) + - [get_formatter_info(formatter, bufnr)](#get_formatter_infoformatter-bufnr) - [Acknowledgements](#acknowledgements) <!-- /TOC --> @@ -391,6 +392,16 @@ Retrieve the available formatters for a buffer `list_all_formatters(): conform.FormatterInfo[]` \ List information about all filetype-configured formatters + +### get_formatter_info(formatter, bufnr) + +`get_formatter_info(formatter, bufnr): conform.FormatterInfo` \ +Get information about a formatter (including availability) + +| Param | Type | Desc | +| --------- | -------------- | ---- | +| formatter | `string` | | +| bufnr | `nil\|integer` | | <!-- /API --> ## Acknowledgements diff --git a/doc/conform.txt b/doc/conform.txt index 46c971f..8a8d60b 100644 --- a/doc/conform.txt +++ b/doc/conform.txt @@ -121,6 +121,14 @@ list_formatters({bufnr}): conform.FormatterInfo[] *conform.list_formatter list_all_formatters(): conform.FormatterInfo[] *conform.list_all_formatters* List information about all filetype-configured formatters + +get_formatter_info({formatter}, {bufnr}): conform.FormatterInfo *conform.get_formatter_info* + Get information about a formatter (including availability) + + Parameters: + {formatter} `string` + {bufnr} `nil|integer` + -------------------------------------------------------------------------------- FORMATTERS *conform-formatters* diff --git a/lua/conform/init.lua b/lua/conform/init.lua index b0222e8..3b7c415 100644 --- a/lua/conform/init.lua +++ b/lua/conform/init.lua @@ -360,7 +360,7 @@ M.get_formatter_config = function(formatter, bufnr) return config end ----@private +---Get information about a formatter (including availability) ---@param formatter string ---@param bufnr? integer ---@return conform.FormatterInfo |