delete commented code, update documentation

Author: rm41339

plugins/hls-cabal-project-plugin/src/Ide/Plugin/CabalProject.hs

@@ -140,7 +140,7 @@ descriptor recorder plId =
   whenUriFile :: Uri -> (NormalizedFilePath -> IO ()) -> IO ()
   whenUriFile uri act = whenJust (uriToFilePath uri) $ act . toNormalizedFilePath'
 
-{- | Helper function to restart the shake session, specifically for modifying .cabal files.
+{- | Helper function to restart the shake session, specifically for modifying cabal.project files.
 No special logic, just group up a bunch of functions you need for the base
 Notification Handlers.
 
@@ -158,9 +158,9 @@ restartCabalShakeSession shakeExtras vfs file actionMsg actionBetweenSession = d
 
 cabalRules :: Recorder (WithPriority Log) -> PluginId -> Rules ()
 cabalRules recorder plId = do
-  -- Make sure we initialise the cabal files-of-interest.
+  -- Make sure we initialise the cabal project files-of-interest.
   ofInterestRules recorder
-  -- Rule to produce diagnostics for cabal files.
+  -- Rule to produce diagnostics for cabal project files.
   define (cmapWithPrio LogShake recorder) $ \ParseCabalProjectFields file -> do
     config <- getPluginConfigAction plId
     if not (plcGlobalOn config && plcDiagnosticsOn config)
@@ -210,29 +210,28 @@ cabalRules recorder plId = do
             pure (warnDiags, Just projCfg)
 
   action $ do
-    -- Run the cabal kick. This code always runs when 'shakeRestart' is run.
+    -- Run the cabal project kick. This code always runs when 'shakeRestart' is run.
     -- Must be careful to not impede the performance too much. Crucial to
     -- a snappy IDE experience.
     kick
  where
   log' = logWith recorder
 
-{- | This is the kick function for the cabal plugin.
+{- | This is the kick function for the cabal project plugin.
 We run this action, whenever we shake session us run/restarted, which triggers
-actions to produce diagnostics for cabal files.
+actions to produce diagnostics for cabal project files.
 
 It is paramount that this kick-function can be run quickly, since it is a blocking
 function invocation.
 -}
 kick :: Action ()
 kick = do
   files <- HashMap.keys <$> getCabalFilesOfInterestUntracked
---   let keys = map Types.ParseCabalProjectFile files
   Shake.runWithSignal (Proxy @"kick/start/cabal-project") (Proxy @"kick/done/cabal-project") files Types.ParseCabalProjectFile
 
 
 -- ----------------------------------------------------------------
--- Cabal file of Interest rules and global variable
+-- Cabal project file of Interest rules and global variable
 -- ----------------------------------------------------------------
 
 {- | Cabal files that are currently open in the lsp-client.

plugins/hls-cabal-project-plugin/src/Ide/Plugin/CabalProject/Diagnostics.hs

@@ -30,19 +30,19 @@ import           Language.LSP.Protocol.Types       (Diagnostic (..),
                                                     Range (Range),
                                                     fromNormalizedFilePath)
 
--- | Produce a diagnostic for a fatal Cabal parser error.
+-- | Produce a diagnostic for a fatal Cabal Project parser error.
 fatalParseErrorDiagnostic :: NormalizedFilePath -> T.Text -> FileDiagnostic
 fatalParseErrorDiagnostic fp msg =
   mkDiag fp "cabal-project" DiagnosticSeverity_Error (toBeginningOfNextLine Syntax.zeroPos) msg
 
--- | Produce a diagnostic from a Cabal parser error
+-- | Produce a diagnostic from a Cabal Project parser error
 errorDiagnostic :: NormalizedFilePath -> Syntax.PError -> FileDiagnostic
 errorDiagnostic fp err@(Syntax.PError pos _) =
   mkDiag fp "cabal-project" DiagnosticSeverity_Error (toBeginningOfNextLine pos) msg
   where
     msg = T.pack $ showPError (fromNormalizedFilePath fp) err
 
--- | Produce a diagnostic from a Cabal parser warning
+-- | Produce a diagnostic from a Cabal Project parser warning
 warningDiagnostic :: NormalizedFilePath -> Syntax.PWarning -> FileDiagnostic
 warningDiagnostic fp warning@(Syntax.PWarning _ pos _) =
   mkDiag fp "cabal-project" DiagnosticSeverity_Warning (toBeginningOfNextLine pos) msg

plugins/hls-cabal-project-plugin/src/Ide/Plugin/CabalProject/Parse.hs

@@ -40,9 +40,7 @@ parseCabalProjectFileContents
          , Either (Maybe Version, NonEmpty PError) ProjectConfigSkeleton)
 parseCabalProjectFileContents fp bytes = do
   cacheDir <- getCabalProjectCacheDir fp
---   bytes <- BS.readFile fp
   let toParse = ProjectConfigToParse bytes
-    --   rootDir = takeDirectory fp
       verb    = normal
   httpTransport <- configureTransport verb [fp] Nothing
 

plugins/hls-cabal-project-plugin/src/Ide/Plugin/CabalProject/Types.hs

@@ -10,8 +10,6 @@ import           Distribution.Client.ProjectConfig.Parsec (ProjectConfigSkeleton
 import qualified Distribution.Fields                      as Syntax
 import qualified Distribution.Parsec.Position             as Syntax
 import           GHC.Generics                             (Generic)
--- import Ide.Plugin.Cabal.Completion.Types
-
 
 type instance RuleResult ParseCabalProjectFile = ProjectConfigSkeleton