fix(health): don't show warning on module=false

folke · Dec 21, 2022 · c228908 · c228908
1 parent b68f94b
commit c228908
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -100,6 +100,7 @@ require("lazy").setup({
 | **cmd**          | `string?` or `string[]`       | Lazy-load on command                                                                                                                                                                          |
 | **ft**           | `string?` or `string[]`       | Lazy-load on filetype                                                                                                                                                                         |
 | **keys**         | `string?` or `string[]`       | Lazy-load on key mapping                                                                                                                                                                      |
+| **module**       | `false?`                      | Do not automatically load this lua module when it's required somewhere                                                                                                                        |
 
 ### Lazy Loading
 

diff --git a/lua/lazy/health.lua b/lua/lazy/health.lua
@@ -37,6 +37,7 @@ function M.check()
     "tag",
     "commit",
     "version",
+    "module",
     "pin",
     "cmd",
     "event",
@@ -48,7 +49,9 @@ function M.check()
   for _, plugin in pairs(Config.plugins) do
     for key in pairs(plugin) do
       if not vim.tbl_contains(valid, key) then
-        vim.health.report_warn("{" .. plugin.name .. "}: unknown key <" .. key .. ">")
+        if key ~= "module" or type(plugin.module) ~= "boolean" then
+          vim.health.report_warn("{" .. plugin.name .. "}: unknown key <" .. key .. ">")
+        end
       end
     end
   end