feat(health): Warn about unused keys when normalizing a LazySpec[] #1299
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.
Occasionally, users may put the configuration keys for a plugin into a
LazySpec[]
, rather than a specificLazySpec
. Alternatively, they may add a newLazySpec|string
into an existingLazySpec
for a plugin. This leads to some configuration keys being silently ignored bylazy.nvim
after normalization, which can be confusing to newlazy.nvim
users.This PR adds a health check to
Spec:normalize()
which will warn about the misplaced keys.Example of a
LazySpec[]
that will trigger this:The resulting healthcheck warning with this PR (
:Lazy health
):This is how a longer warning looks like:
Concerns:
vim.inspect
). For reference, spec processing takes ~5ms for me without this warning.