Doctest comment parsing using module annotations in Eval Plugin #1232

konn · 2021-01-19T14:06:30Z

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 · 2021-01-21T16:35:27Z

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.

…ended

konn · 2021-01-22T12:03:06Z

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 · 2021-01-22T17:05:06Z

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 · 2021-01-22T18:13:42Z

and what about disable haddock for getParsedModuleWithComents?

konn · 2021-01-22T18:21:02Z

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 · 2021-01-22T19:08:06Z

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 · 2021-01-24T04:41:12Z

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 · 2021-01-30T16:37:00Z

plugins/hls-eval-plugin/test/Eval.hs

                    goldenTest mdl
 #if __GLASGOW_HASKELL__ >= 808
-            , testCase "CPP support" $ goldenTest "TCPP.hs"
+            ,
+#if mingw32_HOST_OS


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

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

plugins/hls-eval-plugin/test/Eval.hs

…Windows`

…skell-language-server into eval-comments-from-parsed-module

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.

plugins/hls-eval-plugin/src/Ide/Plugin/Eval/CodeLens.hs

plugins/hls-eval-plugin/src/Ide/Plugin/Eval/Parse/Comments.hs

plugins/hls-eval-plugin/src/Ide/Plugin/Eval/Parse/Option.hs

Ailrun

I think it's in a good shape.

WIP: Comment parsing using module annotations

322e26d

konn changed the title ~~WIP: Doctest comment parsing using module annotations in Eval Plugin~~ Draft: Doctest comment parsing using module annotations in Eval Plugin Jan 19, 2021

konn marked this pull request as draft January 19, 2021 14:08

konn mentioned this pull request Jan 19, 2021

Plugin failures should not take down or make hang HLS #1231

Open

konn added 7 commits January 20, 2021 22:35

Merge branch 'master' into eval-comments-from-parsed-module

0e3cbe3

Line Comment parsers (wip)

e2f4b9d

Merge branch 'master' into eval-comments-from-parsed-module

b9bbb80

Merge branch 'master' into eval-comments-from-parsed-module

d32a571

Line comment implemented (block comment not implemented)

155ec6d

Completely switches to Megaparsec

032bc60

T27 must be fixed

abc3796

konn added 2 commits January 22, 2021 20:42

We can always assume that comment starts with "--" with no space prep…

d6b0ad9

…ended

must be horizontal space, not ANY whitespace

f035f37

Block parser (WIP)

3f25b17

konn added 2 commits January 23, 2021 02:42

We don't need whole range; position suffices

1c0ca62

Brutal parsing for block haddock comments

fce4e84

Brutal line parsing

2e64bbe

konn added 3 commits January 23, 2021 03:28

unset Opt_Haddock

53476b0

Wrong debug messages

261e8a6

Redundant debug output

d4c1800

Merge branch 'master' into eval-comments-from-parsed-module

8ef1d64

konn added 2 commits January 24, 2021 13:58

Hacks for indentation levels and LHS

abede6b

Updates block comment logic in Literate Haskell

c9e5636

konn and others added 3 commits January 29, 2021 09:50

Merge branch 'master' into eval-comments-from-parsed-module

9985e86

Merge branch 'master' into eval-comments-from-parsed-module

a3b1739

Merge branch 'master' into eval-comments-from-parsed-module

6fdf06c

konn requested review from Ailrun, jneira and ndmitchell January 30, 2021 08:57

Merge branch 'master' into eval-comments-from-parsed-module

375aa04

konn mentioned this pull request Jan 30, 2021

Consider restoring the old Eval plugin #1276

Closed

Merge branch 'master' into eval-comments-from-parsed-module

d9114de

jneira requested review from wz1000 and pepeiborra January 30, 2021 16:30

jneira linked an issue Jan 30, 2021 that may be closed by this pull request

HLS version 0.8.0 frequently stuck when saving files #1214

Closed

jneira reviewed Jan 30, 2021

View reviewed changes

plugins/hls-eval-plugin/test/Eval.hs Outdated Show resolved Hide resolved

konn added 2 commits January 31, 2021 01:51

Stop using CPP and use knownBrokenForGhcVersions and `knownBrokenOn…

557fdd6

…Windows`

Merge branch 'eval-comments-from-parsed-module' of github.com:konn/ha…

72257be

…skell-language-server into eval-comments-from-parsed-module

jneira approved these changes Jan 30, 2021

View reviewed changes

Merge branch 'master' into eval-comments-from-parsed-module

a07b145

Ailrun reviewed Jan 31, 2021

View reviewed changes

konn added 4 commits January 31, 2021 14:13

Nested expectedFailure didn't work as expected

5b90f43

Abolishes Parser type synonym

66cdc32

Removes unneccesary comment evals

90c86ce

Skip failed curentRange resolution

0e689e3

Ailrun approved these changes Jan 31, 2021

View reviewed changes

konn added the merge me Label to trigger pull request merge label Jan 31, 2021

mergify bot merged commit 6b6c405 into haskell:master Jan 31, 2021

konn deleted the eval-comments-from-parsed-module branch January 31, 2021 07:52

konn mentioned this pull request Jan 31, 2021

Extended Eval Plugin: we need more precise handling of :setting flags #1278

Closed

Ailrun mentioned this pull request Feb 1, 2021

Should we lint, -wall and format our code base? #693

Closed

konn mentioned this pull request Feb 2, 2021

Stuck on CPP include #1295

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doctest comment parsing using module annotations in Eval Plugin #1232

Doctest comment parsing using module annotations in Eval Plugin #1232

konn commented Jan 19, 2021 •

edited by Ailrun

Loading

konn commented Jan 21, 2021

konn commented Jan 22, 2021

konn commented Jan 22, 2021 •

edited

Loading

jneira commented Jan 22, 2021 •

edited

Loading

konn commented Jan 22, 2021 •

edited by jneira

Loading

jneira commented Jan 22, 2021 •

edited

Loading

konn commented Jan 24, 2021

jneira Jan 30, 2021

jneira Jan 30, 2021

jneira left a comment

Ailrun left a comment

Doctest comment parsing using module annotations in Eval Plugin #1232

Doctest comment parsing using module annotations in Eval Plugin #1232

Conversation

konn commented Jan 19, 2021 • edited by Ailrun Loading

konn commented Jan 21, 2021

konn commented Jan 22, 2021

konn commented Jan 22, 2021 • edited Loading

jneira commented Jan 22, 2021 • edited Loading

konn commented Jan 22, 2021 • edited by jneira Loading

jneira commented Jan 22, 2021 • edited Loading

konn commented Jan 24, 2021

jneira Jan 30, 2021

Choose a reason for hiding this comment

jneira Jan 30, 2021

Choose a reason for hiding this comment

jneira left a comment

Choose a reason for hiding this comment

Ailrun left a comment

Choose a reason for hiding this comment

konn commented Jan 19, 2021 •

edited by Ailrun

Loading

konn commented Jan 22, 2021 •

edited

Loading

jneira commented Jan 22, 2021 •

edited

Loading

konn commented Jan 22, 2021 •

edited by jneira

Loading

jneira commented Jan 22, 2021 •

edited

Loading