Merge #28227 feat(diagnostic): is_enabled, enable(…, enable:boolean)

runtime/doc/deprecated.txt

@@ -80,12 +80,15 @@ HIGHLIGHTS
 - *hl-VertSplit*	Use |hl-WinSeparator| instead.
 
 LSP DIAGNOSTICS
+- *vim.diagnostic.disable()*		Use |vim.diagnostic.enable()|
+- *vim.diagnostic.is_disabled()*	Use |vim.diagnostic.is_enabled()|
+
 For each of the functions below, use the corresponding function in
 |vim.diagnostic| instead (unless otherwise noted). For example, use
 |vim.diagnostic.get()| instead of |vim.lsp.diagnostic.get()|.
 
 - *vim.lsp.diagnostic.clear()*		Use |vim.diagnostic.hide()| instead.
-- *vim.lsp.diagnostic.disable()*
+- *vim.lsp.diagnostic.disable()*          Use |vim.diagnostic.enable()| instead.
 - *vim.lsp.diagnostic.display()*	Use |vim.diagnostic.show()| instead.
 - *vim.lsp.diagnostic.enable()*
 - *vim.lsp.diagnostic.get()*

runtime/doc/develop.txt

@@ -372,20 +372,25 @@ Use existing common {verb} names (actions) if possible:
     - create:       Creates a new (non-trivial) thing (TODO: rename to "def"?)
     - del:          Deletes a thing (or group of things)
     - detach:       Dispose attached listener (TODO: rename to "un"?)
+    - enable:       Enables/disables functionality.
     - eval:         Evaluates an expression
     - exec:         Executes code
     - fmt:          Formats
     - get:          Gets things (often by a query)
     - inspect:      Presents a high-level, often interactive, view
+    - is_enabled:   Checks if functionality is enabled.
     - open:         Opens something (a buffer, window, …)
     - parse:        Parses something into a structured form
     - set:          Sets a thing (or group of things)
     - try_{verb}:   Best-effort operation, failure returns null or error obj
 
 Do NOT use these deprecated verbs:
+    - disable:      Prefer `enable(enable: boolean)`.
+    - is_disabled:  Prefer `is_enabled()`.
     - list:         Redundant with "get"
-    - show:         Redundant with "print", "echo"
     - notify:       Redundant with "print", "echo"
+    - show:         Redundant with "print", "echo"
+    - toggle:       Prefer `enable(not is_enabled())`.
 
 Use consistent names for {noun} (nouns) in API functions: buffer is called
 "buf" everywhere, not "buffer" in some places and "buf" in others.

runtime/doc/diagnostic.txt

@@ -367,6 +367,13 @@ Lua module: vim.diagnostic                                    *diagnostic-api*
       • {user_data}?  (`any`) arbitrary data plugins can add
       • {namespace}?  (`integer`)
 
+*vim.diagnostic.Filter*
+    Extends: |vim.diagnostic.Opts|
+
+
+    Fields: ~
+      • {ns_id}?  (`integer`) Namespace
+
 *vim.diagnostic.GetOpts*
     A table with the following keys:
 
@@ -616,23 +623,20 @@ count({bufnr}, {opts})                                *vim.diagnostic.count()*
         (`table`) Table with actually present severity values as keys (see
         |diagnostic-severity|) and integer counts as values.
 
-disable({bufnr}, {namespace})                       *vim.diagnostic.disable()*
-    Disable diagnostics in the given buffer.
+enable({bufnr}, {enable}, {opts})                    *vim.diagnostic.enable()*
+    Enables or disables diagnostics.
+
+    To "toggle", pass the inverse of `is_enabled()`: >lua
+        vim.diagnostic.enable(0, not vim.diagnostic.is_enabled())
+<
 
     Parameters: ~
-      • {bufnr}      (`integer?`) Buffer number, or 0 for current buffer. When
-                     omitted, disable diagnostics in all buffers.
-      • {namespace}  (`integer?`) Only disable diagnostics for the given
-                     namespace.
-
-enable({bufnr}, {namespace})                         *vim.diagnostic.enable()*
-    Enable diagnostics in the given buffer.
-
-    Parameters: ~
-      • {bufnr}      (`integer?`) Buffer number, or 0 for current buffer. When
-                     omitted, enable diagnostics in all buffers.
-      • {namespace}  (`integer?`) Only enable diagnostics for the given
-                     namespace.
+      • {bufnr}   (`integer?`) Buffer number, or 0 for current buffer, or
+                  `nil` for all buffers.
+      • {enable}  (`boolean?`) true/nil to enable, false to disable
+      • {opts}    (`vim.diagnostic.Filter?`) Filter by these opts, or `nil`
+                  for all. Only `ns_id` is supported, currently. See
+                  |vim.diagnostic.Filter|.
 
 fromqflist({list})                               *vim.diagnostic.fromqflist()*
     Convert a list of quickfix items to a list of diagnostics.
@@ -733,7 +737,7 @@ hide({namespace}, {bufnr})                             *vim.diagnostic.hide()*
     diagnostics, use |vim.diagnostic.reset()|.
 
     To hide diagnostics and prevent them from re-displaying, use
-    |vim.diagnostic.disable()|.
+    |vim.diagnostic.enable()|.
 
     Parameters: ~
       • {namespace}  (`integer?`) Diagnostic namespace. When omitted, hide
@@ -741,14 +745,16 @@ hide({namespace}, {bufnr})                             *vim.diagnostic.hide()*
       • {bufnr}      (`integer?`) Buffer number, or 0 for current buffer. When
                      omitted, hide diagnostics in all buffers.
 
-is_disabled({bufnr}, {namespace})               *vim.diagnostic.is_disabled()*
-    Check whether diagnostics are disabled in a given buffer.
+is_enabled({bufnr}, {namespace})                 *vim.diagnostic.is_enabled()*
+    Check whether diagnostics are enabled.
+
+    Note: ~
+      • This API is pre-release (unstable).
 
     Parameters: ~
       • {bufnr}      (`integer?`) Buffer number, or 0 for current buffer.
-      • {namespace}  (`integer?`) Diagnostic namespace. When omitted, checks
-                     if all diagnostics are disabled in {bufnr}. Otherwise,
-                     only checks if diagnostics from {namespace} are disabled.
+      • {namespace}  (`integer?`) Diagnostic namespace, or `nil` for all
+                     diagnostics in {bufnr}.
 
     Return: ~
         (`boolean`)

runtime/doc/news-0.9.txt

@@ -162,7 +162,7 @@ The following new APIs or features were added.
 • |vim.diagnostic| now supports LSP DiagnosticsTag.
   See: https://microsoft.github.io/language-server-protocol/specification/#diagnosticTag
 
-• |vim.diagnostic.is_disabled()| checks if diagnostics are disabled in a given
+• vim.diagnostic.is_disabled() checks if diagnostics are disabled in a given
   buffer or namespace.
 
 • Treesitter captures can now be transformed by directives. This will allow

runtime/doc/news.txt

@@ -328,6 +328,8 @@ The following new APIs and features were added.
   |vim.diagnostic.get()| when only the number of diagnostics is needed, but
   not the diagnostics themselves.
 
+• Introduced |vim.diagnostic.is_enabled()|
+
 • |vim.deepcopy()| has a `noref` argument to avoid hashing table values.
 
 • Terminal buffers emit a |TermRequest| autocommand event when the child
@@ -419,6 +421,9 @@ The following changes to existing APIs or features add new behavior.
 • |vim.diagnostic.get()| and |vim.diagnostic.count()| accept multiple
   namespaces rather than just a single namespace.
 
+• |vim.diagnostic.enable()| gained new parameters, and the old signature is
+  deprecated.
+
 • Extmarks now fully support multi-line ranges, and a single extmark can be
   used to highlight a range of arbitrary length. The |nvim_buf_set_extmark()|
   API function already allowed you to define such ranges, but highlight regions
@@ -520,6 +525,10 @@ release.
   - |nvim_win_get_option()|	Use |nvim_get_option_value()| instead.
   - |nvim_win_set_option()|	Use |nvim_set_option_value()| instead.
 
+• vim.diagnostic functions:
+  - |vim.diagnostic.disable()|
+  - |vim.diagnostic.is_disabled()|
+
 • vim.lsp functions:
   - |vim.lsp.util.get_progress_messages()|	Use |vim.lsp.status()| instead.
   - |vim.lsp.get_active_clients()|		Use |vim.lsp.get_clients()| instead.

runtime/lua/vim/diagnostic.lua

@@ -239,6 +239,9 @@ local M = {}
 --- whole line the sign is placed in.
 --- @field linehl? table<vim.diagnostic.Severity,string>
 
+--- @class vim.diagnostic.Filter : vim.diagnostic.Opts
+--- @field ns_id? integer Namespace
+
 --- @nodoc
 --- @enum vim.diagnostic.Severity
 M.severity = {
@@ -1492,7 +1495,7 @@ end
 --- diagnostics, use |vim.diagnostic.reset()|.
 ---
 --- To hide diagnostics and prevent them from re-displaying, use
---- |vim.diagnostic.disable()|.
+--- |vim.diagnostic.enable()|.
 ---
 ---@param namespace integer? Diagnostic namespace. When omitted, hide
 ---                          diagnostics from all namespaces.
@@ -1517,25 +1520,29 @@ function M.hide(namespace, bufnr)
   end
 end
 
---- Check whether diagnostics are disabled in a given buffer.
+--- Check whether diagnostics are enabled.
 ---
----@param bufnr integer? Buffer number, or 0 for current buffer.
----@param namespace integer? Diagnostic namespace. When omitted, checks if
----                          all diagnostics are disabled in {bufnr}.
----                          Otherwise, only checks if diagnostics from
----                          {namespace} are disabled.
----@return boolean
-function M.is_disabled(bufnr, namespace)
+--- @param bufnr integer? Buffer number, or 0 for current buffer.
+--- @param namespace integer? Diagnostic namespace, or `nil` for all diagnostics in {bufnr}.
+--- @return boolean
+--- @since 12
+function M.is_enabled(bufnr, namespace)
   bufnr = get_bufnr(bufnr)
   if namespace and M.get_namespace(namespace).disabled then
-    return true
+    return false
   end
 
   if type(diagnostic_disabled[bufnr]) == 'table' then
-    return diagnostic_disabled[bufnr][namespace]
+    return not diagnostic_disabled[bufnr][namespace]
   end
 
-  return diagnostic_disabled[bufnr] ~= nil
+  return diagnostic_disabled[bufnr] == nil
+end
+
+--- @deprecated use `vim.diagnostic.is_enabled()`
+function M.is_disabled(bufnr, namespace)
+  vim.deprecate('vim.diagnostic.is_disabled()', 'vim.diagnostic.is_enabled()', '0.12', nil, false)
+  return not M.is_enabled(bufnr, namespace)
 end
 
 --- Display diagnostics for the given namespace and buffer.
@@ -1581,7 +1588,7 @@ function M.show(namespace, bufnr, diagnostics, opts)
     return
   end
 
-  if M.is_disabled(bufnr, namespace) then
+  if not M.is_enabled(bufnr, namespace) then
     return
   end
 
@@ -1923,71 +1930,107 @@ function M.setloclist(opts)
   set_list(true, opts)
 end
 
---- Disable diagnostics in the given buffer.
----
----@param bufnr integer? Buffer number, or 0 for current buffer. When
----                      omitted, disable diagnostics in all buffers.
----@param namespace integer? Only disable diagnostics for the given namespace.
+--- @deprecated use `vim.diagnostic.enabled(…, false)`
 function M.disable(bufnr, namespace)
-  vim.validate({ bufnr = { bufnr, 'n', true }, namespace = { namespace, 'n', true } })
-  if bufnr == nil then
-    if namespace == nil then
-      -- Disable everything (including as yet non-existing buffers and
-      -- namespaces) by setting diagnostic_disabled to an empty table and set
-      -- its metatable to always return true. This metatable is removed
-      -- in enable()
-      diagnostic_disabled = setmetatable({}, {
-        __index = function()
-          return true
-        end,
-      })
-    else
-      local ns = M.get_namespace(namespace)
-      ns.disabled = true
-    end
-  else
-    bufnr = get_bufnr(bufnr)
-    if namespace == nil then
-      diagnostic_disabled[bufnr] = true
-    else
-      if type(diagnostic_disabled[bufnr]) ~= 'table' then
-        diagnostic_disabled[bufnr] = {}
-      end
-      diagnostic_disabled[bufnr][namespace] = true
-    end
-  end
-
-  M.hide(namespace, bufnr)
+  vim.deprecate(
+    'vim.diagnostic.disable()',
+    'vim.diagnostic.enabled(…, false)',
+    '0.12',
+    nil,
+    false
+  )
+  M.enable(bufnr, false, { ns_id = namespace })
 end
 
---- Enable diagnostics in the given buffer.
+--- Enables or disables diagnostics.
 ---
----@param bufnr integer? Buffer number, or 0 for current buffer. When
----                      omitted, enable diagnostics in all buffers.
----@param namespace integer? Only enable diagnostics for the given namespace.
-function M.enable(bufnr, namespace)
-  vim.validate({ bufnr = { bufnr, 'n', true }, namespace = { namespace, 'n', true } })
+--- To "toggle", pass the inverse of `is_enabled()`:
+---
+--- ```lua
+--- vim.diagnostic.enable(0, not vim.diagnostic.is_enabled())
+--- ```
+---
+--- @param bufnr integer? Buffer number, or 0 for current buffer, or `nil` for all buffers.
+--- @param enable (boolean|nil) true/nil to enable, false to disable
+--- @param opts vim.diagnostic.Filter? Filter by these opts, or `nil` for all. Only `ns_id` is
+--- supported, currently.
+function M.enable(bufnr, enable, opts)
+  opts = opts or {}
+  if type(enable) == 'number' then
+    -- Legacy signature.
+    vim.deprecate(
+      'vim.diagnostic.enable(buf:number, namespace)',
+      'vim.diagnostic.enable(buf:number, enable:boolean, opts)',
+      '0.12',
+      nil,
+      false
+    )
+    opts.ns_id = enable
+    enable = true
+  end
+  vim.validate({
+    bufnr = { bufnr, 'n', true },
+    enable = {
+      enable,
+      function(o)
+        return o == nil or type(o) == 'boolean' or type(o) == 'number'
+      end,
+      'boolean or number (deprecated)',
+    },
+    opts = {
+      opts,
+      function(o)
+        return o == nil
+          or (
+            type(o) == 'table'
+            -- TODO(justinmk): support other `vim.diagnostic.Filter` fields.
+            and (vim.tbl_isempty(o) or vim.deep_equal(vim.tbl_keys(o), { 'ns_id' }))
+          )
+      end,
+      'vim.diagnostic.Filter table (only ns_id is supported currently)',
+    },
+  })
+  enable = enable == nil and true or enable
+
   if bufnr == nil then
-    if namespace == nil then
-      -- Enable everything by setting diagnostic_disabled to an empty table
-      diagnostic_disabled = {}
+    if opts.ns_id == nil then
+      diagnostic_disabled = (
+        enable
+          -- Enable everything by setting diagnostic_disabled to an empty table.
+          and {}
+        -- Disable everything (including as yet non-existing buffers and namespaces) by setting
+        -- diagnostic_disabled to an empty table and set its metatable to always return true.
+        or setmetatable({}, {
+          __index = function()
+            return true
+          end,
+        })
+      )
     else
-      local ns = M.get_namespace(namespace)
-      ns.disabled = false
+      local ns = M.get_namespace(opts.ns_id)
+      ns.disabled = not enable
     end
   else
     bufnr = get_bufnr(bufnr)
-    if namespace == nil then
-      diagnostic_disabled[bufnr] = nil
+    if opts.ns_id == nil then
+      diagnostic_disabled[bufnr] = (not enable) and true or nil
     else
       if type(diagnostic_disabled[bufnr]) ~= 'table' then
-        return
+        if enable then
+          return
+        else
+          diagnostic_disabled[bufnr] = {}
+        end
       end
-      diagnostic_disabled[bufnr][namespace] = nil
+      diagnostic_disabled[bufnr][opts.ns_id] = (not enable) and true or nil
     end
   end
 
-  M.show(namespace, bufnr)
+  if enable then
+    M.show(opts.ns_id, bufnr)
+  else
+    M.hide(opts.ns_id, bufnr)
+  end
 end
 
 --- Parse a diagnostic from a string.