fix documentation/typos

Author: rm41339

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

@@ -65,9 +65,6 @@ descriptor :: Recorder (WithPriority Log) -> PluginId -> PluginDescriptor IdeSta
 descriptor recorder plId =
   (defaultCabalProjectPluginDescriptor plId "Provides a variety of IDE features in cabal.project files")
     { pluginRules = cabalProjectRules recorder plId
-    , pluginHandlers =
-        mconcat
-          []
     , pluginNotificationHandlers =
         mconcat
           [ mkPluginNotificationHandler LSP.SMethod_TextDocumentDidOpen $
@@ -123,9 +120,9 @@ restartCabalProjectShakeSession shakeExtras vfs file actionMsg actionBetweenSess
 
 cabalProjectRules :: Recorder (WithPriority Log) -> PluginId -> Rules ()
 cabalProjectRules recorder plId = do
-  -- Make sure we initialise the cabal project files-of-interest.
+  -- Make sure we initialise the cabal.project files-of-interest.
   ofInterestRules recorder
-  -- Rule to produce diagnostics for cabal project 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)
@@ -175,16 +172,16 @@ cabalProjectRules recorder plId = do
             pure (warnDiags, Just projCfg)
 
   action $ do
-    -- Run the cabal project 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 project plugin.
-We run this action, whenever we shake session us run/restarted, which triggers
-actions to produce diagnostics for cabal project files.
+{- | This is the kick function for the cabal.project plugin.
+We run this action, whenever a shake session is run/restarted, which triggers
+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.
@@ -196,10 +193,10 @@ kick = do
 
 
 -- ----------------------------------------------------------------
--- Cabal project file of Interest rules and global variable
+-- Cabal.project file of Interest rules and global variable
 -- ----------------------------------------------------------------
 
-{- | Cabal project files that are currently open in the lsp-client.
+{- | Cabal.project files that are currently open in the lsp-client.
 Specific actions happen when these files are saved, closed or modified,
 such as generating diagnostics, re-parsing, etc...
 

plugins/hls-cabal-project-plugin/test/Main.hs

@@ -33,7 +33,7 @@ main :: IO ()
 main = do
     defaultTestRunner $
         testGroup
-            "Cabal Plugin Tests"
+            "Cabal.project Plugin Tests"
             [ unitTests
             , pluginTests
             ]
@@ -52,7 +52,7 @@ unitTests =
 cabalProjectParserUnitTests :: TestTree
 cabalProjectParserUnitTests =
     testGroup
-        "Parsing Cabal Project"
+        "Parsing Cabal.project"
         [ testCase "Simple Parsing works" $ do
             let fp    = testDataDir </> "cabal.project"
             bytes <- BS.readFile fp

plugins/hls-cabal-project-plugin/test/Utils.hs

@@ -31,8 +31,8 @@ runCabalProjectGoldenSession title subdir fp act = goldenWithCabalDoc def cabalP
 testDataDir :: FilePath
 testDataDir = "plugins" </> "hls-cabal-project-plugin" </> "test" </> "testdata"
 
--- | these functions are used to detect cabal kicks
--- and look at diagnostics for cabal files
+-- | these functions are used to detect cabal.project kicks
+-- and look at diagnostics for cabal.project files
 -- kicks are run everytime there is a shake session run/restart
 cabalProjectKickDone :: Session ()
 cabalProjectKickDone = kick (Proxy @"kick/done/cabal-project") >>= guard . not . null
@@ -42,7 +42,3 @@ cabalProjectKickStart = kick (Proxy @"kick/start/cabal-project") >>= guard . not
 
 cabalProjectCaptureKick :: Session [Diagnostic]
 cabalProjectCaptureKick = captureKickDiagnostics cabalProjectKickStart cabalProjectKickDone
-
--- | list comparison where the order in the list is irrelevant
-(@?==) :: (HasCallStack, Ord a, Show a) => [a] -> [a] -> Assertion
-(@?==) l1 l2 = sort l1 @?= sort l2