diff options
author | Steven Arcangeli <stevearc@stevearc.com> | 2023-08-27 20:15:18 -0700 |
---|---|---|
committer | Steven Arcangeli <stevearc@stevearc.com> | 2023-08-27 20:27:48 -0700 |
commit | 73f5c199e525cfcb5939971f745d90068b2eb6f2 (patch) | |
tree | b366e4d02f6b80652e2587b09d0cabad9af92965 /lua/conform/init.lua | |
parent | 5bc69d500a14fb06bf8f36005f76a7825be25931 (diff) |
doc: flesh out config options documentation
Diffstat (limited to 'lua/conform/init.lua')
-rw-r--r-- | lua/conform/init.lua | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/lua/conform/init.lua b/lua/conform/init.lua index 5b8bd5b..c81cf82 100644 --- a/lua/conform/init.lua +++ b/lua/conform/init.lua @@ -7,8 +7,7 @@ local M = {} ---@field available boolean ---@field available_msg? string ----@class (exact) conform.FormatterConfig ----@field meta conform.FormatterMeta +---@class (exact) conform.StaticFormatterConfig ---@field command string|fun(ctx: conform.Context): string ---@field args? string[]|fun(ctx: conform.Context): string[] ---@field cwd? fun(ctx: conform.Context): nil|string @@ -17,6 +16,9 @@ local M = {} ---@field condition? fun(ctx: conform.Context): boolean ---@field exit_codes? integer[] Exit codes that indicate success (default {0}) +---@class (exact) conform.FormatterConfig : conform.StaticFormatterConfig +---@field meta conform.FormatterMeta + ---@class (exact) conform.FormatterMeta ---@field url string ---@field description string @@ -36,7 +38,7 @@ local M = {} ---@type table<string, string[]|conform.FormatterList> M.formatters_by_ft = {} ----@type table<string, conform.FormatterConfig|fun(): conform.FormatterConfig> +---@type table<string, conform.StaticFormatterConfig|fun(): conform.StaticFormatterConfig> M.formatters = {} M.setup = function(opts) |