feat(nvim-lint): make autocmd events configurable

[nicholasxjy]

📑 Description

make nvim-lint autocmd events("BufWritePost", "BufReadPost", "InsertLeave", "TextChanged" now) can be configured from opts.events

ℹ Additional Information

[github-actions]

Review Checklist

Does this PR follow the [Contribution Guidelines](development guidelines)? Following is a partial checklist:

Proper conventional commit scoping:

• If you are adding a new plugin, the scope would be the name of the category it is being added into. ex. feat(utility): added noice.nvim plugin

• If you are modifying a pre-existing plugin or pack, the scope would be the name of the plugin folder. ex. fix(noice-nvim): fix LSP handler error

• Pull request title has the appropriate conventional commit type and scope where the scope is the name of the pre-existing directory in the project as described above

• README is properly formatted and uses fenced in links with <url> unless they are inside a [title](url)

• Entry returns a single plugin spec with the new plugin as the only top level spec (not applicable for recipes or packs).

• Proper usage of opts table rather than setting things up with the config function.

• Proper usage of specs table for all specs that are not dependencies of a given plugin (not applicable for recipes or packs).

[Uzaaft]

opts.events doesnt seem to be a valid field for the options that should be passed to this plugin. Not sure if we should add it, so I defer to another maintainer. But this would open the floodgates in terms scope for astrocommunity.
Also, the current plugin spec should be updated to use astrocore.

[mehalter]

Yeah we should avoid trying to modify the opts. I think what this should be doing is using the AstroCore autocommand creation feature which would make it configurable to the user

[mehalter]

Ah, I see why this is being done the way it is. Let me see if there is a good way to set this up without being annoying. Main thing is we really want to stay away from modifying the opts because if the plugin gets an update that changes their opts it could completely override this or break things

[mehalter]

Took a stab at this, still testing so not ready for merge

[mehalter]

Okay, tested and it looks good to go! Here is how the user would configure the autocommand events:

return {
  "AstroNvim/astrocore",
  opts = function(_, opts)
    -- customize the autocommand events for nvim-lint
    opts.autocmds.auto_lint[1].event = { "BufWritePost" }
  end
}

[mehalter]

Thanks for this! It is a great idea to make this configurable