DRAFT: Completions for cabal.project files, hls-cabal-project-plugin

.gitmodules

@@ -8,3 +8,7 @@
 #     Commit git commit -m "Removed submodule <name>"
 #     Delete the now untracked submodule files
 #     rm -rf path_to_submodule
+
+[submodule "vendor/cabal"]
+	path = vendor/cabal
+	url = https://github.com/rm41339/cabal.git

cabal.project

@@ -6,7 +6,16 @@ packages:
          ./ghcide
          ./hls-plugin-api
          ./hls-test-utils
+         ./vendor/cabal/Cabal
+         ./vendor/cabal/Cabal-syntax
+         ./vendor/cabal/cabal-install
+         ./vendor/cabal/cabal-install-solver
+         ./vendor/cabal/Cabal-described
+         ./vendor/cabal/Cabal-tree-diff
 
+package cabal-install
+  tests: False
+  benchmarks: False
 
 index-state: 2025-05-12T13:26:29Z
 

haskell-language-server.cabal

@@ -317,6 +317,91 @@ test-suite hls-cabal-plugin-tests
     , text
     , hls-plugin-api
 
+-----------------------------
+-- cabal project plugin
+-----------------------------
+
+flag cabalProject
+  description: Enable cabalProject plugin
+  default:     True
+  manual:      True
+
+common cabalProject
+  if flag(cabalProject)
+    build-depends: haskell-language-server:hls-cabal-project-plugin
+    cpp-options: -Dhls_cabal_project
+
+library hls-cabal-project-plugin
+  import:           defaults, pedantic, warnings
+  if !flag(cabalProject)
+    buildable: False
+  exposed-modules:
+    Ide.Plugin.CabalProject
+    Ide.Plugin.CabalProject.Parse
+    Ide.Plugin.CabalProject.Diagnostics
+    Ide.Plugin.CabalProject.Types
+    Ide.Plugin.CabalProject.Completion.Completions
+    Ide.Plugin.CabalProject.Completion.Data
+    Ide.Plugin.CabalProject.Completion.Completer.Types
+
+  build-depends:
+    , bytestring
+    , Cabal-syntax          >= 3.7
+    , containers
+    , deepseq
+    , directory
+    , filepath
+    , extra                 >=1.7.4
+    , ghcide                == 2.11.0.0
+    , hashable
+    , hls-plugin-api        == 2.11.0.0
+    , hls-graph             == 2.11.0.0
+    , lens
+    , lsp                   ^>=2.7
+    , lsp-types             ^>=2.3
+    , regex-tdfa            ^>=1.3.1
+    , text
+    , text-rope
+    , transformers
+    , unordered-containers  >=0.2.10.0
+    , containers
+    , process
+    , aeson
+    , Cabal
+    , pretty
+    , cabal-install
+    , cabal-install-solver
+    , haskell-language-server:hls-cabal-plugin
+    , base16-bytestring
+    , cryptohash-sha1
+
+  hs-source-dirs:   plugins/hls-cabal-project-plugin/src
+
+test-suite hls-cabal-project-plugin-tests
+  import:           defaults, pedantic, test-defaults, warnings
+  if !flag(cabalProject)
+    buildable: False
+  type:             exitcode-stdio-1.0
+  hs-source-dirs:   plugins/hls-cabal-project-plugin/test
+  main-is:          Main.hs
+  other-modules:
+    Completer
+    Utils
+  build-depends:
+    , bytestring
+    , Cabal-syntax          >= 3.7
+    , extra
+    , filepath
+    , ghcide
+    , haskell-language-server:hls-cabal-project-plugin
+    , hls-test-utils    == 2.11.0.0
+    , lens
+    , lsp-types
+    , text
+    , hls-plugin-api
+    , cabal-install
+    , haskell-language-server:hls-cabal-plugin
+
 -----------------------------
 -- class plugin
 -----------------------------
@@ -1830,6 +1915,7 @@ library
                   , pedantic
                   -- plugins
                   , cabal
+                  , cabalProject
                   , callHierarchy
                   , cabalfmt
                   , cabalgild

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

@@ -14,7 +14,7 @@
 {-# LANGUAGE UndecidableInstances  #-}
 {-# LANGUAGE ViewPatterns          #-}
 module Ide.Types
-( PluginDescriptor(..), defaultPluginDescriptor, defaultCabalPluginDescriptor
+( PluginDescriptor(..), defaultPluginDescriptor, defaultCabalPluginDescriptor, defaultCabalProjectPluginDescriptor
 , defaultPluginPriority
 , describePlugin
 , IdeCommand(..)
@@ -1077,6 +1077,21 @@ defaultCabalPluginDescriptor plId desc =
     Nothing
     [".cabal"]
 
+defaultCabalProjectPluginDescriptor :: PluginId -> T.Text -> PluginDescriptor ideState
+defaultCabalProjectPluginDescriptor plId desc =
+  PluginDescriptor
+    plId
+    desc
+    defaultPluginPriority
+    mempty
+    mempty
+    mempty
+    defaultConfigDescriptor
+    mempty
+    mempty
+    Nothing
+    [".project"]
+
 newtype CommandId = CommandId T.Text
   deriving (Show, Read, Eq, Ord)
 instance IsString CommandId where

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Completer/FilePath.hs

@@ -21,9 +21,9 @@ import qualified Text.Fuzzy.Parallel                          as Fuzzy
 
 -- | Completer to be used when a file path can be completed for a field.
 --  Completes file paths as well as directories.
-filePathCompleter :: Completer
+filePathCompleter :: HasPrefixInfo d => Completer d
 filePathCompleter recorder cData = do
-  let prefInfo = cabalPrefixInfo cData
+  let prefInfo = getPrefixInfo cData
       complInfo = pathCompletionInfoFromCabalPrefixInfo "" prefInfo
   filePathCompletions <- listFileCompletions recorder complInfo
   let scored =
@@ -40,7 +40,7 @@ filePathCompleter recorder cData = do
         pure $ mkCompletionItem (completionRange prefInfo) fullFilePath fullFilePath
     )
 
-mainIsCompleter :: (Maybe StanzaName -> GenericPackageDescription -> [FilePath]) -> Completer
+mainIsCompleter :: (Maybe StanzaName -> GenericPackageDescription -> [FilePath]) -> CabalCompleter
 mainIsCompleter extractionFunction recorder cData = do
   mGPD <- getLatestGPD cData
   case mGPD of
@@ -74,9 +74,9 @@ mainIsCompleter extractionFunction recorder cData = do
 
 -- | Completer to be used when a directory can be completed for the field.
 --  Only completes directories.
-directoryCompleter :: Completer
+directoryCompleter :: HasPrefixInfo d => Completer d
 directoryCompleter recorder cData = do
-  let prefInfo = cabalPrefixInfo cData
+  let prefInfo = getPrefixInfo cData
       complInfo = pathCompletionInfoFromCabalPrefixInfo "" prefInfo
   directoryCompletions <- listDirectoryCompletions recorder complInfo
   let scored =

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Completer/Module.hs

@@ -27,7 +27,7 @@ import qualified Text.Fuzzy.Parallel                            as Fuzzy
 --
 -- Takes an extraction function which extracts the source directories
 -- to be used by the completer.
-modulesCompleter :: (Maybe StanzaName -> GenericPackageDescription -> [FilePath]) -> Completer
+modulesCompleter :: (Maybe StanzaName -> GenericPackageDescription -> [FilePath]) -> CabalCompleter
 modulesCompleter extractionFunction recorder cData = do
   mGPD <- getLatestGPD cData
   case mGPD of

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Completer/Simple.hs

@@ -26,21 +26,21 @@ import qualified Text.Fuzzy.Parallel                         as Fuzzy
 
 -- | Completer to be used when no completion suggestions
 --  are implemented for the field
-noopCompleter :: Completer
+noopCompleter :: Completer d
 noopCompleter _ _ = pure []
 
 -- | Completer to be used when no completion suggestions
 --  are implemented for the field and a log message should be emitted.
-errorNoopCompleter :: Log -> Completer
+errorNoopCompleter :: Log -> Completer d
 errorNoopCompleter l recorder _ = do
   logWith recorder Warning l
   pure []
 
 -- | Completer to be used when a simple set of values
 --  can be completed for a field.
-constantCompleter :: [T.Text] -> Completer
+constantCompleter :: [T.Text] -> HasPrefixInfo d => Completer d
 constantCompleter completions _ cData = do
-  let prefInfo = cabalPrefixInfo cData
+  let prefInfo = getPrefixInfo cData
       scored = Fuzzy.simpleFilter Fuzzy.defChunkSize Fuzzy.defMaxResults (completionPrefix prefInfo) completions
       range = completionRange prefInfo
   pure $ map (mkSimpleCompletionItem range . Fuzzy.original) scored
@@ -49,7 +49,7 @@ constantCompleter completions _ cData = do
 --
 -- TODO: Does not exclude imports, defined after the current cursor position
 -- which are not allowed according to the cabal specification
-importCompleter :: Completer
+importCompleter :: CabalCompleter
 importCompleter l cData = do
   cabalCommonsM <- getCabalCommonSections cData
   case cabalCommonsM of
@@ -66,7 +66,7 @@ importCompleter l cData = do
 -- This is almost always the name of the cabal file. However,
 -- it is not forbidden by the specification to have a different name,
 -- it is just forbidden on hackage.
-nameCompleter :: Completer
+nameCompleter :: CabalCompleter
 nameCompleter _ cData = do
   let scored = Fuzzy.simpleFilter Fuzzy.defChunkSize Fuzzy.defMaxResults (completionPrefix prefInfo) [completionFileName prefInfo]
       prefInfo = cabalPrefixInfo cData
@@ -80,7 +80,7 @@ nameCompleter _ cData = do
 --  the value in the completion suggestion.
 --
 --  If the value does not occur in the weighted map its weight is defaulted to zero.
-weightedConstantCompleter :: [T.Text] -> Map T.Text Double -> Completer
+weightedConstantCompleter :: [T.Text] -> Map T.Text Double -> CabalCompleter
 weightedConstantCompleter completions weights _ cData = do
   let scored =
         if perfectScore > 0

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Completer/Snippet.hs

@@ -18,7 +18,7 @@ import qualified Language.LSP.Protocol.Types                  as LSP
 import qualified Text.Fuzzy.Parallel                          as Fuzzy
 
 -- | Maps snippet triggerwords with their completers
-snippetCompleter :: Completer
+snippetCompleter :: CabalCompleter
 snippetCompleter recorder cData = do
   let scored = Fuzzy.simpleFilter Fuzzy.defChunkSize Fuzzy.defMaxResults (completionPrefix prefInfo) $ Map.keys snippets
   mapMaybeM

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Completer/Types.hs

@@ -9,9 +9,12 @@ import qualified Distribution.Parsec.Position      as Syntax
 import           Ide.Plugin.Cabal.Completion.Types
 import           Language.LSP.Protocol.Types       (CompletionItem)
 
--- | Takes information needed to build possible completion items
+-- | Takes information and completer type needed to build possible completion items
 -- and returns the list of possible completion items
-type Completer = Recorder (WithPriority Log) -> CompleterData -> IO [CompletionItem]
+type Completer d = Recorder (WithPriority Log) -> d -> IO [CompletionItem]
+
+-- Cabal specific completer
+type CabalCompleter = Completer CompleterData
 
 -- | Contains information to be used by completers.
 data CompleterData = CompleterData
@@ -26,3 +29,10 @@ data CompleterData = CompleterData
     -- | The name of the stanza in which the completer is applied
     stanzaName             :: Maybe StanzaName
   }
+
+-- Allows CabalCompleter and CabalProjectCompleter to be passed into the same completers
+class HasPrefixInfo d where
+  getPrefixInfo :: d -> CabalPrefixInfo
+
+instance HasPrefixInfo CompleterData where
+  getPrefixInfo = cabalPrefixInfo

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Completions.hs

@@ -15,7 +15,7 @@ import qualified Distribution.Parsec.Position                  as Syntax
 import           Ide.Plugin.Cabal.Completion.CabalFields
 import           Ide.Plugin.Cabal.Completion.Completer.Simple
 import           Ide.Plugin.Cabal.Completion.Completer.Snippet
-import           Ide.Plugin.Cabal.Completion.Completer.Types   (Completer)
+import           Ide.Plugin.Cabal.Completion.Completer.Types   (CabalCompleter)
 import           Ide.Plugin.Cabal.Completion.Data
 import           Ide.Plugin.Cabal.Completion.Types
 import qualified Language.LSP.Protocol.Lens                    as JL
@@ -28,7 +28,7 @@ import           System.FilePath                               (takeBaseName)
 
 -- | Takes information about the completion context within the file
 --  and finds the correct completer to be applied.
-contextToCompleter :: Context -> Completer
+contextToCompleter :: Context -> CabalCompleter
 -- if we are in the top level of the cabal file and not in a keyword context,
 -- we can write any top level keywords or a stanza declaration
 contextToCompleter (TopLevel, None) =