Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove empty haddocks and remove empty comments. #1459

Draft
wants to merge 19 commits into
base: master
Choose a base branch
from
+768 −20
Draft

Remove empty haddocks and remove empty comments. #1459

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
8adccf8
Detect empty comments in isolation.
philderbeast Feb 12, 2023
a6f3b09
Add empty comment test file
philderbeast Feb 14, 2023
25ce756
Empty line tests; leading, trailing & double
philderbeast Jul 27, 2024
ab2a9f0
Add checks for single line >>> doctest comment
philderbeast Jul 31, 2024
5d59c9e
Update test expectations
philderbeast Jul 31, 2024
dd54168
Use helper in construction of Idea
philderbeast Jul 31, 2024
44fe67c
Add isCommentPragma
philderbeast Aug 3, 2024
e0eb345
Add isCommentHaddock
philderbeast Aug 3, 2024
89f527e
Very much WIP
philderbeast Aug 1, 2024
17352af
Add TODO comment
philderbeast Aug 2, 2024
c863c27
Need to sort comments by line
philderbeast Aug 2, 2024
fdd100e
Add isHaddockLeader
philderbeast Aug 2, 2024
65a87b1
Add classify comments
philderbeast Aug 2, 2024
4e1fc4f
Add scratch .test files in the root
philderbeast Aug 3, 2024
7e670a6
Include multi-line postfix haddock comments
philderbeast Aug 4, 2024
3328bf2
Check empty block haddocks separately
philderbeast Aug 4, 2024
0351986
Check empty blocks separately
philderbeast Aug 4, 2024
d5ffa47
Check for empty pragmas
philderbeast Aug 4, 2024
d6a0ccd
Add isHaddockDoctestWhitespace
philderbeast Aug 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Check empty block haddocks separately
  • Loading branch information
@philderbeast
philderbeast committed Aug 4, 2024
commit 3328bf23981e840521cf27a88b15014a42604d80
19 changes: 13 additions & 6 deletions src/Hint/Comment.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,7 @@ commentHint _ m =
traceShow ("runs", fmap commentText <$> runs) $
traceShow ("lineHaddocks", commentText <$> lineHaddocks) $
traceShow ("lines", commentText <$> lines) $
if any fst runReplacements
then concatMap snd runReplacements
else concatMap (check singleLines someLines) comments
blockHaddockIdeas ++ ideas
where
-- Comments need to be sorted by line number for detecting runs of single
-- line comments but @ghcComments@ doesn't always do that even though most
Expand All @@ -142,11 +140,17 @@ commentHint _ m =

Comments pragmas blockHaddocks blocks runHaddocks runs lineHaddocks lines = classifyComments comments

blockHaddockIdeas = concatMap checkEmptyBlockHaddocks blockHaddocks

runReplacements =
(dropBlankLinesHint <$> runHaddocks)
++
(dropBlankLinesHint <$> runs)

ideas = if any fst runReplacements
then concatMap snd runReplacements
else concatMap (check singleLines someLines) comments

-- | Does the commment start with "--"? Can be empty. Excludes haddock single
-- line comments, "-- |" and "-- ^".
isSingle :: LEpaComment -> Bool
Expand Down Expand Up @@ -205,11 +209,14 @@ commentFirstLine comm@(L _ _) = let s = commentText comm
" >>>" -> Just EmptyDoctest
_ -> Nothing

checkEmptyBlockHaddocks :: LEpaComment -> [Idea]
checkEmptyBlockHaddocks comm = [emptyHaddockMulti comm | isHaddockWhitespace comm]

check :: [Int] -> [Int] -> LEpaComment -> [Idea]
check singles somes comm@(L{})
| isHaddockWhitespace comm = traceShow ("haddock", comm) $
if | isMultiline -> [emptyHaddockMulti comm]
| leadingEmptyHaddock ->
-- Multi-line haddock comments are handled elsewhere.
| isHaddockWhitespace comm && not (isCommentMultiline comm) = traceShow ("haddock", comm) $
if | leadingEmptyHaddock ->
traceShow (line, singles, somes) $
[replaceComment "Try this" comm]
--[leadingEmptyIdea EmptyHaddock comm]
Expand Down