#433, make hints spanning multiple modules/declarations

ndmitchell · Feb 7, 2018 · 7bb10df · 7bb10df · rikvdkleij · Apr 1, 2018
1 parent 1af1723
commit 7bb10df
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 17 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,5 +1,6 @@
 Changelog for HLint
 
+    #433, make hints spanning multiple modules/declarations
     #439, add more fixities for new base operators
     #437, --json output should be finite
     #425, avoid misparsing use of Gtk2Hs `on` function

diff --git a/src/Apply.hs b/src/Apply.hs
@@ -45,12 +45,12 @@ applyHints cs = applyHintsReal $ map SettingClassify cs
 applyHintsReal :: [Setting] -> Hint -> [(Module_, [Comment])] -> [Idea]
 applyHintsReal settings hints_ ms = concat $
     [ map (classify $ cls ++ mapMaybe readPragma (universeBi m)) $
-        order "" (hintModule hints settings nm m) `merge`
-        concat [order (fromNamed d) $ decHints d | d <- moduleDecls m] `merge`
-        concat [order "" $ hintComment hints settings c | c <- cs]
+        order [] (hintModule hints settings nm m) `merge`
+        concat [order [fromNamed d] $ decHints d | d <- moduleDecls m] `merge`
+        concat [order [] $ hintComment hints settings c | c <- cs]
     | (nm,(m,cs)) <- mns
     , let decHints = hintDecl hints settings nm m -- partially apply
-    , let order n = map (\i -> i{ideaModule=moduleName m, ideaDecl=n}) . sortBy (comparing ideaSpan)
+    , let order n = map (\i -> i{ideaModule=[moduleName m], ideaDecl=n}) . sortBy (comparing ideaSpan)
     , let merge = mergeBy (comparing ideaSpan)] ++
     [map (classify cls) (hintModules hints settings $ map (second fst) mns)]
     where
@@ -88,6 +88,6 @@ classify xs i =  let s = foldl' (f i) (ideaSeverity i) xs in s `seq` i{ideaSever
     where
         -- figure out if we need to change the severity
         f :: Idea -> Severity -> Classify -> Severity
-        f i r c | classifyHint c ~= ideaHint i && classifyModule c ~= ideaModule i && classifyDecl c ~= ideaDecl i = classifySeverity c
+        f i r c | classifyHint c ~= [ideaHint i] && classifyModule c ~= ideaModule i && classifyDecl c ~= ideaDecl i = classifySeverity c
                 | otherwise = r
-        x ~= y = null x || x == y
+        x ~= y = null x || x `elem` y
diff --git a/src/Idea.hs b/src/Idea.hs
@@ -23,8 +23,8 @@ import Prelude
 
 -- | An idea suggest by a 'Hint'.
 data Idea = Idea
-    {ideaModule :: String -- ^ The module the idea applies to, may be @\"\"@ if the module cannot be determined or is a result of cross-module hints.
-    ,ideaDecl :: String -- ^ The declaration the idea applies to, typically the function name, but may be a type name.
+    {ideaModule :: [String] -- ^ The modules the idea is for, usually a singleton.
+    ,ideaDecl :: [String] -- ^ The declarations the idea is for, usually a singleton, typically the function name, but may be a type name.
     ,ideaSeverity :: Severity -- ^ The severity of the idea, e.g. 'Warning'.
     ,ideaHint :: String -- ^ The name of the hint that generated the idea, e.g. @\"Use reverse\"@.
     ,ideaSpan :: SrcSpan -- ^ The source code the idea relates to.
@@ -40,7 +40,8 @@ data Idea = Idea
 -- 2) I want to control the format so it's slightly human readable as well
 showIdeaJson :: Idea -> String
 showIdeaJson idea@Idea{ideaSpan=srcSpan@SrcSpan{..}, ..} = dict
-    ,("decl", str ideaDecl)
+    [("module", list $ map str ideaModule)
+    ,("decl", list $ map str ideaDecl)
     ,("severity", str $ show ideaSeverity)
     ,("hint", str ideaHint)
     ,("file", str srcSpanFilename)
@@ -86,8 +87,8 @@ showEx tt Idea{..} = unlines $
             where xs = lines $ tt x
 
 
-rawIdea = Idea "" ""
-rawIdeaN a b c d e f = Idea "" "" a b c d e f []
+rawIdea = Idea [] []
+rawIdeaN a b c d e f = Idea [] [] a b c d e f []
 
 idea severity hint from to = rawIdea severity hint (srcInfoSpan $ ann from) (f from) (Just $ f to) []
     where f = trimStart . prettyPrint

diff --git a/tests/json.test b/tests/json.test
@@ -11,7 +11,7 @@ FILE tests/json-one.hs
 foo = (+1)
 bar x = foo x
 OUTPUT
-[{"module":"Main","decl":"bar","severity":"Warning","hint":"Eta reduce","file":"tests/json-one.hs","startLine":2,"startColumn":1,"endLine":2,"endColumn":14,"from":"bar x = foo x","to":"bar = foo","note":[],"refactorings":"[]"}]
+[{"module":["Main"],"decl":["bar"],"severity":"Warning","hint":"Eta reduce","file":"tests/json-one.hs","startLine":2,"startColumn":1,"endLine":2,"endColumn":14,"from":"bar x = foo x","to":"bar = foo","note":[],"refactorings":"[]"}]
 
 ---------------------------------------------------------------------
 RUN tests/json-two.hs --json
@@ -20,21 +20,21 @@ foo = (+1)
 bar x = foo x
 baz = getLine >>= return . map toUpper
 OUTPUT
-[{"module":"Main","decl":"bar","severity":"Warning","hint":"Eta reduce","file":"tests/json-two.hs","startLine":2,"startColumn":1,"endLine":2,"endColumn":14,"from":"bar x = foo x","to":"bar = foo","note":[],"refactorings":"[]"}
-,{"module":"Main","decl":"baz","severity":"Suggestion","hint":"Use <$>","file":"tests/json-two.hs","startLine":3,"startColumn":7,"endLine":3,"endColumn":39,"from":"getLine >>= return . map toUpper","to":"map toUpper <$> getLine","note":[],"refactorings":"[Replace {rtype = Expr, pos = SrcSpan {startLine = 3, startCol = 7, endLine = 3, endCol = 39}, subts = [(\"f\",SrcSpan {startLine = 3, startCol = 28, endLine = 3, endCol = 39}),(\"m\",SrcSpan {startLine = 3, startCol = 7, endLine = 3, endCol = 14})], orig = \"f <$> m\"}]"}]
+[{"module":["Main"],"decl":["bar"],"severity":"Warning","hint":"Eta reduce","file":"tests/json-two.hs","startLine":2,"startColumn":1,"endLine":2,"endColumn":14,"from":"bar x = foo x","to":"bar = foo","note":[],"refactorings":"[]"}
+,{"module":["Main"],"decl":["baz"],"severity":"Suggestion","hint":"Use <$>","file":"tests/json-two.hs","startLine":3,"startColumn":7,"endLine":3,"endColumn":39,"from":"getLine >>= return . map toUpper","to":"map toUpper <$> getLine","note":[],"refactorings":"[Replace {rtype = Expr, pos = SrcSpan {startLine = 3, startCol = 7, endLine = 3, endCol = 39}, subts = [(\"f\",SrcSpan {startLine = 3, startCol = 28, endLine = 3, endCol = 39}),(\"m\",SrcSpan {startLine = 3, startCol = 7, endLine = 3, endCol = 14})], orig = \"f <$> m\"}]"}]
 
 ---------------------------------------------------------------------
 RUN tests/json-parse-error.hs --json
 FILE tests/json-parse-error.hs
 ©
 OUTPUT
-[{"module":"","decl":"","severity":"Error","hint":"Parse error","file":"tests/json-parse-error.hs","startLine":1,"startColumn":1,"endLine":1,"endColumn":1,"from":"  \u00a9\n  \n> \n","to":null,"note":[],"refactorings":"[]"}]
+[{"module":[],"decl":[],"severity":"Error","hint":"Parse error","file":"tests/json-parse-error.hs","startLine":1,"startColumn":1,"endLine":1,"endColumn":1,"from":"  \u00a9\n  \n> \n","to":null,"note":[],"refactorings":"[]"}]
 
 ---------------------------------------------------------------------
 RUN tests/json-note.hs --json
 FILE tests/json-note.hs
 foo = any (a ==)
 bar = foldl (&&) True
 OUTPUT
-[{"module":"Main","decl":"foo","severity":"Warning","hint":"Use elem","file":"tests/json-note.hs","startLine":1,"startColumn":7,"endLine":1,"endColumn":17,"from":"any (a ==)","to":"elem a","note":["requires a valid `Eq` instance for `a`"],"refactorings":"[Replace {rtype = Expr, pos = SrcSpan {startLine = 1, startCol = 7, endLine = 1, endCol = 17}, subts = [(\"a\",SrcSpan {startLine = 1, startCol = 12, endLine = 1, endCol = 13})], orig = \"elem a\"}]"}
-,{"module":"Main","decl":"bar","severity":"Warning","hint":"Use and","file":"tests/json-note.hs","startLine":2,"startColumn":7,"endLine":2,"endColumn":22,"from":"foldl (&&) True","to":"and","note":["increases laziness"],"refactorings":"[Replace {rtype = Expr, pos = SrcSpan {startLine = 2, startCol = 7, endLine = 2, endCol = 22}, subts = [], orig = \"and\"}]"}]
+[{"module":["Main"],"decl":["foo"],"severity":"Warning","hint":"Use elem","file":"tests/json-note.hs","startLine":1,"startColumn":7,"endLine":1,"endColumn":17,"from":"any (a ==)","to":"elem a","note":["requires a valid `Eq` instance for `a`"],"refactorings":"[Replace {rtype = Expr, pos = SrcSpan {startLine = 1, startCol = 7, endLine = 1, endCol = 17}, subts = [(\"a\",SrcSpan {startLine = 1, startCol = 12, endLine = 1, endCol = 13})], orig = \"elem a\"}]"}
+,{"module":["Main"],"decl":["bar"],"severity":"Warning","hint":"Use and","file":"tests/json-note.hs","startLine":2,"startColumn":7,"endLine":2,"endColumn":22,"from":"foldl (&&) True","to":"and","note":["increases laziness"],"refactorings":"[Replace {rtype = Expr, pos = SrcSpan {startLine = 2, startCol = 7, endLine = 2, endCol = 22}, subts = [], orig = \"and\"}]"}]