Setting the diagnosticsOnChange default to True

Author: lorenzo

hie-plugin-api/Haskell/Ide/Engine/Config.hs

@@ -33,7 +33,7 @@ data Config =
 instance Default Config where
   def = Config
     { hlintOn                     = True
-    , diagnosticsOnChange         = False
+    , diagnosticsOnChange         = True
     , maxNumberOfProblems         = 100
     , diagnosticsDebounceDuration = 350000
     , liquidOn                    = False

test/functional/DiagnosticsSpec.hs

@@ -4,11 +4,14 @@ module DiagnosticsSpec where
 
 import           Control.Lens hiding (List)
 import           Control.Monad.IO.Class
+import           Data.Aeson (toJSON)
 import qualified Data.Text as T
+import qualified Data.Default
 import           Haskell.Ide.Engine.MonadFunctions
+import           Haskell.Ide.Engine.Config
 import           Language.Haskell.LSP.Test hiding (message)
-import           Language.Haskell.LSP.Types as LSP
-import           Language.Haskell.LSP.Types.Lens as LSP hiding (contents, error )
+import           Language.Haskell.LSP.Types
+import qualified Language.Haskell.LSP.Types.Lens as LSP
 import           Test.Hspec
 import           TestUtils
 import           Utils
@@ -30,10 +33,10 @@ spec = describe "diagnostics providers" $ do
 
         liftIO $ do
           length diags `shouldBe` 2
-          reduceDiag ^. range `shouldBe` Range (Position 1 0) (Position 1 12)
-          reduceDiag ^. severity `shouldBe` Just DsInfo
-          reduceDiag ^. code `shouldBe` Just "Eta reduce"
-          reduceDiag ^. source `shouldBe` Just "hlint"
+          reduceDiag ^. LSP.range `shouldBe` Range (Position 1 0) (Position 1 12)
+          reduceDiag ^. LSP.severity `shouldBe` Just DsInfo
+          reduceDiag ^. LSP.code `shouldBe` Just "Eta reduce"
+          reduceDiag ^. LSP.source `shouldBe` Just "hlint"
 
         diags2a <- waitForDiagnostics
         -- liftIO $ show diags2a `shouldBe` ""
@@ -51,24 +54,44 @@ spec = describe "diagnostics providers" $ do
         -- liftIO $ show diags3 `shouldBe` ""
         liftIO $ do
           length diags3 `shouldBe` 3
-          d ^. range `shouldBe` Range (Position 0 0) (Position 1 0)
-          d ^. severity `shouldBe` Nothing
-          d ^. code `shouldBe` Nothing
-          d ^. source `shouldBe` Just "eg2"
-          d ^. message `shouldBe` T.pack "Example plugin diagnostic, triggered byDiagnosticOnSave"
+          d ^. LSP.range `shouldBe` Range (Position 0 0) (Position 1 0)
+          d ^. LSP.severity `shouldBe` Nothing
+          d ^. LSP.code `shouldBe` Nothing
+          d ^. LSP.source `shouldBe` Just "eg2"
+          d ^. LSP.message `shouldBe` T.pack "Example plugin diagnostic, triggered byDiagnosticOnSave"
 
   describe "typed hole errors" $
     it "is deferred" $
       runSession hieCommand fullCaps "test/testdata" $ do
         _ <- openDoc "TypedHoles.hs" "haskell"
         [diag] <- waitForDiagnosticsSource "ghcmod"
-        liftIO $ diag ^. severity `shouldBe` Just DsWarning
+        liftIO $ diag ^. LSP.severity `shouldBe` Just DsWarning
 
   describe "Warnings are warnings" $
     it "Overrides -Werror" $
       runSession hieCommand fullCaps "test/testdata/wErrorTest" $ do
         _ <- openDoc "src/WError.hs" "haskell"
         [diag] <- waitForDiagnosticsSource "ghcmod"
-        liftIO $ diag ^. severity `shouldBe` Just DsWarning
+        liftIO $ diag ^. LSP.severity `shouldBe` Just DsWarning
+
+  describe "only diagnostics on save" $
+    it "Respects diagnosticsOnChange setting" $
+      runSession hieCommandExamplePlugin codeActionSupportCaps "test/testdata" $ do
+        let config = Data.Default.def { diagnosticsOnChange = False } :: Config
+        sendNotification WorkspaceDidChangeConfiguration (DidChangeConfigurationParams (toJSON config))
+        doc <- openDoc "Hover.hs" "haskell"
+        diags <- waitForDiagnostics
+
+        liftIO $ do
+          length diags `shouldBe` 0
+
+        let te = TextEdit (Range (Position 0 0) (Position 0 13)) ""
+        _ <- applyEdit doc te
+        noDiagnostics
+
+        sendNotification TextDocumentDidSave (DidSaveTextDocumentParams doc)
+        diags2 <- waitForDiagnostics
+        liftIO $
+          length diags2 `shouldBe` 1
 
 -- ---------------------------------------------------------------------

test/functional/FunctionalCodeActionsSpec.hs

@@ -20,16 +20,10 @@ import qualified Language.Haskell.LSP.Types.Capabilities as C
 import           Test.Hspec
 import           TestUtils
 
-runSessionWithOnChange :: String -> C.ClientCapabilities -> FilePath -> Session a -> IO a
-runSessionWithOnChange cmd caps name test = runSession cmd caps name $ do
-  let config = def { diagnosticsOnChange = True }
-  sendNotification WorkspaceDidChangeConfiguration (DidChangeConfigurationParams (toJSON config))
-  test
-
 spec :: Spec
 spec = describe "code actions" $ do
   describe "hlint suggestions" $ do
-    it "provides 3.8 code actions" $ runSessionWithOnChange hieCommand fullCaps "test/testdata" $ do
+    it "provides 3.8 code actions" $ runSession hieCommand fullCaps "test/testdata" $ do
 
       doc <- openDoc "ApplyRefact2.hs" "haskell"
       diags@(reduceDiag:_) <- waitForDiagnostics
@@ -55,7 +49,7 @@ spec = describe "code actions" $ do
 
     -- ---------------------------------
 
-    it "falls back to pre 3.8 code actions" $ runSessionWithOnChange hieCommand noLiteralCaps "test/testdata" $ do
+    it "falls back to pre 3.8 code actions" $ runSession hieCommand noLiteralCaps "test/testdata" $ do
       doc <- openDoc "ApplyRefact2.hs" "haskell"
 
       _ <- waitForDiagnostics