Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bug: checkhealth warns when plugin configuration uses key 'submodules' #1174

Closed
3 tasks done
gongfarmer opened this issue Nov 9, 2023 · 0 comments · Fixed by #1284
Closed
3 tasks done

bug: checkhealth warns when plugin configuration uses key 'submodules' #1174

gongfarmer opened this issue Nov 9, 2023 · 0 comments · Fixed by #1284
Labels
bug Something isn't working

Comments

@gongfarmer
Copy link
Contributor

Did you check docs and existing issues?

  • I have read all the lazy.nvim docs
  • I have searched the existing issues of lazy.nvim
  • I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

v0.10.0-dev-43b0e27

Operating system/version

linux, debian 11

Describe the bug

The lazy.nvim configuration docs include the key 'submodules', but the health check flags this key as invalid and warns about its usage.

Also, I diffed the list of configuration keys in the docs against the valid keys list in lua/lazy/health.lua and found 2 keys that are allowed by health check but undocumented;
These are: deactivate, import. I don't know if this is considered a bug, just FYI.

Steps To Reproduce

  1. Configure a plugin with the submodule key:
  {
    'stevearc/aerial.nvim',
    submodules = false, -- can't reach github urls behind corporate firewall
    config = true
  },
  1. Run nvim, and :checkhealth lazy

Expected Behavior

Expected: no errors from :checkhealth lazy

Actual:

lazy: require("lazy.health").check()
lazy.nvim
- OK Git installed
- OK no existing packages found by other package managers
- OK packer_compiled.lua not found
- WARNING {aerial.nvim}: unknown key <submodules>

Repro

local lazypath = vim.fn.stdpath 'data' .. '/lazy/lazy.nvim'
vim.opt.rtp:prepend(lazypath)
require('lazy').setup {
  {
    'stevearc/aerial.nvim',
    submodules = false, -- can't reach github urls behind corporate firewall
  },
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
1 participant