Make src dirs a configurable option for users (#25)

Allow for passing in possible source directory roots as arguments.

For projects that use different source directories this can improve the
hie file lookup if hiedb with `--src-base-dirs` is not available.

app/App/Arguments.hs

@@ -4,6 +4,7 @@ import Options.Applicative
 import StaticLS.StaticEnv.Options
 import System.Environment
 import System.Exit
+import Text.Parsec hiding (many, option)
 
 data PrgOptions = PrgOptions
     { staticEnvOpts :: StaticEnvOptions
@@ -69,3 +70,13 @@ staticEnvOptParser =
                 <> help "Path to hiefiles generated by -fwrite-ide-info"
                 <> showDefault
             )
+        <*> listOption
+            ( long "srcDirs"
+                <> metavar "TARGET1,TARGET2,TARGET3..."
+                <> value defaultSrcDirs
+                <> help "Path to directories containing source code. Comma delimited strings"
+                <> showDefault
+            )
+  where
+    -- Parse a list of comma delimited strings
+    listOption = option $ eitherReader (either (Left . show) Right . runParser (sepEndBy (many alphaNum) (char ',')) () "")

package.yaml

@@ -29,11 +29,12 @@ dependencies:
   - filepath >= 1.4.1 && < 1.5
   - ghc >= 9.4.4 && < 9.7
   - ghc-paths >= 0.1.0 && < 0.2
-  - ghcide >= 1.9.1 && < 2.1.0
+  - ghcide >= 1.9.1 && < 2.5.0
   - hiedb >= 0.4.2 && < 0.5
   - lsp >= 1.6.0 && < 1.7
   - lsp-types >= 1.6.0 && < 1.7
   - mtl >= 2.2.2 && < 2.4
+  - parsec >= 3.1.0 && < 3.2
   - sqlite-simple >= 0.4.18 && < 0.5
   - template-haskell >= 2.19.0 && < 2.21
   - text >= 2.0.1 && < 2.1

src/StaticLS/HIE/File.hs

@@ -113,17 +113,13 @@ modToHieFilePath modName =
         runMaybeT $ do
             Right unitId <- liftIO (HieDb.resolveUnitId hieDb modName)
             Just hieModRow <- liftIO $ HieDb.lookupHieFile hieDb modName unitId
-            pure $ hieModRow.hieModuleHieFile
+            pure hieModRow.hieModuleHieFile
 
 -----------------------------------------------------------------------------------
 -- File/Directory method for getting hie files - faster but somewhat "hacky"
 -- Useful as a fallback
 -----------------------------------------------------------------------------------
 
--- TODO: make this configurable (use cabal?)
-srcDirs :: [FilePath]
-srcDirs = ["src/", "lib/", "app/", "test/"]
-
 hieFilePathToSrcFilePathFromFile :: (HasStaticEnv m, MonadIO m) => HieFilePath -> MaybeT m SrcFilePath
 hieFilePathToSrcFilePathFromFile hiePath = do
     hieFile <- exceptToMaybeT $ getHieFile hiePath
@@ -143,7 +139,7 @@ srcFilePathToHieFilePathFromFile srcPath = do
     absoluteRoot <- liftIO $ Dir.makeAbsolute staticEnv.wsRoot
     let hieDir = staticEnv.hieFilesPath
         absoluteHieDir = absoluteRoot </> hieDir
-        absoluteSrcDirs = (absoluteRoot </>) <$> srcDirs
+        absoluteSrcDirs = (absoluteRoot </>) <$> staticEnv.srcDirs
     absoluteSrcPath <- liftIO $ Dir.makeAbsolute srcPath
 
     -- Drop all src directory prefixes

src/StaticLS/StaticEnv.hs

@@ -22,9 +22,6 @@ import Control.Monad.Trans.Except (ExceptT (..))
 import Control.Monad.Trans.Maybe (MaybeT (..), exceptToMaybeT)
 import Control.Monad.Trans.Reader (ReaderT (..))
 import Database.SQLite.Simple (SQLError)
-import qualified GHC
-import qualified GHC.Paths as GHC
-import qualified GHC.Types.Name.Cache as GHC
 import qualified HieDb
 import StaticLS.StaticEnv.Options (StaticEnvOptions (..))
 import System.FilePath ((</>))
@@ -51,7 +48,10 @@ data StaticEnv = StaticEnv
     , hieFilesPath :: HieFilePath
     , wsRoot :: FilePath
     -- ^ workspace root
+    , srcDirs :: [FilePath]
+    -- ^ directories to search for source code in order of priority
     }
+    deriving (Eq, Show)
 
 type StaticLs = ReaderT StaticEnv IO
 
@@ -65,13 +65,16 @@ initStaticEnv wsRoot staticEnvOptions =
     do
         let databasePath = fmap (wsRoot </>) (Just staticEnvOptions.optionHieDbPath)
             hieFilesPath = wsRoot </> staticEnvOptions.optionHieFilesPath
+            srcDirs = fmap (wsRoot </>) staticEnvOptions.optionSrcDirs
 
         let serverStaticEnv =
                 StaticEnv
                     { hieDbPath = databasePath
                     , hieFilesPath = hieFilesPath
                     , wsRoot = wsRoot
+                    , srcDirs = srcDirs
                     }
+
         pure serverStaticEnv
 
 -- | Run an hiedb action in an exceptT

src/StaticLS/StaticEnv/Options.hs

@@ -2,6 +2,7 @@ module StaticLS.StaticEnv.Options (
     defaultStaticEnvOptions,
     defaultHieDb,
     defaultHieFiles,
+    defaultSrcDirs,
     StaticEnvOptions (..),
 )
 where
@@ -13,17 +14,23 @@ data StaticEnvOptions = StaticEnvOptions
     , optionHieFilesPath :: FilePath
     -- ^ Relative path to hie files directory
     -- hie files are required for all functionality
+    , optionSrcDirs :: [FilePath]
     }
+    deriving (Show, Eq)
 
 defaultHieDb :: FilePath
 defaultHieDb = ".hiedb"
 
 defaultHieFiles :: FilePath
 defaultHieFiles = ".hiefiles"
 
+defaultSrcDirs :: [FilePath]
+defaultSrcDirs = ["src/", "lib/", "app/", "test/"]
+
 defaultStaticEnvOptions :: StaticEnvOptions
 defaultStaticEnvOptions =
     StaticEnvOptions
         { optionHieDbPath = defaultHieDb
         , optionHieFilesPath = defaultHieFiles
+        , optionSrcDirs = defaultSrcDirs
         }

static-ls.cabal

@@ -1,6 +1,6 @@
 cabal-version: 1.12
 
--- This file has been generated from package.yaml by hpack version 0.35.5.
+-- This file has been generated from package.yaml by hpack version 0.36.0.
 --
 -- see: https://github.com/sol/hpack
 
@@ -69,11 +69,12 @@ library
     , filepath >=1.4.1 && <1.5
     , ghc >=9.4.4 && <9.7
     , ghc-paths >=0.1.0 && <0.2
-    , ghcide >=1.9.1 && <2.1.0
+    , ghcide >=1.9.1 && <2.5.0
     , hiedb >=0.4.2 && <0.5
     , lsp >=1.6.0 && <1.7
     , lsp-types >=1.6.0 && <1.7
     , mtl >=2.2.2 && <2.4
+    , parsec >=3.1.0 && <3.2
     , sqlite-simple >=0.4.18 && <0.5
     , template-haskell >=2.19.0 && <2.21
     , text >=2.0.1 && <2.1
@@ -107,12 +108,13 @@ executable static-ls
     , filepath >=1.4.1 && <1.5
     , ghc >=9.4.4 && <9.7
     , ghc-paths >=0.1.0 && <0.2
-    , ghcide >=1.9.1 && <2.1.0
+    , ghcide >=1.9.1 && <2.5.0
     , hiedb >=0.4.2 && <0.5
     , lsp >=1.6.0 && <1.7
     , lsp-types >=1.6.0 && <1.7
     , mtl >=2.2.2 && <2.4
     , optparse-applicative >=0.17.0.0 && <0.19
+    , parsec >=3.1.0 && <3.2
     , sqlite-simple >=0.4.18 && <0.5
     , static-ls
     , template-haskell >=2.19.0 && <2.21
@@ -158,12 +160,13 @@ test-suite static-ls-test
     , filepath >=1.4.1 && <1.5
     , ghc >=9.4.4 && <9.7
     , ghc-paths >=0.1.0 && <0.2
-    , ghcide >=1.9.1 && <2.1.0
+    , ghcide >=1.9.1 && <2.5.0
     , hiedb >=0.4.2 && <0.5
     , hspec ==2.*
     , lsp >=1.6.0 && <1.7
     , lsp-types >=1.6.0 && <1.7
     , mtl >=2.2.2 && <2.4
+    , parsec >=3.1.0 && <3.2
     , sqlite-simple >=0.4.18 && <0.5
     , static-ls
     , template-haskell >=2.19.0 && <2.21

test/StaticLS/HIE/FileSpec.hs

@@ -54,6 +54,7 @@ spec = do
                     StaticEnvOptions
                         { optionHieDbPath = ""
                         , optionHieFilesPath = ""
+                        , optionSrcDirs = []
                         }
             staticEnv <- Test.initStaticEnvOpts emptyOpts
             hieFile <-
@@ -68,6 +69,7 @@ spec = do
                     StaticEnvOptions
                         { optionHieDbPath = ""
                         , optionHieFilesPath = ""
+                        , optionSrcDirs = []
                         }
             staticEnv <- Test.initStaticEnvOpts emptyOpts
             hieFile <-

test/StaticLS/IDE/DefinitionSpec.hs

@@ -26,6 +26,7 @@ spec =
                             StaticEnvOptions
                                 { optionHieDbPath = ""
                                 , optionHieFilesPath = "test/TestData/.hiefiles"
+                                , optionSrcDirs = defaultSrcDirs
                                 }
                     staticEnv <- Test.initStaticEnvOpts emptyOpts
                     locs <- runStaticLs staticEnv $ uncurry getDefinition Test.myFunRef1TdiAndPosition
@@ -38,6 +39,7 @@ spec =
                             StaticEnvOptions
                                 { optionHieDbPath = "./TestData/not-a-real-hiedb-file"
                                 , optionHieFilesPath = "test/TestData/.hiefiles"
+                                , optionSrcDirs = defaultSrcDirs
                                 }
                     staticEnv <- Test.initStaticEnvOpts emptyOpts
                     locs <- runStaticLs staticEnv $ uncurry getDefinition Test.myFunRef1TdiAndPosition
@@ -50,6 +52,7 @@ spec =
                         StaticEnvOptions
                             { optionHieDbPath = ""
                             , optionHieFilesPath = ""
+                            , optionSrcDirs = []
                             }
                 staticEnv <- Test.initStaticEnvOpts emptyOpts
                 locs <- runStaticLs staticEnv $ uncurry getDefinition Test.myFunRef1TdiAndPosition

test/TestImport.hs

@@ -15,11 +15,15 @@ testHieDir = "test/TestData/.hiefiles"
 testHieDbDir :: FilePath
 testHieDbDir = "test/TestData/.hiedb"
 
+testSrcDirs :: [FilePath]
+testSrcDirs = StaticEnv.defaultSrcDirs
+
 defaultTestStaticEnvOptions :: StaticEnvOptions
 defaultTestStaticEnvOptions =
     StaticEnvOptions
         { optionHieDbPath = testHieDbDir
         , optionHieFilesPath = testHieDir
+        , optionSrcDirs = testSrcDirs
         }
 
 initStaticEnvOpts :: StaticEnvOptions -> IO StaticEnv