hls-notes-plugin: Allow single line notes to be indented

Author: jvanbruegge

plugins/hls-notes-plugin/src/Ide/Plugin/Notes.hs

@@ -137,7 +137,7 @@ findNotesInFile file recorder = do
 noteRefRegex, noteRegex :: Regex
 (noteRefRegex, noteRegex) =
     ( mkReg ("note \\[(.+)\\]" :: String)
-    , mkReg ("note \\[([[:print:]]+)\\][[:blank:]]*[[:space:]](--)?[[:blank:]]*~~~" :: String)
+    , mkReg ("note \\[([[:print:]]+)\\][[:blank:]]*[[:space:]][[:blank:]]*(--)?[[:blank:]]*~~~" :: String)
     )
     where
         mkReg = makeRegexOpts (defaultCompOpt { caseSensitive = False }) defaultExecOpt

plugins/hls-notes-plugin/test/NotesTest.hs

@@ -30,7 +30,8 @@ gotoNoteTests = testGroup "Goto Note Definition"
         defs <- getDefinitions doc (Position 5 64)
         liftIO $ do
           fp <- canonicalizePath "NoteDef.hs"
-          defs @?= InL (Definition (InR [Location (filePathToUri fp) (Range (Position 18 9) (Position 18 9))]))
+          defs @?= InL (Definition (InR [Location (filePathToUri fp) (Range (Position 18 11) (Position 18 11))]))
+
     , testCase "invalid_note" $ runSessionWithServer def plugin testDataDir $ do
         doc <- openDoc "NoteDef.hs" "haskell"
         _ <- waitForAllProgressDone

plugins/hls-notes-plugin/test/testdata/NoteDef.hs

@@ -16,10 +16,10 @@ This is also a very common thing to do for GHC
 
 -}
 
--- Note [Single line comments]
--- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
--- GHC's notes script only allows multiline comments to define notes, but in the
--- HLS codebase this single line style can be found as well.
+  -- Note [Single line comments]
+  -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~
+  -- GHC's notes script only allows multiline comments to define notes, but in the
+  -- HLS codebase this single line style can be found as well.
 
 {- Note [Not a valid Note]