diff options
| author | Steven Arcangeli <stevearc@stevearc.com> | 2023-09-13 18:47:29 -0700 |
|---|---|---|
| committer | Steven Arcangeli <stevearc@stevearc.com> | 2023-09-13 18:47:29 -0700 |
| commit | e9cc79fd723afccb8c0c16342b913fa6e96879b0 (patch) | |
| tree | fafdba0e4dac6cc9f7c5aa149b06aaeca42abc52 /lua/conform | |
| parent | e18cdaf529b94465592d0c2afe1b62bc26155070 (diff) | |
doc: document the format options that are passed through to LSP formatting
Diffstat (limited to 'lua/conform')
| -rw-r--r-- | lua/conform/init.lua | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/lua/conform/init.lua b/lua/conform/init.lua index 3245020..378822f 100644 --- a/lua/conform/init.lua +++ b/lua/conform/init.lua @@ -258,6 +258,9 @@ end --- lsp_fallback nil|boolean|"always" Attempt LSP formatting if no formatters are available. Defaults to false. If "always", will attempt LSP formatting even if formatters are available (useful if you set formatters for the "*" filetype) --- quiet nil|boolean Don't show any notifications for warnings or failures. Defaults to false. --- range nil|table Range to format. Table must contain `start` and `end` keys with {row, col} tuples using (1,0) indexing. Defaults to current selection in visual mode +--- id nil|integer Passed to |vim.lsp.buf.format| when lsp_fallback = true +--- name nil|string Passed to |vim.lsp.buf.format| when lsp_fallback = true +--- filter nil|fun(client: table): boolean Passed to |vim.lsp.buf.format| when lsp_fallback = true ---@param callback? fun(err: nil|string) Called once formatting has completed ---@return boolean True if any formatters were attempted M.format = function(opts, callback) |