feat!: Rewrite user configuration. #296
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE
This commit will deprecate the existing
setup
andbuffer_setup
function calls, in line with this blog post. I believe that plugins, by default, should merely expose functionality but not actively modify user configuration at all. The goal is to have the installation script in the README contain the current "default" configuration, and any changes can be made by users directly. While this results in more code for the end user, I think that the reduced complexity and layers of abstraction will ultimately help users better understand the plugin and have more control for how it behaves.The changes will be:
setup(...)
→vim.g.nvim_surround
buffer_setup(...)
→vim.b.nvim_surround