feat!: disable neoconf integration by default

Author: saecki

doc/crates.txt

@@ -242,6 +242,10 @@ For more information about individual config options see |crates-config|.
             enabled = false,
             name = "crates.nvim",
         },
+        neoconf = {
+            enabled = false,
+            namespace = "crates",
+        },
         lsp = {
             enabled = false,
             name = "crates.nvim",
@@ -1497,6 +1501,24 @@ null_ls.name                                      *crates-config-null_ls-name*
     The |null-ls.nvim| name.
 
 
+neoconf                                                *crates-config-neoconf*
+    Section type: `NeoconfConfig`
+
+    Configuration options for neoconf.nvim integration.
+
+
+neoconf.enabled                                *crates-config-neoconf-enabled*
+    Type: `boolean`, Default: `false`
+
+    Whether to enable project-local configuration with |neoconf.nvim|.
+
+
+neoconf.namespace                            *crates-config-neoconf-namespace*
+    Type: `string`, Default: `"crates"`
+
+    The root namespace for the project-local neoconf schema.
+
+
 lsp                                                        *crates-config-lsp*
     Section type: `LspConfig`
 

docgen/templates/documentation.md.in

@@ -290,11 +290,21 @@ How you might integrate `show_popup` into your `init.lua`.
 ```
 </details>
 
-## Neoconf Integration
+## neoconf.nvim integration
 
-You can also set project-local settings if you have [Neoconf](https://github.com/folke/neoconf.nvim)
-installed; all settings are exactly the same, but are under the "crates"
-namespace.
+You can also set project-local settings if you have [neoconf.nvim](https://github.com/folke/neoconf.nvim)
+installed; all settings are exactly the same, but are by default under the "crates" namespace.
+
+Neoconf integration has to be enabled, and optionally the namespace can be changed.
+```lua
+require("crates").setup {
+    ...
+    neoconf = {
+        enabled = false,
+        namespace = "crates",
+    },
+}
+```
 
 Example:
 

docgen/wiki/Documentation-unstable.md

@@ -399,6 +399,10 @@ require("crates").setup {
         enabled = false,
         name = "crates.nvim",
     },
+    neoconf = {
+        enabled = false,
+        namespace = "crates",
+    },
     lsp = {
         enabled = false,
         name = "crates.nvim",
@@ -669,11 +673,21 @@ endfunction
 ```
 </details>
 
-## Neoconf Integration
+## neoconf.nvim integration
+
+You can also set project-local settings if you have [neoconf.nvim](https://github.com/folke/neoconf.nvim)
+installed; all settings are exactly the same, but are by default under the "crates" namespace.
 
-You can also set project-local settings if you have [Neoconf](https://github.com/folke/neoconf.nvim)
-installed; all settings are exactly the same, but are under the "crates"
-namespace.
+Neoconf integration has to be enabled, and optionally the namespace can be changed.
+```lua
+require("crates").setup {
+    ...
+    neoconf = {
+        enabled = false,
+        namespace = "crates",
+    },
+}
+```
 
 Example:
 

lua/crates/config/init.lua

@@ -1566,6 +1566,34 @@ entry(schema_null_ls, {
     ]],
 })
 
+local schema_neoconf = section_entry(M.schema, {
+    name = "neoconf",
+    type = {
+        config_type = "section",
+        emmylua_annotation = "NeoconfConfig",
+    },
+    description = [[
+        Configuration options for neoconf.nvim integration.
+    ]],
+    fields = {},
+})
+entry(schema_neoconf, {
+    name = "enabled",
+    type = BOOLEAN_TYPE,
+    default = false,
+    description = [[
+        Whether to enable project-local configuration with |neoconf.nvim|.
+    ]],
+})
+entry(schema_neoconf, {
+    name = "namespace",
+    type = STRING_TYPE,
+    default = "crates",
+    description = [[
+        The root namespace for the project-local neoconf schema.
+    ]],
+})
+
 
 local schema_lsp = section_entry(M.schema, {
     name = "lsp",
@@ -1804,22 +1832,19 @@ end
 ---@param config Config
 ---@return Config
 local function setup_neoconf(config)
-    ---@type boolean, table
     local ok, neoconf = pcall(require, "neoconf")
     if not ok then
+        warn("neoconf.nvim was not found")
         return config
     end
 
     -- enables neodev to autocomplete settings in .neoconf.json
-    pcall(function()
-        ---@type table
-        local neoconf_plugins = require("neoconf.plugins")
-        neoconf_plugins.register {
-            on_schema = function(schema)
-                schema:import("crates", config)
-            end
-        }
-    end)
+    local neoconf_plugins = require("neoconf.plugins")
+    neoconf_plugins.register({
+        on_schema = function(schema)
+            schema:import(config.neoconf.namespace, config)
+        end
+    })
 
     return setmetatable({}, {
         __index = function(self, key)
@@ -1829,7 +1854,7 @@ local function setup_neoconf(config)
                 return loc[key]
             end
             ---@type Config
-            loc = neoconf.get("crates", config, {
+            loc = neoconf.get(config.neoconf.namespace, config, {
                 buffer = buf,
                 lsp = true,
             })
@@ -1883,7 +1908,11 @@ function M.build(user_config)
     handle_deprecated({}, M.schema, user_config, user_config)
     validate_schema({}, M.schema, user_config)
     local config = build_config(M.schema, user_config)
-    return setup_neoconf(config)
+    if config.neoconf.enabled then
+        return setup_neoconf(config)
+    else
+        return config
+    end
 end
 
 return M

lua/crates/config/types.lua

@@ -25,6 +25,7 @@
 ---@field popup PopupConfig
 ---@field completion CompletionConfig
 ---@field null_ls NullLsConfig
+---@field neoconf NeoconfConfig
 ---@field lsp LspConfig
 
 ---@class TextConfig
@@ -208,6 +209,10 @@
 ---@field enabled boolean
 ---@field name string
 
+---@class NeoconfConfig
+---@field enabled boolean
+---@field namespace string
+
 ---@class LspConfig
 ---@field enabled boolean
 ---@field name string
@@ -238,6 +243,7 @@
 ---@field public popup? crates.UserPopupConfig
 ---@field public completion? crates.UserCompletionConfig
 ---@field public null_ls? crates.UserNullLsConfig
+---@field public neoconf? crates.UserNeoconfConfig
 ---@field public lsp? crates.UserLspConfig
 
 ---@class crates.UserTextConfig
@@ -400,6 +406,10 @@
 ---@field public enabled? boolean
 ---@field public name? string
 
+---@class crates.UserNeoconfConfig
+---@field public enabled? boolean
+---@field public namespace? string
+
 ---@class crates.UserLspConfig
 ---@field public enabled? boolean
 ---@field public name? string