Skip to content

feat: add ability to cancel silencing of repeated errors #827

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathan-elize wants to merge 1 commit into
base: master
Choose a base branch
from
+17 −1
Open

feat: add ability to cancel silencing of repeated errors #827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,6 +598,8 @@ require("conform").setup({
log_level = vim.log.levels.ERROR,
-- Conform will notify you when a formatter errors
notify_on_error = true,
-- Conform will not repeat an error for a formatter if it errors successively
debounce_errors = true,
-- Conform will notify you when no formatters are available for the buffer
notify_no_formatters = true,
-- Custom formatters and overrides for built-in formatters
Expand Down Expand Up @@ -698,6 +700,7 @@ require("conform").formatters.my_formatter = {
| >format_after_save | `nil\|conform.FormatOpts\|fun(bufnr: integer): nil\|conform.FormatOpts` | , nil|fun(err: nil|string, did_edit: nil|boolean) If this is set, Conform will run the formatter asynchronously after save. It will pass the table to conform.format(). This can also be a function that returns the table (and an optional callback that is run after formatting). |
| >log_level | `nil\|integer` | Set the log level (e.g. `vim.log.levels.DEBUG`). Use `:ConformInfo` to see the location of the log file. |
| >notify_on_error | `nil\|boolean` | Conform will notify you when a formatter errors (default true). |
| >debounce_errors | `nil\|boolean` | Conform will not repeat an error for a formatter if it errors successively (default true). |
| >notify_no_formatters | `nil\|boolean` | Conform will notify you when no formatters are available for the buffer (default true). |
| >formatters | `nil\|table<string, conform.FormatterConfigOverride\|fun(bufnr: integer): nil\|conform.FormatterConfigOverride>` | Custom formatters and overrides for built-in formatters. |

Expand Down
4 changes: 4 additions & 0 deletions doc/conform.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ OPTIONS *conform-option
log_level = vim.log.levels.ERROR,
-- Conform will notify you when a formatter errors
notify_on_error = true,
-- Conform will not repeat an error for a formatter if it errors successively
debounce_errors = true,
-- Conform will notify you when no formatters are available for the buffer
notify_no_formatters = true,
-- Custom formatters and overrides for built-in formatters
Expand Down Expand Up @@ -162,6 +164,8 @@ setup({opts}) *conform.setu
the location of the log file.
{notify_on_error} `nil|boolean` Conform will notify you when a
formatter errors (default true).
{debounce_errors} `nil|boolean` Conform will silence errors when
successively sent from the same formatter (default true).
{notify_no_formatters} `nil|boolean` Conform will notify you when no
formatters are available for the buffer (default
true).
Expand Down
8 changes: 7 additions & 1 deletion lua/conform/init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ M.formatters_by_ft = {}
M.formatters = {}

M.notify_on_error = true
M.debounce_errors = true
M.notify_no_formatters = true

---@type conform.DefaultFormatOpts
Expand Down Expand Up @@ -82,6 +83,9 @@ M.setup = function(opts)
if opts.notify_on_error ~= nil then
M.notify_on_error = opts.notify_on_error
end
if opts.debounce_errors ~= nil then
M.debounce_errors = opts.debounce_errors
end
if opts.notify_no_formatters ~= nil then
M.notify_no_formatters = opts.notify_no_formatters
end
Expand Down Expand Up @@ -479,7 +483,9 @@ M.format = function(opts, callback)
-- Execution errors have special handling. Maybe should reconsider this.
local notify_msg = err.message
if errors.is_execution_error(err.code) then
should_notify = should_notify and M.notify_on_error and not err.debounce_message
should_notify = should_notify
and M.notify_on_error
and (not err.debounce_message or not M.debounce_errors)
notify_msg = "Formatter failed. See :ConformInfo for details"
end
if should_notify then
Expand Down
1 change: 1 addition & 0 deletions lua/conform/types.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,5 +114,6 @@
---@field format_after_save? conform.FormatOpts|fun(bufnr: integer): nil|conform.FormatOpts, nil|fun(err: nil|string, did_edit: nil|boolean) If this is set, Conform will run the formatter asynchronously after save. It will pass the table to conform.format(). This can also be a function that returns the table (and an optional callback that is run after formatting).
---@field log_level? integer Set the log level (e.g. `vim.log.levels.DEBUG`). Use `:ConformInfo` to see the location of the log file.
---@field notify_on_error? boolean Conform will notify you when a formatter errors (default true).
---@field debounce_errors? boolean Conform will not repeat an error for a formatter if it errors successively (default true).
---@field notify_no_formatters? boolean Conform will notify you when no formatters are available for the buffer (default true).
---@field formatters? table<string, conform.FormatterConfigOverride|fun(bufnr: integer): nil|conform.FormatterConfigOverride> Custom formatters and overrides for built-in formatters.
2 changes: 2 additions & 0 deletions scripts/options_doc.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ require("conform").setup({
log_level = vim.log.levels.ERROR,
-- Conform will notify you when a formatter errors
notify_on_error = true,
-- Conform will not repeat an error for a formatter if it errors successively
debounce_errors = true,
-- Conform will notify you when no formatters are available for the buffer
notify_no_formatters = true,
-- Custom formatters and overrides for built-in formatters
Expand Down