diff options
| author | Steven Arcangeli <stevearc@stevearc.com> | 2024-06-17 22:14:21 -0400 |
|---|---|---|
| committer | Steven Arcangeli <stevearc@stevearc.com> | 2024-06-17 22:14:21 -0400 |
| commit | 0d12c3781384d63909431297ed1a0f383008bb8f (patch) | |
| tree | 1c4537f151f2fd7a5ca40d95fe0cc8c10f9f5c4e /lua/conform | |
| parent | 9228b2ff4efd58b6e081defec643bf887ebadff6 (diff) | |
doc: format_on_save/format_after_save can return nil
Diffstat (limited to 'lua/conform')
| -rw-r--r-- | lua/conform/types.lua | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lua/conform/types.lua b/lua/conform/types.lua index f68c2de..b00c3f0 100644 --- a/lua/conform/types.lua +++ b/lua/conform/types.lua @@ -62,8 +62,8 @@ ---@class (exact) conform.setupOpts ---@field formatters_by_ft? table<string, conform.FiletypeFormatter> Map of filetype to formatters ----@field format_on_save? conform.FormatOpts|fun(bufnr: integer): conform.FormatOpts If this is set, Conform will run the formatter on save. It will pass the table to conform.format(). This can also be a function that returns the table. ----@field format_after_save? conform.FormatOpts|fun(bufnr: integer): conform.FormatOpts 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. +---@field format_on_save? conform.FormatOpts|fun(bufnr: integer): nil|conform.FormatOpts If this is set, Conform will run the formatter on save. It will pass the table to conform.format(). This can also be a function that returns the table. +---@field format_after_save? conform.FormatOpts|fun(bufnr: integer): nil|conform.FormatOpts 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. ---@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 formatters? table<string, conform.FormatterConfigOverride|fun(bufnr: integer): nil|conform.FormatterConfigOverride> Custom formatters and overrides for built-in formatters. |