consistent naming

Author: Saizan

ghcide-test/exe/CradleTests.hs

@@ -321,7 +321,7 @@ runWithExtraFilesMultiComponent' :: SessionLoadingPreferenceConfig -> String ->
 runWithExtraFilesMultiComponent' sesLoading dirName action = do
   let vfs = mkIdeTestFs [copyDir dirName]
       lspConfig :: Config
-      lspConfig = def { sessionLoading = sesLoading }
+      lspConfig = def { componentsLoading = sesLoading }
       conf :: TestConfig ()
       conf = def
         { testPluginDescriptor = dummyPlugin
@@ -367,7 +367,7 @@ assertTypeCheckFailure doc msg = do
 setWholeProjectLoading :: Session ()
 setWholeProjectLoading = do
   setIgnoringConfigurationRequests False
-  setHlsConfig def{sessionLoading = PreferMultiWholeProjectLoading}
+  setHlsConfig def{componentsLoading = PreferMultiWholeProjectLoading}
 
 regressionBatchFailureIsolatesBrokenFile :: FilePath -> Session ()
 regressionBatchFailureIsolatesBrokenFile dir = do

ghcide/session-loader/Development/IDE/Session.hs

@@ -71,7 +71,7 @@ import           Ide.Logger                          (Pretty (pretty),
                                                       vcat, viaShow, (<+>))
 import           Ide.Types                           (Config,
                                                       SessionLoadingPreferenceConfig (..),
-                                                      sessionLoading)
+                                                      componentsLoading)
 import           Language.LSP.Protocol.Message
 import           Language.LSP.Server
 import           System.Directory
@@ -599,11 +599,11 @@ didSessionLoadingPreferenceConfigChange s = do
     mLoadingConfig <- liftIO $ readVar biosSessionLoadingVar
     case mLoadingConfig of
         Nothing -> do
-            liftIO $ writeVar biosSessionLoadingVar (Just (sessionLoading clientConfig))
+            liftIO $ writeVar biosSessionLoadingVar (Just (componentsLoading clientConfig))
             pure False
         Just loadingConfig -> do
-            liftIO $ writeVar biosSessionLoadingVar (Just (sessionLoading clientConfig))
-            pure (loadingConfig /= sessionLoading clientConfig)
+            liftIO $ writeVar biosSessionLoadingVar (Just (componentsLoading clientConfig))
+            pure (loadingConfig /= componentsLoading clientConfig)
 
 newSessionState :: IO SessionState
 newSessionState = do
@@ -1018,7 +1018,7 @@ loadCradleWithNotifications recorder sessionState hieYaml cfp = do
   let progMsg = "Setting up " <> T.pack (takeBaseName (cradleRootDir cradle))
                 <> " (for " <> T.pack lfpLog <> ")"
 
-  sessionPref <- asks (sessionLoading . sessionClientConfig)
+  sessionPref <- asks (componentsLoading . sessionClientConfig)
   extraToLoads <- liftIO $ getExtraFilesToLoad sessionState cfp
   -- Start loading the file!
   eopts <- mRunLspTCallback lspEnv (\act -> withIndefiniteProgress progMsg Nothing NotCancellable (const act)) $

ghcide/src/Development/IDE/Core/Rules.hs

@@ -734,7 +734,7 @@ loadGhcSession recorder ghcSessionDepsConfig = do
                 [ B.encode (hash (sessionVersion res))
                 -- When the session version changes, reload all session
                 -- hsc env sessions
-                , B.encode (show (sessionLoading config))
+                , B.encode (show (componentsLoading config))
                 -- The loading config affects session loading.
                 -- Invalidate all build nodes.
                 -- Changing the session loading config will increment

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

@@ -51,7 +51,7 @@ parseConfig idePlugins defValue = A.withObject "settings" $ \o ->
     where
       loadingPref o =
         (o .:? "componentsLoading"
-        <|> o .:? "sessionLoading") .!= sessionLoading defValue
+        <|> o .:? "sessionLoading") .!= componentsLoading defValue
 
 -- | Parse the 'PluginConfig'.
 --   Since we need to fall back to default values if we do not find one in the input,

hls-plugin-api/src/Ide/Types.hs

@@ -180,7 +180,7 @@ data Config =
     , formattingProvider      :: !T.Text
     , cabalFormattingProvider :: !T.Text
     , maxCompletions          :: !Int
-    , sessionLoading          :: !SessionLoadingPreferenceConfig
+    , componentsLoading       :: !SessionLoadingPreferenceConfig
     , linkSourceTo            :: !OptLinkTo
     , linkDocTo               :: !OptLinkTo
     , plugins                 :: !(Map.Map PluginId PluginConfig)
@@ -193,7 +193,7 @@ instance ToJSON Config where
            , "formattingProvider"          .= formattingProvider
            , "cabalFormattingProvider"     .= cabalFormattingProvider
            , "maxCompletions"              .= maxCompletions
-           , "componentsLoading"           .= sessionLoading
+           , "componentsLoading"           .= componentsLoading
            , "linkSourceTo"                .= linkSourceTo
            , "linkDocTo"                   .= linkDocTo
            , "plugin"                      .= Map.mapKeysMonotonic (\(PluginId p) -> p) plugins
@@ -209,7 +209,7 @@ instance Default Config where
     -- , cabalFormattingProvider     = "cabal-fmt"
     -- this string value needs to kept in sync with the value provided in HlsPlugins
     , maxCompletions              = 40
-    , sessionLoading              = PreferMultiComponentLoading
+    , componentsLoading           = PreferMultiComponentLoading
     , linkSourceTo                = LinkToHackage
     , linkDocTo                   = LinkToHackage
     , plugins                     = mempty
@@ -250,30 +250,36 @@ instance Pretty SessionLoadingPreferenceConfig where
     pretty PreferMultiComponentLoading    = "Prefer Multiple Components Loading"
     pretty PreferMultiWholeProjectLoading = "Prefer Whole Project Loading"
 
+-- | Labels for @SessionLoadingPreferenceConfig@ json format.
+singleComponent, multipleComponents, single, multiNeededOnly, multiWholeProject :: T.Text
+singleComponent = "singleComponent"
+multipleComponents = "multipleComponents"
+single = "single"
+multiNeededOnly = "multi: needed-only"
+multiWholeProject = "multi: whole-project"
+
 instance ToJSON SessionLoadingPreferenceConfig where
     toJSON PreferSingleComponentLoading =
-        String "single"
+        String single
     toJSON PreferMultiComponentLoading =
-        String "multi: needed-only"
+        String multiNeededOnly
     toJSON PreferMultiWholeProjectLoading =
-        String "multi: whole-project"
+        String multiWholeProject
 
 instance FromJSON SessionLoadingPreferenceConfig where
-    parseJSON (String val) = case val of
-        "singleComponent"    -> pure PreferSingleComponentLoading
-        "single"             -> pure PreferSingleComponentLoading
-        "multipleComponents" -> pure PreferMultiComponentLoading
-        "multi: needed-only" -> pure PreferMultiComponentLoading
-        "multi: whole-project" -> pure PreferMultiWholeProjectLoading
-        _ -> A.prependFailure "parsing SessionLoadingPreferenceConfig failed, "
+    parseJSON (String val)
+        | val `elem` [singleComponent, single] = pure PreferSingleComponentLoading
+        | val `elem` [multipleComponents, multiNeededOnly] = pure PreferMultiComponentLoading
+        | val == multiWholeProject = pure PreferMultiWholeProjectLoading
+        | otherwise = A.prependFailure "parsing SessionLoadingPreferenceConfig failed, "
             (A.parseFail $ unwords ["Expected one of", expected,  "but got", T.unpack val] )
           where
             expected = concat ["[", List.intercalate ", " fields, "]"]
-            fields = map (show @String)
-              ["single", "multi: only-needed", "multi: whole-project"]
+            fields = map show
+              [single, multiNeededOnly, multiWholeProject]
               ++
-              [ show @String old_value ++ " (deprecated)"
-              | old_value <- ["singleComponent","multiComponent"]
+              [ show old_value ++ " (deprecated)"
+              | old_value <- [singleComponent,multipleComponents]
               ]
     parseJSON o = A.prependFailure "parsing SessionLoadingPreferenceConfig failed, "
             (A.typeMismatch "String" o)