feat: add setup field to rocks.toml

nvim-neorocks / rocks-config.nvim

Allow rocks.nvim to help configure your plugins.

GNU General Public License v3.0

55 stars 2 forks source link

feat: add setup field to rocks.toml #41

Closed bottd closed 3 weeks ago

bottd commented 2 months ago

This adds the ability to opt out of auto_setup for specific plugins. I took the name from #9 but added underscore so it matches auto_setup field. I added some text to the README to mention it, but I feel like it could use some more documentation/a better example plugin to call no_setup on. Excited to hear your thoughts!

I also looked to see if I need to declare the type or shape of options provided by rocks-config.nvim and did not find it. If this is something that needs to be done somewhere I am happy to add it.

github-actions[bot] commented 2 months ago

Review Checklist

Does this PR follow the Contribution Guidelines? Following is a partial checklist:

Proper conventional commit scoping:

For example, fix(installer): some installer bugfix
[ ] Pull request title has the appropriate conventional commit prefix.

If applicable:

[ ] Tested
- [ ] Tests have been added.
- [ ] Tested manually (steps in PR description).
[ ] Updated documentation.

bottd commented 2 months ago

Hi @mrcjkb I updated this now, this implementation uses a field named setup. Note a breaking change here is moving config = "path.to.config" to be under the setup field, resulting in config being for tables only. Due to this change being breaking I am ok with pulling it out and making this work with either field being a string. In the long term I think it would be best for only one of these fields to point to a module path.

I also included a warning for the invalid config you pointed out, where setup = false and config has been set.

mrcjkb commented 3 weeks ago

Closing in favour of #66.

Thanks for the PR :pray: