Code review comments

Author: pbrisbin

Diff for: .dockerignore

@@ -3,4 +3,5 @@
 dist/
 
 cc/*
-!cc/engine.hs
+!cc/*.cabal
+!cc/*.hs

Diff for: cc/Dockerfile

@@ -10,17 +10,25 @@ ENV PATH /root/.local/bin:$PATH
 RUN mkdir -p /src
 WORKDIR /src
 
+# Install appropriate GHC
 COPY stack.yaml /src/
 RUN stack setup
 
+# Install HLint
 COPY hlint.cabal /src/
 RUN stack install --dependencies-only
-
 COPY ./src /src/src
 COPY ./data /src/data
-COPY ./cc/engine.hs /src/cc/engine.hs
 COPY ./LICENSE /src/LICENSE
-RUN stack install --flag hlint:cc
+RUN stack install
+
+# Install CC/Engine executable
+RUN mkdir -p /cc
+WORKDIR /cc
+COPY ./cc/engine.cabal /cc/engine.cabal
+RUN stack init && stack install --dependencies-only
+COPY ./cc/Engine.hs /cc/Engine.hs
+RUN stack install
 
 #
 # Runtime
@@ -32,8 +40,8 @@ ENV LANG en_US.UTF-8
 
 # Executables from build stage
 COPY --from=builder /root/.local/bin/hlint /usr/bin/hlint
-COPY --from=builder /root/.local/bin/cc-engine /usr/bin/engine
-COPY data /opt/hlint
+COPY --from=builder /root/.local/bin/engine /usr/bin/engine
+COPY --from=builder /src/data /opt/hlint
 
 RUN mkdir -p /code
 VOLUME /code

Diff for: cc/engine.hs renamed to cc/Engine.hs

@@ -1,5 +1,5 @@
 {-# LANGUAGE OverloadedStrings #-}
-module Main where
+module Main (main) where
 
 import Data.Aeson
 import Data.List (isSuffixOf)
@@ -64,8 +64,8 @@ main = do
 
     callProcess "hlint" $
         [ "lint"
+        , "--cc"
         , "--datadir", "/opt/hlint"
-        , "--json-cc"
         , "--no-exit-code"
         ]
         ++ cExtraFlags c

Diff for: cc/engine.cabal

@@ -0,0 +1,21 @@
+cabal-version:      >= 1.18
+build-type:         Simple
+name:               engine
+version:            0.0.1
+category:           Development
+author:             Patrick Brisbin <[email protected]>
+maintainer:         Patrick Brisbin <[email protected]>
+copyright:          Neil Mitchell 2006-2017
+synopsis:           Run HLint as a Code Climate engine
+description:        Run HLint as a Code Climate engine
+homepage:           https://github.com/ndmitchell/hlint#readme
+bug-reports:        https://github.com/ndmitchell/hlint/issues
+
+executable engine
+    default-language:   Haskell2010
+    build-depends:      base
+                      , aeson
+                      , bytestring
+                      , process
+    main-is:            Engine.hs
+    ghc-options:        -rtsopts -threaded

Diff for: hlint.cabal

@@ -43,11 +43,6 @@ flag gpl
     manual: True
     description: Use GPL libraries, specifically hscolour
 
-flag cc
-    default: False
-    manual: True
-    description: Build the Code Climate engine executable
-
 library
     default-language:   Haskell2010
     build-depends:
@@ -133,19 +128,3 @@ executable hlint
     ghc-options:        -rtsopts
     if flag(threaded)
         ghc-options:    -threaded
-
-executable cc-engine
-    if !flag(cc)
-        buildable: False
-
-    default-language:   Haskell2010
-    build-depends:      base
-                      , aeson
-                      , bytestring
-                      , process
-    main-is:            engine.hs
-    hs-source-dirs:     cc
-
-    ghc-options:        -rtsopts
-    if flag(threaded)
-        ghc-options:    -threaded

Diff for: src/CC.hs

@@ -25,7 +25,7 @@ data Issue = Issue
     { issueType :: Text
     , issueCheckName :: Text
     , issueDescription :: Text
-    , issueContent :: Text -- TODO: Markdown type?
+    , issueContent :: Text
     , issueCategories :: [Text]
     , issueLocation :: Location
     , issueRemediationPoints :: Int
@@ -75,7 +75,7 @@ fromIdea Idea{..} = Issue
     { issueType = "issue"
     , issueCheckName = "HLint/" <> T.pack (camelize ideaHint)
     , issueDescription = T.pack ideaHint
-    , issueContent = content ideaFrom ideaTo
+    , issueContent = content ideaFrom ideaTo <> listNotes ideaNote
     , issueCategories = categories ideaHint
     , issueLocation = fromSrcSpan ideaSpan
     , issueRemediationPoints = points ideaSeverity
@@ -106,6 +106,13 @@ fromIdea Idea{..} = Issue
         , "```"
         ]
 
+    listNotes [] = ""
+    listNotes notes = T.unlines $
+        [ ""
+        , "Applying this change:"
+        , ""
+        ] ++ map (("* " <>) . T.pack . show) notes
+
     categories _ = ["Style"]
 
     points Ignore = 0

Diff for: src/CmdLine.hs

@@ -114,7 +114,7 @@ data Cmd
         ,cmdCppSimple :: Bool
         ,cmdCppAnsi :: Bool
         ,cmdJson :: Bool                -- ^ display hint data as JSON
-        ,cmdJsonCC :: Bool              -- ^ display hint data as Code Climate Issues
+        ,cmdCC :: Bool                  -- ^ display hint data as Code Climate Issues
         ,cmdNoSummary :: Bool           -- ^ do not show the summary info
         ,cmdOnly :: [String]            -- ^ specify which hints explicitly
         ,cmdNoExitCode :: Bool
@@ -175,7 +175,7 @@ mode = cmdArgsMode $ modes
         ,cmdCppSimple = nam_ "cpp-simple" &= help "Use a simple CPP (strip # lines)"
         ,cmdCppAnsi = nam_ "cpp-ansi" &= help "Use CPP in ANSI compatibility mode"
         ,cmdJson = nam_ "json" &= help "Display hint data as JSON"
-        ,cmdJsonCC = nam_ "json-cc" &= help "Display hint data as Code Climate Issues JSON"
+        ,cmdCC = nam_ "cc" &= help "Display hint data as Code Climate Issues"
         ,cmdNoSummary = nam_ "no-summary" &= help "Do not show summary information"
         ,cmdOnly = nam "only" &= typ "HINT" &= help "Specify which hints explicitly"
         ,cmdNoExitCode = nam_ "no-exit-code" &= help "Do not give a negative exit if hints"

Diff for: src/HLint.hs

@@ -160,7 +160,7 @@ runHints args settings cmd@CmdMain{..} = do
         ideas <- return $ if cmdShowAll then ideas else  filter (\i -> ideaSeverity i /= Ignore) ideas
         if cmdJson then
             putStrLn $ showIdeasJson ideas
-         else if cmdJsonCC then
+         else if cmdCC then
             mapM_ (printIssue . fromIdea) ideas
          else if cmdSerialise then do
             hSetBuffering stdout NoBuffering