feat: allow configuration of virtual text and virtual lines on startup

Author: mehalter

README.md

@@ -138,7 +138,7 @@ local opts = {
   features = {
     autopairs = true, -- enable or disable autopairs on start
     cmp = true, -- enable or disable cmp on start
-    diagnostics = true, -- enable or disable diagnostics on start
+    diagnostics = { virtual_text = true, virtual_lines = false }, -- enable or disable diagnostics features on start
     highlighturl = true, -- enable or disable highlighting of urls on start
     -- table for defining the size of the max file for all features, above these limits we disable features like treesitter.
     large_buf = {

lua/astrocore/config.lua

@@ -53,6 +53,12 @@
 ---@field filetypes string[]? filetypes to ignore
 ---@field buftypes string[]? buffer types to ignore
 
+-- TODO: remove note about version after dropping support for Neovim v0.10
+
+---@class AstroCoreDiagnosticsFeature
+---@field virtual_text boolean? show virtual text on startup
+---@field virtual_lines boolean? show virtual lines on startup (Neovim v0.11+ only)
+---
 ---@class AstroCoreSessionOpts
 ---Session autosaving options
 ---Example:
@@ -79,7 +85,7 @@
 ---@class AstroCoreFeatureOpts
 ---@field autopairs boolean? enable or disable autopairs on start (boolean; default = true)
 ---@field cmp boolean? enable or disable cmp on start (boolean; default = true)
----@field diagnostics boolean? diagnostic enabled on start
+---@field diagnostics boolean|AstroCoreDiagnosticsFeature? diagnostic enabled on start
 ---@field highlighturl boolean? enable or disable highlighting of urls on start (boolean; default = true)
 ---table for defining the size of the max file for all features, above these limits we disable features like treesitter.
 ---value can also be `false` to disable large buffer detection.

lua/astrocore/init.lua

@@ -14,9 +14,6 @@ M.config = require "astrocore.config"
 --- A table to manage ToggleTerm terminals created by the user, indexed by the command run and then the instance number
 ---@type table<string,table<integer,table>>
 M.user_terminals = {}
---- A table of settings for different levels of diagnostics
----@type table<integer,vim.diagnostic.Opts>
-M.diagnostics = { [0] = {}, {}, {}, {} }
 
 --- Merge extended options with a default table of options
 ---@param default? table The default table that you want to merge into
@@ -548,7 +545,25 @@ function M.setup(opts)
 
   -- setup diagnostics
   vim.diagnostic.config(M.config.diagnostics)
-  vim.diagnostic.enable(vim.tbl_get(M.config, "features", "diagnostics") or false)
+  local diagnostic_feature = vim.tbl_get(M.config, "features", "diagnostics")
+  if diagnostic_feature then
+    vim.diagnostic.enable(true)
+    if type(diagnostic_feature) == "table" then
+      local diagnostic_config = assert(vim.diagnostic.config())
+      -- setup startup state of virtual text and virtual_lines
+      for _, feature in ipairs { "virtual_text", "virtual_lines" } do
+        if
+          diagnostic_config[feature] ~= nil
+          and diagnostic_feature[feature] ~= nil
+          and (diagnostic_config[feature] ~= false) ~= diagnostic_feature[feature]
+        then
+          require("astrocore.toggles")[feature](true)
+        end
+      end
+    end
+  else
+    vim.diagnostic.enable(false)
+  end
 
   vim.api.nvim_create_autocmd({ "BufReadPre", "BufReadPost" }, {
     group = vim.api.nvim_create_augroup("large_buf_detector", { clear = true }),