From f3350010f5effec54a3f2520c486a1dd30303b3c Mon Sep 17 00:00:00 2001
From: jeukshi <orlowd+gh@gmail.com>
Date: Tue, 29 Oct 2024 14:04:33 +0100
Subject: [PATCH] Don't suggest -Wno-deferred-out-of-scope-variables

Fixes #4440
---
 plugins/hls-pragmas-plugin/src/Ide/Plugin/Pragmas.hs      | 8 ++++++--
 plugins/hls-pragmas-plugin/test/Main.hs                   | 5 +++++
 .../test/testdata/DeferredOutOfScopeVariables.expected.hs | 5 +++++
 .../test/testdata/DeferredOutOfScopeVariables.hs          | 5 +++++
 4 files changed, 21 insertions(+), 2 deletions(-)
 create mode 100644 plugins/hls-pragmas-plugin/test/testdata/DeferredOutOfScopeVariables.expected.hs
 create mode 100644 plugins/hls-pragmas-plugin/test/testdata/DeferredOutOfScopeVariables.hs

diff --git a/plugins/hls-pragmas-plugin/src/Ide/Plugin/Pragmas.hs b/plugins/hls-pragmas-plugin/src/Ide/Plugin/Pragmas.hs
index 3bca988580..13a6f08b4b 100644
--- a/plugins/hls-pragmas-plugin/src/Ide/Plugin/Pragmas.hs
+++ b/plugins/hls-pragmas-plugin/src/Ide/Plugin/Pragmas.hs
@@ -126,9 +126,13 @@ suggestDisableWarning Diagnostic {_code}
     pure ("Disable \"" <> w <> "\" warnings", OptGHC w)
   | otherwise = []
 
--- Don't suggest disabling type errors as a solution to all type errors
 warningBlacklist :: [T.Text]
-warningBlacklist = ["deferred-type-errors"]
+warningBlacklist =
+  -- Don't suggest disabling type errors as a solution to all type errors.
+  [ "deferred-type-errors"
+  -- Don't suggest disabling out of scope errors as a solution to all out of scope errors.
+  , "deferred-out-of-scope-variables"
+  ]
 
 -- ---------------------------------------------------------------------
 
diff --git a/plugins/hls-pragmas-plugin/test/Main.hs b/plugins/hls-pragmas-plugin/test/Main.hs
index dc62c14860..ac4a67dcfd 100644
--- a/plugins/hls-pragmas-plugin/test/Main.hs
+++ b/plugins/hls-pragmas-plugin/test/Main.hs
@@ -114,6 +114,11 @@ codeActionTests' =
       cas <- map fromAction <$> getAllCodeActions doc
       liftIO $ "Disable \"deferred-type-errors\" warnings" `notElem` map (^. L.title) cas @? "Doesn't contain deferred-type-errors code action"
       liftIO $ length cas == 0 @? "Expected no code actions, but got: " <> show cas
+  , goldenWithPragmas pragmasSuggestPlugin "doesn't suggest disabling out of scope variables" "DeferredOutOfScopeVariables" $ \doc -> do
+      _ <- waitForDiagnosticsFrom doc
+      cas <- map fromAction <$> getAllCodeActions doc
+      liftIO $ "Disable \"deferred-out-of-scope-variables\" warnings" `notElem` map (^. L.title) cas @? "Doesn't contain deferred-out-of-scope-variables code action"
+      liftIO $ length cas == 0 @? "Expected no code actions, but got: " <> show cas
   ]
 
 completionTests :: TestTree
diff --git a/plugins/hls-pragmas-plugin/test/testdata/DeferredOutOfScopeVariables.expected.hs b/plugins/hls-pragmas-plugin/test/testdata/DeferredOutOfScopeVariables.expected.hs
new file mode 100644
index 0000000000..38d17261dc
--- /dev/null
+++ b/plugins/hls-pragmas-plugin/test/testdata/DeferredOutOfScopeVariables.expected.hs
@@ -0,0 +1,5 @@
+module DeferredOutOfScopeVariables where
+
+f :: ()
+f = let x = Doesn'tExist
+     in undefined
diff --git a/plugins/hls-pragmas-plugin/test/testdata/DeferredOutOfScopeVariables.hs b/plugins/hls-pragmas-plugin/test/testdata/DeferredOutOfScopeVariables.hs
new file mode 100644
index 0000000000..38d17261dc
--- /dev/null
+++ b/plugins/hls-pragmas-plugin/test/testdata/DeferredOutOfScopeVariables.hs
@@ -0,0 +1,5 @@
+module DeferredOutOfScopeVariables where
+
+f :: ()
+f = let x = Doesn'tExist
+     in undefined