feat!: deprecate the nvim-cmp, coq_nvim, and null-ls sources

Author: saecki

doc/crates.txt

@@ -734,9 +734,6 @@ text.error                                          *crates-config-text-error*
     Format string used when there was an error loading crate information.
 
 
-open_programs                                    *crates-config-open_programs*
-    DEPRECATED: `vim.ui.open()` is used instead
-
 highlight                                            *crates-config-highlight*
     Section type: `HighlightConfig`
 
@@ -1414,6 +1411,7 @@ completion.cmp                                  *crates-config-completion-cmp*
 
 
 completion.cmp.enabled                  *crates-config-completion-cmp-enabled*
+    DEPRECATED: The nvim-cmp source will be removed soon. Use the in-process language server instead.
     Type: `boolean`, Default: `false`
 
     Whether to load and register the |nvim-cmp| source.
@@ -1478,6 +1476,7 @@ completion.coq                                  *crates-config-completion-coq*
 
 
 completion.coq.enabled                  *crates-config-completion-coq-enabled*
+    DEPRECATED: The coq_nvim source will be removed soon. Use the in-process language server instead.
     Type: `boolean`, Default: `false`
 
     Whether to load and register the |coq_nvim| source.
@@ -1590,21 +1589,26 @@ completion.crates.max_results    *crates-config-completion-crates-max_results*
 
 
 src                                                        *crates-config-src*
-    DEPRECATED: please use |crates-config-completion| instead.
+    DEPRECATED: This will be ignored.
+    Please use |crates-config-completion| instead.
+    Type: `boolean`, Default: `nil`
 
 null_ls                                                *crates-config-null_ls*
+    DEPRECATED: The null-ls source will be removed soon. Use the in-process language server instead.
     Section type: `NullLsConfig`
 
     Configuration options for null-ls.nvim actions.
 
 
 null_ls.enabled                                *crates-config-null_ls-enabled*
+    DEPRECATED: The null-ls source will be removed soon. Use the in-process language server instead.
     Type: `boolean`, Default: `false`
 
     Whether to register the |null-ls.nvim| source.
 
 
 null_ls.name                                      *crates-config-null_ls-name*
+    DEPRECATED: The null-ls source will be removed soon. Use the in-process language server instead.
     Type: `string`, Default: `"crates.nvim"`
 
     The |null-ls.nvim| name.

docgen/gen_doc.lua

@@ -284,7 +284,8 @@ end
 ---@param lines string[]
 ---@param path string[]
 ---@param schema SchemaElement[]
-local function gen_vimdoc_config(lines, path, schema)
+---@param parent_deprecated Deprecated?
+local function gen_vimdoc_config(lines, path, schema, parent_deprecated)
     for _, s in ipairs(schema) do
         if s.hidden then
             goto continue
@@ -302,34 +303,39 @@ local function gen_vimdoc_config(lines, path, schema)
             table.insert(lines, key)
         end
 
-        if s.deprecated then
-            if s.deprecated.new_field then
-                local nf = "crates-config-" .. table.concat(s.deprecated.new_field, "-")
-                table.insert(lines, string.format("    DEPRECATED: please use |%s| instead.", nf))
-            elseif s.deprecated.msg then
-                table.insert(lines, "    DEPRECATED: " .. s.deprecated.msg)
-            elseif s.deprecated.hard then
-                table.insert(lines, "    DEPRECATED: ignored")
-            end
-            table.insert(lines, "")
-        else
-            if s.type.config_type == "section" then
-                table.insert(lines, string.format("    Section type: `%s`", s.type.emmylua_annotation))
-                table.insert(lines, "")
+        local deprecated = s.deprecated or parent_deprecated
+        if deprecated then
+            if deprecated.msg then
+                local msg = string.sub(deprecated.msg, 1, 1):upper() .. string.sub(deprecated.msg, 2)
+                table.insert(lines, "    DEPRECATED: " .. msg)
+            elseif not deprecated.hard then
+                table.insert(lines, "    DEPRECATED: This will stop working soon.")
             else
-                local t = s.type.emmylua_annotation
-                local d = s.default_text or vim.inspect(s.default)
-                table.insert(lines, string.format("    Type: `%s`, Default: `%s`", t, d))
-                table.insert(lines, "")
+                table.insert(lines, "    DEPRECATED: This will be ignored.")
             end
+            if deprecated.new_field then
+                local nf = "crates-config-" .. table.concat(deprecated.new_field, "-")
+                table.insert(lines, string.format("    Please use |%s| instead.", nf))
+            end
+        end
+
+        if s.type.config_type == "section" then
+            table.insert(lines, string.format("    Section type: `%s`", s.type.emmylua_annotation))
+        else
+            local t = s.type.emmylua_annotation
+            local d = s.default_text or vim.inspect(s.default)
+            table.insert(lines, string.format("    Type: `%s`, Default: `%s`", t, d))
+        end
+        table.insert(lines, "")
 
+        if s.description then
             local description = s.description:gsub("^    ", ""):gsub("\n    ", "\n")
             table.insert(lines, description)
             table.insert(lines, "")
         end
 
         if s.type.config_type == "section" then
-            gen_vimdoc_config(lines, p, s.fields)
+            gen_vimdoc_config(lines, p, s.fields, deprecated)
         end
 
         ::continue::
@@ -348,7 +354,7 @@ local function gen_def_config(lines, indent, path, schema)
     end
 
     for _, s in ipairs(schema) do
-        if not s.hidden and not s.deprecated then
+        if not s.hidden and not (s.deprecated and (s.deprecated.hard or s.deprecated.new_field)) then
             local name = s.name
 
             if s.type.config_type == "section" then
@@ -396,7 +402,7 @@ local function gen_vim_doc()
             elseif ph == "SUBCOMMANDS" then
                 gen_vimdoc_subcommands(lines)
             elseif ph == "CONFIGURATION" then
-                gen_vimdoc_config(lines, {}, config.schema)
+                gen_vimdoc_config(lines, {}, config.schema, nil)
             elseif ph == "HIGHLIGHTS" then
                 gen_vimdoc_highlights(lines)
             else

lua/crates/config/init.lua

@@ -335,15 +335,6 @@ entry(schema_text, {
         Format string used when there was an error loading crate information.
     ]],
 })
--- DEPRECATED
-entry(M.schema, {
-    name = "open_programs",
-    type = STRING_ARRAY_TYPE,
-    deprecated = {
-        msg = "`vim.ui.open()` is used instead",
-        hard = true,
-    },
-})
 
 
 local schema_hl = section_entry(M.schema, {
@@ -1418,6 +1409,9 @@ entry(schema_completion_cmp, {
             require("crates.completion.cmp").setup()
         <
     ]],
+    deprecated = {
+        msg = "the nvim-cmp source will be removed soon. Use the in-process language server instead.",
+    },
 })
 entry(schema_completion_cmp, {
     name = "use_custom_kind",
@@ -1502,6 +1496,9 @@ entry(schema_completion_coq, {
     description = [[
         Whether to load and register the |coq_nvim| source.
     ]],
+    deprecated = {
+        msg = "the coq_nvim source will be removed soon. Use the in-process language server instead.",
+    },
 })
 entry(schema_completion_coq, {
     name = "name",
@@ -1653,12 +1650,13 @@ entry(schema_completion_crates, {
         complete a crate name.
     ]],
 })
--- deprecated
+-- DEPRECATED
 entry(M.schema, {
     name = "src",
     type = BOOLEAN_TYPE,
     deprecated = {
         new_field = { "completion" },
+        hard = true,
     }
 })
 
@@ -1673,6 +1671,9 @@ local schema_null_ls = section_entry(M.schema, {
         Configuration options for null-ls.nvim actions.
     ]],
     fields = {},
+    deprecated = {
+        msg = "the null-ls source will be removed soon. Use the in-process language server instead.",
+    },
 })
 entry(schema_null_ls, {
     name = "enabled",

scripts/gen_types.lua

@@ -16,7 +16,8 @@ local function gen_config_types(lines, schema, type_name, user)
     ---@param s SchemaElement
     ---@return boolean
     local function skip(s)
-        return s.deprecated ~= nil or s.hidden and user
+        return s.deprecated ~= nil and (s.deprecated.hard or s.deprecated.new_field)
+            or s.hidden and user
     end
 
     for _, s in ipairs(schema) do