Delete hlintOn

Author: michaelpj

docs/configuration.md

@@ -41,7 +41,6 @@ This option obviously would not make sense for language servers for other langua
 Here is a list of the additional settings currently supported by `haskell-language-server`, along with their setting key (you may not need to know this) and default:
 
 - Formatting provider (`haskell.formattingProvider`, default `ormolu`): what formatter to use; one of `floskell`, `ormolu`, `fourmolu`, `stylish-haskell`, or `brittany` (if compiled with the brittany plugin).
-- Hlint (`haskell.hlintOn`, default true): whether to enable Hlint support. *Deprecated* as it is equivalent to `haskell.plugin.hlint.globalOn`
 - Max completions (`haskell.maxCompletions`, default 40): maximum number of completions sent to the LSP client.
 - Check project (`haskell.checkProject`, default true): whether to typecheck the entire project on load. As it is activated by default could drive to bad perfomance in large projects.
 - Check parents (`haskell.checkParents`, default `CheckOnSaveAndClose`): when to typecheck reverse dependencies of a file; one of `NeverCheck`, `CheckOnClose`, `CheckOnSaveAndClose`, or `AlwaysCheck`.

hls-plugin-api/src/Ide/Plugin/Config.hs

@@ -49,7 +49,6 @@ data Config =
   Config
     { checkParents       :: CheckParents
     , checkProject       :: !Bool
-    , hlintOn            :: !Bool
     , formattingProvider :: !T.Text
     , maxCompletions     :: !Int
     , plugins            :: !(Map.Map T.Text PluginConfig)
@@ -59,7 +58,6 @@ instance Default Config where
   def = Config
     { checkParents                = CheckOnSave
     , checkProject                = True
-    , hlintOn                     = True
     -- , formattingProvider          = "brittany"
     , formattingProvider          = "ormolu"
     -- , formattingProvider          = "floskell"
@@ -79,7 +77,6 @@ parseConfig defValue = A.withObject "Config" $ \v -> do
       Just s -> flip (A.withObject "Config.settings") s $ \o -> Config
         <$> (o .:? "checkParents" <|> v .:? "checkParents") .!= checkParents defValue
         <*> (o .:? "checkProject" <|> v .:? "checkProject") .!= checkProject defValue
-        <*> o .:? "hlintOn"                                 .!= hlintOn defValue
         <*> o .:? "formattingProvider"                      .!= formattingProvider defValue
         <*> o .:? "maxCompletions"                          .!= maxCompletions defValue
         <*> o .:? "plugin"                                  .!= plugins defValue
@@ -90,7 +87,6 @@ instance A.ToJSON Config where
     where
       r = object [ "checkParents"                .= checkParents
                  , "checkProject"                .= checkProject
-                 , "hlintOn"                     .= hlintOn
                  , "formattingProvider"          .= formattingProvider
                  , "maxCompletions"              .= maxCompletions
                  , "plugin"                      .= plugins

plugins/hls-hlint-plugin/src/Ide/Plugin/Hlint.hs

@@ -167,9 +167,8 @@ rules :: PluginId -> Rules ()
 rules plugin = do
   define $ \GetHlintDiagnostics file -> do
     config <- getClientConfigAction def
-    let pluginConfig = configForPlugin config plugin
-    let hlintOn' = hlintOn config && plcGlobalOn pluginConfig && plcDiagnosticsOn pluginConfig
-    ideas <- if hlintOn' then getIdeas file else return (Right [])
+    let hlintOn = pluginEnabledConfig plcDiagnosticsOn plugin config
+    ideas <- if hlintOn then getIdeas file else return (Right [])
     return (diagnostics file ideas, Just ())
 
   defineNoFile $ \GetHlintSettings -> do

plugins/hls-hlint-plugin/test/Main.hs

@@ -12,8 +12,7 @@ import           Data.List               (find)
 import qualified Data.Map                as Map
 import           Data.Maybe              (fromJust, isJust)
 import qualified Data.Text               as T
-import           Ide.Plugin.Config       (Config (..), PluginConfig (..),
-                                          hlintOn)
+import           Ide.Plugin.Config       (Config (..), PluginConfig (..))
 import qualified Ide.Plugin.Config       as Plugin
 import qualified Ide.Plugin.Hlint        as HLint
 import qualified Language.LSP.Types.Lens as L
@@ -251,40 +250,24 @@ suggestionsTests =
                              , "a = id @Int 1"
                              ]
 
+
 configTests :: TestTree
 configTests = testGroup "hlint plugin config" [
 
-      testCase "changing hlintOn configuration enables or disables hlint diagnostics" $ runHlintSession "" $ do
-        let config = def { hlintOn = True }
-        sendConfigurationChanged (toJSON config)
-
-        doc <- openDoc "Base.hs" "haskell"
-        testHlintDiagnostics doc
-
-        let config' = def { hlintOn = False }
-        sendConfigurationChanged (toJSON config')
-
-        diags' <- waitForDiagnosticsFrom doc
-
-        liftIO $ noHlintDiagnostics diags'
-
-    , testCase "changing hlint plugin configuration enables or disables hlint diagnostics" $ runHlintSession "" $ do
-        let config = def { hlintOn = True }
-        sendConfigurationChanged (toJSON config)
+    testCase "changing hlint plugin configuration enables or disables hlint diagnostics" $ runHlintSession "" $ do
+        enableHlint
 
         doc <- openDoc "Base.hs" "haskell"
         testHlintDiagnostics doc
 
-        let config' = pluginGlobalOn config "hlint" False
-        sendConfigurationChanged (toJSON config')
+        disableHlint
 
         diags' <- waitForDiagnosticsFrom doc
 
         liftIO $ noHlintDiagnostics diags'
 
     , testCase "adding hlint flags to plugin configuration removes hlint diagnostics" $ runHlintSession "" $ do
-        let config = def { hlintOn = True }
-        sendConfigurationChanged (toJSON config)
+        enableHlint
 
         doc <- openDoc "Base.hs" "haskell"
         testHlintDiagnostics doc
@@ -297,8 +280,7 @@ configTests = testGroup "hlint plugin config" [
         liftIO $ noHlintDiagnostics diags'
 
     , testCase "adding hlint flags to plugin configuration adds hlint diagnostics" $ runHlintSession "" $ do
-        let config = def { hlintOn = True }
-        sendConfigurationChanged (toJSON config)
+        enableHlint
 
         doc <- openDoc "Generalise.hs" "haskell"
 
@@ -341,14 +323,19 @@ pluginGlobalOn config pid state = config'
 hlintConfigWithFlags :: [T.Text] -> Config
 hlintConfigWithFlags flags =
   def
-    { hlintOn = True
-    , Plugin.plugins = Map.fromList [("hlint",
-        def { Plugin.plcConfig = unObject $ object ["flags" .= flags] }
+    { Plugin.plugins = Map.fromList [("hlint",
+        def { Plugin.plcGlobalOn = True, Plugin.plcConfig = unObject $ object ["flags" .= flags] }
     )] }
   where
     unObject (Object obj) = obj
     unObject _            = undefined
 
+enableHlint :: Session ()
+enableHlint = sendConfigurationChanged $ toJSON $ def { Plugin.plugins = Map.fromList [ ("hlint", def { Plugin.plcGlobalOn = True }) ] }
+
+disableHlint :: Session ()
+disableHlint = sendConfigurationChanged $ toJSON $ def { Plugin.plugins = Map.fromList [ ("hlint", def { Plugin.plcGlobalOn = False }) ] }
+
 -- We have two main code paths in the plugin depending on how hlint interacts with ghc:
 -- * One when hlint uses ghc-lib (all ghc versions but the last version supported by hlint)
 -- * Another one when hlint uses directly ghc (only one version, which not have to be the last version supported by ghcide)