From 1df98b6636e64b88d765370ceeff5bf158c602ee Mon Sep 17 00:00:00 2001
From: Matt Sturgeon <matt@sturgeon.me.uk>
Date: Wed, 30 Apr 2025 18:29:16 +0100
Subject: [PATCH] modules/diagnostic: rename `diagnostic.config` ->
 `diagnostic.settings`

Follow up to #3226, in line with the decisions made in #3254.
---
 modules/diagnostic.nix                             | 14 ++++++++++----
 plugins/by-name/lsp-lines/default.nix              |  4 ++--
 tests/test-sources/modules/diagnostics.nix         |  2 +-
 .../plugins/by-name/lsp-lines/default.nix          |  2 +-
 4 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/modules/diagnostic.nix b/modules/diagnostic.nix
index b4a67a77..3e57a832 100644
--- a/modules/diagnostic.nix
+++ b/modules/diagnostic.nix
@@ -8,7 +8,7 @@ let
 in
 {
   options.diagnostic = {
-    config = lib.mkOption {
+    settings = lib.mkOption {
       type = with lib.types; attrsOf anything;
       default = { };
       description = "The configuration diagnostic options, provided to `vim.diagnostic.config`.";
@@ -21,12 +21,18 @@ in
 
   imports = [
     # TODO: Added 2025-04-26; remove after 25.05
-    (lib.mkRenamedOptionModule [ "diagnostics" ] [ "diagnostic" "config" ])
+    (lib.mkRenamedOptionModule [ "diagnostics" ] [ "diagnostic" "settings" ])
+
+    # TODO: Added 2025-04-30;
+    # The above rename initially renamed `diagnostics` -> `diagnostic.config`
+    # This rename covers any users who migrated between 2025-04-26 and 2025-04-30
+    # We can consider removing this rename earlier than usual
+    (lib.mkRenamedOptionModule [ "diagnostic" "config" ] [ "diagnostic" "settings" ])
   ];
 
   config = {
-    extraConfigLuaPre = lib.mkIf (cfg.config != { }) ''
-      vim.diagnostic.config(${lib.nixvim.toLuaObject cfg.config})
+    extraConfigLuaPre = lib.mkIf (cfg.settings != { }) ''
+      vim.diagnostic.config(${lib.nixvim.toLuaObject cfg.settings})
     '';
   };
 }
diff --git a/plugins/by-name/lsp-lines/default.nix b/plugins/by-name/lsp-lines/default.nix
index 208565a5..3eb87243 100644
--- a/plugins/by-name/lsp-lines/default.nix
+++ b/plugins/by-name/lsp-lines/default.nix
@@ -25,7 +25,7 @@ lib.nixvim.plugins.mkNeovimPlugin {
       ]
       [
         "diagnostic"
-        "config"
+        "settings"
         "virtual_lines"
         "only_current_line"
       ]
@@ -34,6 +34,6 @@ lib.nixvim.plugins.mkNeovimPlugin {
 
   extraConfig = {
     # Strongly recommended by the plugin, to avoid duplication.
-    diagnostic.config.virtual_text = mkDefault false;
+    diagnostic.settings.virtual_text = mkDefault false;
   };
 }
diff --git a/tests/test-sources/modules/diagnostics.nix b/tests/test-sources/modules/diagnostics.nix
index 6709ab46..b200953f 100644
--- a/tests/test-sources/modules/diagnostics.nix
+++ b/tests/test-sources/modules/diagnostics.nix
@@ -1,6 +1,6 @@
 {
   example = {
-    diagnostic.config = {
+    diagnostic.settings = {
       virtual_text = false;
       virtual_lines.current_line = true;
     };
diff --git a/tests/test-sources/plugins/by-name/lsp-lines/default.nix b/tests/test-sources/plugins/by-name/lsp-lines/default.nix
index 1390fb6a..5c0792e1 100644
--- a/tests/test-sources/plugins/by-name/lsp-lines/default.nix
+++ b/tests/test-sources/plugins/by-name/lsp-lines/default.nix
@@ -6,7 +6,7 @@
   example = {
     plugins.lsp-lines.enable = true;
 
-    diagnostic.config.virtual_lines = {
+    diagnostic.settings.virtual_lines = {
       only_current_line = true;
       highlight_whole_line = false;
     };