aboutsummaryrefslogtreecommitdiffstats
path: root/doc/conform.txt
diff options
context:
space:
mode:
authorSteven Arcangeli <506791+stevearc@users.noreply.github.com>2023-09-17 10:02:10 -0700
committerGitHub <noreply@github.com>2023-09-17 10:02:10 -0700
commit1abbb82bb8e519e652d8b31b12a311872e9090d1 (patch)
treee4b612223d04d357ce5b61f8380d76ac7729b5e1 /doc/conform.txt
parent6d74e6c70b13a39384996268deaf4140443d6121 (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 'doc/conform.txt')
-rw-r--r--doc/conform.txt13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/conform.txt b/doc/conform.txt
index bb3d90d..76b0714 100644
--- a/doc/conform.txt
+++ b/doc/conform.txt
@@ -21,12 +21,9 @@ OPTIONS *conform-option
-- 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.
@@ -149,6 +146,12 @@ get_formatter_info({formatter}, {bufnr}): conform.FormatterInfo *conform.get_for
{formatter} `string` The name of the formatter
{bufnr} `nil|integer`
+will_fallback_lsp({options}): boolean *conform.will_fallback_lsp*
+ Check if the buffer will use LSP formatting when lsp_fallback = true
+
+ Parameters:
+ {options} `nil|table` Options passed to |vim.lsp.buf.format|
+
--------------------------------------------------------------------------------
FORMATTERS *conform-formatters*