Doctest comment parsing using module annotations in Eval Plugin

[konn]

This PR aims at rewriting existing custom comment parser in Eval plugin with getParsedModuleWithComments, which is introduced recently.
This should address #1214, #1231 and #1258.

closes #1214, closes #1258

[konn]

I think it's done for line comments (not blocks yet), and it seems that the infinite loop occurring when one toggles block comments, as described in #1214, seems gone with the current change.

[konn]

Hmm, also plugins/hls-eval-plugin/README.rm states that Multiline expressions are supported, there seem no implementation and test cases for it. I decided just to ignore this feature in this PR.

[konn]

Fmm, I assume that Opt_Haddock is disabled in getParsedModuleWithComments, but it seems it is.
Then, we have to decide the style (block or line) of comments corresponding to AnnDocCommentNext, AnnDocCommentPrev and AnnDocCommentNamed.
I couldn't find the information to decide their style, does anyone has knowledge of them, or we have to decide it by just scanning the corresponding initial segments of range from editor buffer and see whether it start with -- or not?

[jneira]

and what about disable haddock for getParsedModuleWithComents?

[konn]

and what about disable haddock for getParsedModuleWithComents?

Yes, it must be the easiest way to try!
I'm not sure if other plugins using getParsedModuleWithComments (e.g. HLint) work as previous. Let me try disabling Opt_Haddock and see how CI result changes.

[jneira]

In fact when i wrote the rule i was about to disable haddock, but as hlint worked without doing it i decided to let is as is now

[konn]

To comply with the current Eval Plugin behaviour, I decided to limit the indentation level to be processed as Eval command so that:

• In ordinary .hs: indent level must be 0
• Literate Haskell: Indent Level must be 1

This doesn't cover modules with the base indentation level strictly greater than those specified above, though it might rarely occur.
Since the objective of this PR is just to replace the existing comment parser, such improvements deserve another PR.

[jneira]

Maybe we could add a dedicated function to mark tests broken for windows like https://github.com/haskell/haskell-language-server/blob/master/test/utils/Test/Hls/Util.hs#L119
We can use extra function isWindows: https://hackage.haskell.org/package/extra-1.7.9/docs/System-Info-Extra.html#v:isWindows

[jneira]

Anyway i will try to take a look in my local windows env

[jneira]

Looks good to me, and tests are the evidence it improves the actual situation.
I would like to have some other approve before merge though.

[Ailrun]

I think it's in a good shape.