Ability to split config into multiple files

[vunhatchuong]

So a common pattern I use when lazy.nvim and other plugins is to split the config into multiple files and lazy.nvim will merge it before calling setup.

For example in general.lua:

{
    "nvim-treesitter/nvim-treesitter",
    opts = {
        ensure_installed = {
            "bash",
            "vimdoc",
            "diff",
            "html",
            "http",
            "gitignore",
        }}
}

And then in go.lua:

{
    "nvim-treesitter/nvim-treesitter",
    opts = function(_, opts)
        vim.list_extend(opts.ensure_installed, {
            "go",
            "gomod",
            "gowork",
            "gosum",
            "templ",
        })
    end,
}

How do I achieve the same thing in guard.nvim? I tried to make a _G.guard_filetypes = {} and append it in each fine but it doesn't work.

[xiaoshihou514]

Hi.
I am working on this in #158 (it would take a while for it to be merged into this repo but the code and docs are already baked). The idea is that one separates their config with ftplugins. You could check it out at my fork. Please tell me how you feel about the new interface!

[vunhatchuong]

I've never used ftplugin before so this is my fault but now I have 3 go.lua files, which is also fine it's just a bit annoying when using Telescope to search for them.

Other than that the setup works great, the only thing is modifying vim.g.guard_config doesn't work at all.

plugins.formatting

return {
    "xiaoshihou514/guard.nvim",
    dependencies = {
        "nvimdev/guard-collection",
    },
    keys = {
        {
            "<leader>ff",
            "<CMD>Guard fmt<CR>",
            mode = { "n", "v" },
            desc = "Format buffer",
        },
    },
    config = function()
        vim.g.guard_config = {
            fmt_on_save = false,
            save_on_fmt = false,
        }
        local ft = require("guard.filetype")
        ft("*"):lint("codespell")
    end,
}

ftplugin/go.lua

local ft = require("guard.filetype")
ft("go"):fmt("lsp"):append("golines")

---

And also everytime I save it will format (which is expected since my config doesn't work).

But it will print out an error:

• In a .lua it's [Guard]: buffer changed during formatting.
• For .go it's [Guard]: buffer changed and the formatting behaves weirdly: I indented a line so that I can try out the formatter but then after formatting the indented line disappears completely.

These warning doesn't appear if I use Guard fmt.

[xiaoshihou514]

Thanks for the feedback! I will add some more testing regarding these options. It's a bit of a wip, so stay tuned!

[xiaoshihou514]

@vunhatchuong I think I've fixed the settings, would you mind trying the latest commit on my branch?

[vunhatchuong]

Yep looks like everything works flawlessly, appreciate your hard work!

[vunhatchuong]

@xiaoshihou514 Oh btw I didn't test thoroughly yesterday, I think there are some weird behaviors when save_on_fmt = false.

[vunhatchuong]

I think when setting save_on_fmt = false, lsp formatter in my ft("lua"):fmt("lsp"):append("stylua") doesn't work.

[xiaoshihou514]

I will look into that this afternoon :)

[xiaoshihou514]

@vunhatchuong I think it should be ready now!

[vunhatchuong]

Yep looks like it's fixed, I have a question:

Why does it show I have 2 formatters attached when I only have stylua, and also when I attach lsp it doesn't show up as a formatter

This is my config:

config = function()
    vim.g.guard_config = {
        fmt_on_save = false,
        save_on_fmt = false,
    }
    local ft = require("guard.filetype")
    ft("lua"):fmt("stylua")
end,

Guard info:

Settings:
fmt_on_save: false
lsp_as_default_formatter: false
save_on_fmt: false
Current buffer has filetype lua:
formatters:
{{
    fn = <function 1>
    },{ 
  args = { "-" },
  cmd = "stylua",
  cwd = "D:/.dotfiles/nvim",
  stdin = true
}}
nil
2 formatter autocmds attached
1 linter autocmds attached 

[xiaoshihou514]

Why does it show I have 2 formatters attached when I only have stylua

Lsp format also counts as a formatter, don't you think?

and also when I attach lsp it doesn't show up as a formatter

It did, it's the fn one.

Not sure why you have 2 autocmds tho, I will push a patch to check existing autocmds.

[vunhatchuong]

Oh, the reason I was confused is because I think when I open a new buffer the LSP formatter auto attaches:

nvim :message output:

# :Guard fmt
[Guard]: missing config for filetype lua
# :Guard info
Error executing Lua callback:  
.../nvim-data/lazy/guard.nvim/plugin/guard.lua:43: attempt to index local 'ft' (a nil value)
stack traceback:  
.../nvim-data/lazy/guard.nvim/plugin/guard.lua:43: in function 'f'
.../nvim-data/lazy/guard.nvim/plugin/guard.lua:65: in function <.../nvim-data/lazy/guard.nvim/plugin/guard.lua:63>

# Switch to another file using telescope
# :Guard fmt
    # (return nothing)
# :Guard info
Settings:  
fmt_on_save: false  
lsp_as_default_formatter: false  
save_on_fmt: false  

Current buffer has filetype lua:  
formatters:  
{ 
  { 
    fn = <function 1> 
  } 
}
nil
2 formatter autocmds attached  
1 linter autocmd attached

So there are 2 things:

• I don't think :Guard info should return an error when no ft is available.
• Opening a new buffer makes LSP formatter auto-attach.

[xiaoshihou514]

• I don't think :Guard info should return an error when no ft is available.

Oops, You are absolutely correct!

• Opening a new buffer makes LSP formatter auto-attach.

I assume you mean setting lsp_as_default_formatter to false doesn't work?