doc and tests

Author: JPMoresmau

hie-ghc-mod/Haskell/Ide/GhcModPlugin.hs

@@ -85,13 +85,15 @@ checkCmd = CmdSync $ \_ctxs req -> do
 
 -- ---------------------------------------------------------------------
 
+-- | Runs the find command from the given directory, for the given symbol
 findCmd :: CommandFunc ModuleList
 findCmd = CmdSync $ \_ctxs req -> do
   case getParams (IdFile "dir" :& IdText "symbol" :& RNil) req of
     Left err -> return err
     Right (ParamFile dirName :& ParamText symbol :& RNil) -> do
       runGhcModCommand (T.pack (T.unpack dirName </> "dummy")) (\_->
           do
+            -- adapted from ghc-mod find command, which launches the executable again
             tmpdir <- GM.cradleTempDir <$> GM.cradle
             sf <- takeWhile (`notElem` ['\r','\n']) <$> GM.dumpSymbol tmpdir
             db <- M.fromAscList . map conv . lines <$> liftIO (readFile sf)

hie-plugin-api/Haskell/Ide/Engine/PluginDescriptor.hs

@@ -234,11 +234,12 @@ contextMapping CtxFile        = [fileParam]
 contextMapping CtxPoint       = [fileParam,startPosParam]
 contextMapping CtxRegion      = [fileParam,startPosParam,endPosParam]
 contextMapping CtxCabalTarget = [cabalParam]
-contextMapping CtxProject     = [dirParam]
+contextMapping CtxProject     = [dirParam] -- the root directory of the project
 
 fileParam :: ParamDescription
 fileParam = RP "file" "a file name" PtFile
 
+-- | A parameter for a directory
 dirParam :: ParamDescription
 dirParam = RP "dir" "a directory name" PtFile
 

test/DispatcherSpec.hs

@@ -105,7 +105,7 @@ dispatcherSpec = do
     it "identifies CtxProject" $ do
       chan <- atomically newTChan
       chSync <- atomically newTChan
-      let req = IdeRequest "cmd6" (Map.fromList [])
+      let req = IdeRequest "cmd6" (Map.fromList [("dir", ParamFileP ".")])
           cr = CReq "test" 1 req chan
       r <- withStdoutLogging $ runIdeM (IdeState Map.empty) (doDispatch (testPlugins chSync) cr)
       r `shouldBe` Just (IdeResponseOk (H.fromList ["ok" .= ("result:ctxs=[CtxProject]"::String)]))

test/GhcModPluginSpec.hs

@@ -69,10 +69,10 @@ ghcmodSpec = do
     -- ---------------------------------
 
     it "runs the find command" $ do
-      let req = IdeRequest "find" (Map.fromList [("symbol", ParamTextP "map")])
+      let req = IdeRequest "find" (Map.fromList [("dir", ParamFileP "."),("symbol", ParamTextP "Show")])
       r <- dispatchRequest req
-      r `shouldBe` Just (IdeResponseOk (H.fromList ["ok" .= ("Placholder:Need to debug this in ghc-mod, returns 'does not exist (No such file or directory)'"::String)]))
-      pendingWith "need to debug in ghc-mod"
+      r `shouldBe` Just (IdeResponseOk (H.fromList ["modules" .= ["GHC.Show"::String,"Prelude","Test.Hspec.Discover","Text.Show"]]))
+
 
     -- ---------------------------------