Remove .hls directory magic strings

haskell · Aug 17, 2023 · 3d098ba · 3d098ba
1 parent 6b98465
commit 3d098ba
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/ghcide/src/Development/IDE/Core/Actions.hs b/ghcide/src/Development/IDE/Core/Actions.hs
@@ -37,6 +37,7 @@ import qualified Development.IDE.Spans.AtPoint        as AtPoint
 import           Development.IDE.Types.HscEnvEq       (hscEnv)
 import           Development.IDE.Types.Location
 import qualified HieDb
+import           Ide.Types                            (hlsDirectory, dependenciesDirectory)
 import           Language.LSP.Protocol.Types          (DocumentHighlight (..),
                                                        SymbolInformation (..),
                                                        normalizedFilePathToUri,
@@ -116,7 +117,7 @@ lookupMod HieDbWriter{indexQueue} hieFile moduleName uid _boot = MaybeT $ do
         -- name and hash of the package the dependency module is
         -- found in. The name and hash are both parts of the UnitId.
         writeOutDir :: FilePath
-        writeOutDir = projectRoot </> ".hls" </> "dependencies" </> show uid
+        writeOutDir = projectRoot </> hlsDirectory </> dependenciesDirectory </> show uid
         -- The module name is separated into directories, with the
         -- last part of the module name giving the name of the
         -- haskell file with a .hs extension.

diff --git a/ghcide/src/Development/IDE/Core/Dependencies.hs b/ghcide/src/Development/IDE/Core/Dependencies.hs
@@ -22,6 +22,7 @@ import           HieDb                          (SourceFile (FakeFile),
                                                  lookupPackage,
                                                  removeDependencySrcFiles)
 import           Ide.Logger                     (Recorder, WithPriority)
+import           Ide.Types                      (hlsDirectory)
 import           Language.LSP.Server            (resRootPath)
 import           System.Directory               (doesDirectoryExist)
 import           System.FilePath                ((<.>), (</>))
@@ -46,7 +47,7 @@ indexDependencyHieFiles recorder se hscEnv = do
         mHlsDir :: Maybe FilePath
         mHlsDir = do
             projectDir <- resRootPath =<< lspEnv se
-            pure $ projectDir </> ".hls"
+            pure $ projectDir </> hlsDirectory
         -- Add the deletion of dependency source files from the
         -- HieDb database to the database write queue.
         deleteMissingDependencySources :: IO ()

diff --git a/hls-plugin-api/src/Ide/Types.hs b/hls-plugin-api/src/Ide/Types.hs
@@ -47,6 +47,8 @@ module Ide.Types
 , PluginNotificationHandlers(..)
 , PluginRequestMethod(..)
 , SourceFileOrigin(..)
+, dependenciesDirectory
+, hlsDirectory
 , getSourceFileOrigin
 , getProcessID, getPid
 , installSigUsr1Handler
@@ -296,13 +298,19 @@ data PluginFileType = PluginFileType [SourceFileOrigin] [T.Text]
 
 data SourceFileOrigin = FromProject | FromDependency deriving Eq
 
+hlsDirectory :: FilePath
+hlsDirectory = ".hls"
+
+dependenciesDirectory :: FilePath
+dependenciesDirectory = "dependencies"
+
 -- | Dependency files are written to the .hls/dependencies directory
 --   under the project root.
 --   If a file is not in this directory, we assume that it is a
 --   project file.
 getSourceFileOrigin :: NormalizedFilePath -> SourceFileOrigin
 getSourceFileOrigin f =
-    case [".hls", "dependencies"] `isInfixOf` (splitDirectories file) of
+    case [hlsDirectory, dependenciesDirectory] `isInfixOf` (splitDirectories file) of
         True  -> FromDependency
         False -> FromProject
     where