diff options
| author | Steven Arcangeli <506791+stevearc@users.noreply.github.com> | 2023-09-17 10:02:10 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-17 10:02:10 -0700 |
| commit | 1abbb82bb8e519e652d8b31b12a311872e9090d1 (patch) | |
| tree | e4b612223d04d357ce5b61f8380d76ac7729b5e1 /README.md | |
| parent | 6d74e6c70b13a39384996268deaf4140443d6121 (diff) | |
feat: make lsp_fallback behavior more intuitive (#59)
When lsp_fallback = true AND the only formatters for the buffer are from
the "*" or "_" filetype, format with LSP instead of the "*"/"_"
formatters.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 12 insertions, 5 deletions
@@ -16,6 +16,7 @@ Lightweight yet powerful formatter plugin for Neovim - [list_formatters(bufnr)](#list_formattersbufnr) - [list_all_formatters()](#list_all_formatters) - [get_formatter_info(formatter, bufnr)](#get_formatter_infoformatter-bufnr) + - [will_fallback_lsp(options)](#will_fallback_lspoptions) - [Acknowledgements](#acknowledgements) <!-- /TOC --> @@ -241,12 +242,9 @@ require("conform").setup({ -- Use a sub-list to run only the first available formatter javascript = { { "prettierd", "prettier" } }, -- Use the "*" filetype to run formatters on all filetypes. - -- Note that if you use this, you may want to set lsp_fallback = "always" - -- (see :help conform.format) ["*"] = { "codespell" }, - -- Use the "_" filetype to run formatters on all filetypes - -- that don't have other formatters configured. Again, you may want to - -- set lsp_fallback = "always" when using this value. + -- Use the "_" filetype to run formatters on filetypes that don't + -- have other formatters configured. ["_"] = { "trim_whitespace" }, }, -- If this is set, Conform will run the formatter on save. @@ -384,6 +382,15 @@ Get information about a formatter (including availability) | --------- | -------------- | ------------------------- | | formatter | `string` | The name of the formatter | | bufnr | `nil\|integer` | | + +### will_fallback_lsp(options) + +`will_fallback_lsp(options): boolean` \ +Check if the buffer will use LSP formatting when lsp_fallback = true + +| Param | Type | Desc | +| ------- | ------------ | ------------------------------------ | +| options | `nil\|table` | Options passed to vim.lsp.buf.format | <!-- /API --> ## Acknowledgements |