Add toggleFormatOnSave capability to conform

This commit is contained in:
Venkatesan Ravi 2025-03-31 21:01:51 +00:00
parent 80ac1cbc7b
commit c688311e37
2 changed files with 67 additions and 38 deletions

View file

@ -1,11 +1,9 @@
{
config,
lib,
...
}: let
{lib, ...}: let
inherit (lib.generators) mkLuaInline;
inherit (lib.options) mkOption mkEnableOption;
inherit (lib.types) attrs nullOr;
inherit (lib.nvim.types) mkPluginSetupOption;
inherit (lib.types) attrs either nullOr;
inherit (lib.nvim.lua) toLuaObject;
inherit (lib.nvim.types) luaInline mkPluginSetupOption;
in {
options.vim.formatter.conform-nvim = {
enable = mkEnableOption "lightweight yet powerful formatter plugin for Neovim [conform-nvim]";
@ -29,33 +27,68 @@ in {
description = "Default values when calling `conform.format()`";
};
format_on_save = mkOption {
type = nullOr attrs;
default =
if config.vim.lsp.formatOnSave
then {
lsp_format = "fallback";
timeout_ms = 500;
}
else null;
description = ''
Table that will be passed to `conform.format()`. If this
is set, Conform will run the formatter on save.
'';
};
format_on_save = let
defaultFormatOnSaveOpts = {
lsp_format = "fallback";
timeout_ms = 500;
};
in
mkOption {
type = nullOr (either attrs luaInline);
default =
mkLuaInline
# lua
''
function()
if (not vim.g.formatsave) or (vim.b.disableFormatSave) then
return
else
return ${toLuaObject defaultFormatOnSaveOpts}
end
end
'';
description = ''
Table or function(lualinline) that will be passed to `conform.format()`. If this
is set, Conform will run the formatter on save.
format_after_save = mkOption {
type = nullOr attrs;
default =
if config.vim.lsp.formatOnSave
then {lsp_format = "fallback";}
else null;
description = ''
Table that will be passed to `conform.format()`. If this
is set, Conform will run the formatter asynchronously after
save.
'';
};
Note:
- When config.vim.lsp.formatOnSave is set to true, internally
vim.g.formatsave is set to true.
- vim.b.disableFormatSave initally equals !config.vim.lsp.formatOnSave.
- vim.b.disableFormatSave is toggled using the
mapping from config.vim.lsp.mappings.toggleFormatOnSave.
'';
};
format_after_save = let
defaultFormatAfterSaveOpts = {lsp_format = "fallback";};
in
mkOption {
type = nullOr (either attrs luaInline);
default =
mkLuaInline
# lua
''
function()
if (not vim.g.formatsave) or (vim.b.disableFormatSave) then
return
else
return ${toLuaObject defaultFormatAfterSaveOpts}
end
end
'';
description = ''
Table or function(luainline) that will be passed to `conform.format()`. If this
is set, Conform will run the formatter asynchronously after save.
Note:
- When config.vim.lsp.formatOnSave is set to true, internally
vim.g.formatsave is set to true.
- vim.b.disableFormatSave initally equals !config.vim.lsp.formatOnSave.
- vim.b.disableFormatSave is toggled using the
mapping from config.vim.lsp.mappings.toggleFormatOnSave.
'';
};
};
};
}

View file

@ -93,11 +93,7 @@ in {
})
end
''
else "
vim.lsp.buf.format({
bufnr = bufnr,
})
"
else ""
}
end,
})