Update code action title and comment template

Author: berberman

plugins/hls-haddock-comments-plugin/src/Ide/Plugin/HaddockComments.hs

@@ -41,7 +41,7 @@ codeActionProvider _lspFuncs ideState _pId (TextDocumentIdentifier uri) range Co
     let locDecls = hsmodDecls . unLoc . pm_parsed_source <$> pm
         anns = relativiseApiAnns <$> (pm_parsed_source <$> pm) <*> (pm_annotations <$> pm)
         edits = [runGenComments gen locDecls anns range | noErr, gen <- genList]
-    return $ Right $ List [CACodeAction $ toAction "Generate haddock comments" uri edit | (Just edit) <- edits]
+    return $ Right $ List [CACodeAction $ toAction title uri edit | (Just (title, edit)) <- edits]
 
 genList :: [GenComments]
 genList =
@@ -52,57 +52,62 @@ genList =
 -----------------------------------------------------------------------------
 data GenComments = forall a.
   GenComments
-  { fromDecl :: HsDecl GhcPs -> Maybe a,
+  { title :: T.Text,
+    fromDecl :: HsDecl GhcPs -> Maybe a,
     collectKeys :: a -> [AnnKey],
-    fresh :: Annotation -> Bool,
+    isFresh :: Annotation -> Bool,
     updateAnn :: Annotation -> Annotation
   }
 
-runGenComments :: GenComments -> Maybe [LHsDecl GhcPs] -> Maybe Anns -> Range -> Maybe TextEdit
+runGenComments :: GenComments -> Maybe [LHsDecl GhcPs] -> Maybe Anns -> Range -> Maybe (T.Text, TextEdit)
 runGenComments GenComments {..} mLocDecls mAnns range
   | Just locDecls <- mLocDecls,
     Just anns <- mAnns,
     [(locDecl, src, x)] <- [(locDecl, l, x) | locDecl@(L l (fromDecl -> Just x)) <- locDecls, inRange range l],
     annKeys <- collectKeys x,
     not $ null annKeys,
-    and $ maybe False fresh . flip Map.lookup anns <$> annKeys,
+    and $ maybe False isFresh . flip Map.lookup anns <$> annKeys,
     anns' <- foldr (Map.adjust updateAnn) anns annKeys,
     Just range' <- calcRange src range,
     result <- T.strip . T.pack $ exactPrint locDecl anns' =
-    Just $ TextEdit range' result
+    Just (title, TextEdit range' result)
   | otherwise = Nothing
 
 -----------------------------------------------------------------------------
 
 genForSig :: GenComments
 genForSig = GenComments {..}
   where
+    title = "Generate signature comments"
+
     fromDecl (SigD _ (TypeSig _ _ (HsWC _ (HsIB _ x)))) = Just x
     fromDecl _ = Nothing
     updateAnn x = x {annEntryDelta = DP (0, 1), annsDP = dp}
 
-    fresh Ann {annsDP}
+    isFresh Ann {annsDP}
       | null [() | (AnnComment _, _) <- annsDP] = True
       | otherwise = False
 
     collectKeys = keyFromTyVar 0
 
-    comment = mkComment "-- ^ ____" noSrcSpan
+    comment = mkComment "-- ^ " noSrcSpan
     dp = [(AnnComment comment, DP (0, 1)), (G AnnRarrow, DP (1, 2))]
 
 genForRecord :: GenComments
 genForRecord = GenComments {..}
   where
+    title = "Generate fields comments"
+
     fromDecl (TyClD _ DataDecl {tcdDataDefn = HsDataDefn {dd_cons = cons}}) = Just [x | (L _ ConDeclH98 {con_args = x}) <- cons]
     fromDecl _ = Nothing
 
     updateAnn x = x {annEntryDelta = DP (1, -7), annPriorComments = [(comment, DP (1, -7))]}
 
-    fresh Ann {annPriorComments} = null annPriorComments
+    isFresh Ann {annPriorComments} = null annPriorComments
 
     collectKeys = keyFromCon
 
-    comment = mkComment "-- | ____" noSrcSpan
+    comment = mkComment "-- | " noSrcSpan
 
 -----------------------------------------------------------------------------