marshal between checkresult and issue, freeze deps and enable overloaded strings.

my .ghci config had enabled overloaded strings everwhere which meant it
was compiling only on my machine. sorry!

Author: Philip Cunningham

cabal.config

@@ -0,0 +1,37 @@
+constraints: Glob ==0.7.5,
+             QuickCheck ==2.8.1,
+             ShellCheck ==0.4.1,
+             aeson ==0.9.0.1,
+             array ==0.5.0.0,
+             attoparsec ==0.13.0.1,
+             base ==4.7.0.2,
+             binary ==0.7.1.0,
+             bytestring ==0.10.4.0,
+             containers ==0.5.5.1,
+             deepseq ==1.3.0.2,
+             directory ==1.2.1.0,
+             dlist ==0.7.1.2,
+             filepath ==1.3.0.2,
+             ghc-prim ==0.3.1.0,
+             hashable ==1.2.3.3,
+             integer-gmp ==0.5.1.0,
+             json ==0.9.1,
+             mtl ==2.2.1,
+             old-locale ==1.0.0.6,
+             parsec ==3.1.9,
+             pretty ==1.1.1.1,
+             primitive ==0.6,
+             random ==1.1,
+             regex-base ==0.93.2,
+             regex-tdfa ==1.2.1,
+             rts ==1.0,
+             scientific ==0.3.3.8,
+             syb ==0.5.1,
+             template-haskell ==2.9.0.0,
+             text ==1.2.1.3,
+             tf-random ==0.5,
+             time ==1.4.2,
+             transformers ==0.4.3.0,
+             unix ==2.7.0.1,
+             unordered-containers ==0.2.5.1,
+             vector ==0.11.0.0

codeclimate-shellcheck.cabal

@@ -13,12 +13,13 @@ executable engine
   main-is:
     Main.hs
   other-modules:
+    CC.Analyse
     CC.Types
   build-depends:
       aeson
     , base >= 4.7 && < 5
     , bytestring
     , Glob
-    , text
+    , ShellCheck >= 0.4.0 && < 0.5.0
   hs-source-dirs: src
   default-language: Haskell2010

src/CC/Analyse.hs

@@ -0,0 +1,36 @@
+{-# LANGUAGE RecordWildCards #-}
+
+module CC.Analyse where
+
+import CC.Types as CC
+import Data.Monoid ((<>))
+import ShellCheck.Interface ( CheckResult(..)
+                            , Comment(..)
+                            , Position(..)
+                            , PositionedComment(..)
+                            , Severity(..)
+                            )
+
+toCategory :: Severity -> Category
+toCategory ErrorC   = BugRisk
+toCategory InfoC    = BugRisk
+toCategory StyleC   = Style
+toCategory WarningC = BugRisk
+
+toIssue :: PositionedComment -> Issue
+toIssue (PositionedComment Position{..} (Comment severity code description)) =
+  Issue {
+      _check_name         = "ShellCheck/" <> show code
+    , _description        = description
+    , _categories         = [toCategory severity]
+    , _location           = Location posFile (PositionBased coords coords)
+    , _remediation_points = Nothing
+    , _content            = Nothing
+    , _other_locations    = Nothing
+  }
+  where
+    coords :: CC.Position
+    coords = Coords (LineColumn { _line = posLine, _column = posColumn })
+
+toIssues :: CheckResult -> [Issue]
+toIssues CheckResult{..} = fmap toIssue crComments

src/CC/Types.hs

@@ -1,4 +1,5 @@
 {-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE OverloadedStrings #-}
 {-# LANGUAGE RecordWildCards #-}
 
 module CC.Types where
@@ -7,7 +8,6 @@ import Data.Aeson       (ToJSON(..), (.=), genericToJSON, object)
 import Data.Aeson.Types (Pair, Value(Null), defaultOptions, fieldLabelModifier)
 import Data.Char        (isUpper, toLower)
 import GHC.Generics     (Generic)
-import Data.Text        (pack)
 
 -- | Issues must be associated with one or more categories.
 data Category = BugRisk
@@ -20,13 +20,13 @@ data Category = BugRisk
               deriving Show
 
 instance ToJSON Category where
-  toJSON BugRisk = toJSON "Bug Risk"
+  toJSON BugRisk = "Bug Risk"
   toJSON x       = toJSON $ show x
 
 -- | Line and column numbers are 1-based.
 data LineColumn = LineColumn {
-    _line   :: Int
-  , _column :: Int
+    _line   :: Integer
+  , _column :: Integer
 } deriving (Generic, Show)
 
 instance ToJSON LineColumn where
@@ -36,18 +36,18 @@ instance ToJSON LineColumn where
 -- expressed in two ways.
 data Position = Coords LineColumn
                 -- ^ Line and column coordinates.
-              | Offset Int
+              | Offset Integer
                 -- ^ Absolute character offsets, for the entire source buffer.
               deriving Show
 
 instance ToJSON Position where
   toJSON (Coords x) = toJSON x
-  toJSON (Offset x) = toJSON $ object [ (pack "offset") .= x ]
+  toJSON (Offset x) = object [ "offset" .= x ]
 
 -- | Line-based locations emit a beginning and end line number for the issue,
 -- whereas position-based locations allow more precision.
 data BeginEnd = PositionBased Position Position
-              | LineBased Int Int
+              | LineBased Integer Integer
               deriving Show
 
 instance ToJSON BeginEnd where
@@ -56,18 +56,18 @@ instance ToJSON BeginEnd where
     LineBased     x y -> f x y
     where
       f :: (ToJSON a) => a -> a -> [Pair]
-      f x y = [ (pack "begin") .= x, (pack "end") .= y ]
+      f x y = [ "begin" .= x, "end" .= y ]
 
 -- | Locations refer to ranges of a source code file.
 data Location = Location FilePath BeginEnd deriving Show
 
 instance ToJSON Location where
   toJSON (Location x y) = object $ case y of
-    PositionBased _ _ -> [ f x, (pack "positions") .= y ]
-    LineBased _ _     -> [ f x, (pack "lines") .= y ]
+    PositionBased _ _ -> [ f x, "positions" .= y ]
+    LineBased _ _     -> [ f x, "lines" .= y ]
     where
       f :: FilePath -> Pair
-      f = (.=) (pack "path")
+      f = (.=) "path"
 
 -- | An issue represents a single instance of a real or potential code problem,
 -- detected by a static analysis Engine.
@@ -76,21 +76,21 @@ data Issue = Issue {
   , _description        :: String
   , _categories         :: [Category]
   , _location           :: Location
-  , _remediation_points :: Maybe Int
+  , _remediation_points :: Maybe Integer
   , _content            :: Maybe String
   , _other_locations    :: Maybe [Location]
 } deriving Show
 
 instance ToJSON Issue where
   toJSON Issue{..} = object . withoutNulls $ [
-        pack "type"               .= ("issue" :: String)
-      , pack "check_name"         .= _check_name
-      , pack "description"        .= _description
-      , pack "categories"         .= _categories
-      , pack "location"           .= _location
-      , pack "remediation_points" .= _remediation_points
-      , pack "content"            .= _content
-      , pack "other_locations"    .= _other_locations
+        "type"               .= ("issue" :: String)
+      , "check_name"         .= _check_name
+      , "description"        .= _description
+      , "categories"         .= _categories
+      , "location"           .= _location
+      , "remediation_points" .= _remediation_points
+      , "content"            .= _content
+      , "other_locations"    .= _other_locations
     ]
     where
       withoutNulls :: [(a, Value)] -> [(a, Value)]

src/Main.hs

@@ -1,6 +1,6 @@
+{-# LANGUAGE RecordWildCards #-}
+
 module Main where
 
+import CC.Analyse
 import CC.Types
-
-main :: IO ()
-main = putStrLn "hey"