diff options
| author | Steven Arcangeli <506791+stevearc@users.noreply.github.com> | 2023-09-08 11:57:05 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-08 11:57:05 -0700 |
| commit | a72f0fe173ea1506cf0d2bf97007876cb07f3ae4 (patch) | |
| tree | 2ce7ba9fb405a42e0d7138cf32d2fde69b703eed /doc | |
| parent | 1bd3c1bffc6b5cdba83264f3be5bb1d282c13707 (diff) | |
| parent | 2178a4fe3f16ef4780cc0a6bc45da07cd0f92798 (diff) | |
Merge pull request #33 from stevearc/stevearc-refactor
New config syntax for "run first" vs "run all"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conform.txt | 33 |
1 files changed, 21 insertions, 12 deletions
diff --git a/doc/conform.txt b/doc/conform.txt index 46c971f..149db88 100644 --- a/doc/conform.txt +++ b/doc/conform.txt @@ -16,16 +16,14 @@ OPTIONS *conform-option -- Map of filetype to formatters formatters_by_ft = { lua = { "stylua" }, - -- Conform will use the first available formatter in the list - javascript = { "prettierd", "prettier" }, - -- Formatters can also be specified with additional options - python = { - formatters = { "isort", "black" }, - -- Run formatters one after another instead of stopping at the first success - run_all_formatters = true, - -- Don't run these formatters as part of the format_on_save autocmd (see below) - format_on_save = false, - }, + -- Conform will run multiple formatters sequentially + python = { "isort", "black" }, + -- Use a sub-list to run only the first available formatter + javascript = { { "prettierd", "prettier" } }, + -- Use the "*" filetype to run formatters on all files. + -- Note that if you use this, you may want to set lsp_fallback = "always" + -- (see :help conform.format) + ["*"] = { "trim_whitespace" }, }, -- If this is set, Conform will run the formatter on save. -- It will pass the table to conform.format(). @@ -101,8 +99,11 @@ format({opts}, {callback}): boolean *conform.forma to false. {formatters} `nil|string[]` List of formatters to run. Defaults to all formatters for the buffer filetype. - {lsp_fallback} `nil|boolean` Attempt LSP formatting if no formatters - are available. Defaults to false. + {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` @@ -121,6 +122,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` The name of the formatter + {bufnr} `nil|integer` + -------------------------------------------------------------------------------- FORMATTERS *conform-formatters* |