Merge branch 'main' of github.com:haskell-actions/hlint-scan

Author: chungyc

README.md

@@ -35,6 +35,13 @@ You only need to set them if the defaults do not work for your situation.
 `path`
 :   Path of file or directory that HLint will be told to scan.
 
+<!--
+Uncomment this when this is ready to be released:
+
+`hints`
+:   Path for HLint configuration file.
+-->
+
 `category`
 :   String used by GitHub code scanning for matching the analyses.
 

action.yaml

@@ -23,6 +23,10 @@ inputs:
     description: Path of file or directory that HLint will be told to scan.
     required: false
     default: .
+  hints:
+    # Change description when this is released.
+    description: Path for HLint configuration file.  Not available yet.
+    required: false
   category:
     description: String used by GitHub code scanning for matching the analyses.
     required: false
@@ -39,6 +43,7 @@ outputs:
 runs:
   using: docker
   image: Dockerfile # docker://ghcr.io/haskell-actions/hlint-scan:main
+  image: docker://ghcr.io/haskell-actions/hlint-scan:main
   args:
     - binary=${{ inputs.binary }}
     - path=${{ inputs.path }}

docs/CHANGELOG.md

@@ -10,6 +10,8 @@ the [Haskell Package Versioning Policy].
 
 ## Unreleased
 
+*   Support `hints` input for explicitly specifying the HLint configuration file.
+
 ## 0.4.1 - 2023-04-10
 
 *   Added automated testing.

src/Arguments.hs

@@ -76,7 +76,7 @@ validate args
 -- | List of argument keywords which are allowed.
 -- In other words, these are arguments we know what to do with.
 allowedArgs :: [String]
-allowedArgs = ["binary", "path", "category", "token"]
+allowedArgs = ["binary", "path", "hints", "category", "token"]
 
 -- | Translate program arguments to arguments for HLint.
 -- Also derives the category and access token from the arguments.
@@ -93,7 +93,7 @@ translate ::
   -- * Category to upload with.
   -- * GitHub access token.
   (FilePath, [String], Maybe String, Maybe String)
-translate args = (executable', path' : requiredFlags, category', token')
+translate args = (executable', path' : hints' ++ requiredFlags, category', token')
   where
     argsMap = map toTuple args
 
@@ -109,6 +109,12 @@ translate args = (executable', path' : requiredFlags, category', token')
       | Just "" <- path = "."
       | Just s <- path = s
 
+    hints = lookup "hints" argsMap
+    hints'
+      | Nothing <- hints = []
+      | Just "" <- hints = []
+      | Just s <- hints = ["--hint=" <> s]
+
     category = lookup "category" argsMap
     category'
       | Just "" <- category = Nothing

test/ArgumentsSpec.hs

@@ -37,16 +37,15 @@ spec = do
       validate
         [ "binary=/hlint",
           "path=.",
+          "hints=.hlint.yaml",
           "category=code-quality",
           "token=AB12CD"
         ]
         `shouldBe` Nothing
 
     prop "argument must have '=' character" $ \s ->
-      '='
-        `notElem` s
-        ==> validate [s]
-        `shouldSatisfy` isJust
+      '=' `notElem` s ==>
+        validate [s] `shouldSatisfy` isJust
 
     prop "argument must not have duplicate keyword" $ \key v v' ->
       '=' `notElem` key ==> \keyValues ->
@@ -56,23 +55,22 @@ spec = do
               validate args `shouldSatisfy` isJust
 
     prop "argument must have explicitly allowed keyword" $ \key v ->
-      '='
-        `notElem` key
-        ==> key
-        `notElem` ["binary", "path", "category", "token"]
-        ==> validate [key <> "=" <> v]
-        `shouldSatisfy` isJust
+      '=' `notElem` key ==>
+        key `notElem` ["binary", "path", "hints", "category", "token"] ==>
+          validate [key <> "=" <> v]
+            `shouldSatisfy` isJust
 
   describe "translate" $ do
     it "translates specific arguments" $
       translate
         [ "binary=/hlint",
           "path=.",
+          "hints=.hlint.yaml",
           "category=code-quality",
           "token=XYZ123"
         ]
         `shouldBe` ( "/hlint",
-                     [".", "-j", "--sarif", "--no-exit-code"],
+                     [".", "--hint=.hlint.yaml", "-j", "--sarif", "--no-exit-code"],
                      Just "code-quality",
                      Just "XYZ123"
                    )
@@ -88,7 +86,11 @@ spec = do
         `shouldSatisfy` \(binary, _, _, _) -> binary == "/hlint"
 
     prop "translates empty path to default path" $
-      translate ["binary="]
+      translate ["path="]
+        `shouldSatisfy` \(_, args, _, _) -> args == [".", "-j", "--sarif", "--no-exit-code"]
+
+    prop "translates empty hints to omitted hints file flag" $
+      translate ["hints="]
         `shouldSatisfy` \(_, args, _, _) -> args == [".", "-j", "--sarif", "--no-exit-code"]
 
     prop "translates empty category to Nothing" $
@@ -99,27 +101,21 @@ spec = do
       translate ["token="]
         `shouldSatisfy` \(_, _, token, _) -> isNothing token
 
-    prop "translates general arguments" $ \binary path category token ->
-      binary
-        /= ""
-        && path
-        /= ""
-        && category
-        /= ""
-        && token
-        /= ""
+    prop "translates general arguments" $ \binary path hints category token ->
+      binary /= "" && path /= "" && hints /= "" && category /= "" && token /= ""
         ==> forAll
           ( shuffle
               [ "binary=" <> binary,
                 "path=" <> path,
+                "hints=" <> hints,
                 "category=" <> category,
                 "token=" <> token
               ]
           )
         $ \args ->
           translate args
             `shouldBe` ( binary,
-                         [path, "-j", "--sarif", "--no-exit-code"],
+                         [path, "--hint=" <> hints, "-j", "--sarif", "--no-exit-code"],
                          Just category,
                          Just token
                        )