Add info, help and --all-errors flag

Author: icidasset

.editorconfig

@@ -0,0 +1,2 @@
+[*.hs]
+indent_size = 4

bin/Main.hs

@@ -6,26 +6,54 @@ import Flow
 import Proofread
 import Protolude hiding (state)
 import System.Console.Pretty
-import System.Environment (getArgs)
+import System.Console.CmdArgs
 
 import qualified Data.List as List
 import qualified Data.Text as Text
 
 
+-- 🌳
+
+
+data Flags = Flags
+    { filePath :: Maybe [Char]
+    , showAllErrors :: Bool
+    }
+    deriving (Data, Show, Typeable)
+
+
+flagsConfig = Flags
+    { filePath = Nothing &= args &= typFile
+
+    --
+    , showAllErrors = False
+        &= name "all-errors"
+        &= explicit
+        &= help "Show all errors instead of one"
+    }
+
+    -- Summary
+    ----------
+    &= summary "\nProofread your Elm files.\n\
+               \See https://github.com/icidasset/elm-proofread for examples."
+
+    -- Program
+    ----------
+    &= program "elm-proofread"
+
+
+
 -- 🍯
 
 
 main :: IO ()
 main = do
-    args <- getArgs
-
-    -- Fun w/ flags
-    let maybeFilePath = listToMaybe (excludeFlags args)
+    flags <- cmdArgs flagsConfig
 
-    -- Format!
-    case maybeFilePath of
-        Just filePath   -> processFile filePath
-        Nothing         -> processStdin
+    -- Proofread!
+    case filePath flags of
+        Just filePath   -> processFile filePath flags
+        Nothing         -> processStdin flags
 
 
 
@@ -34,50 +62,58 @@ main = do
 
 {-| Proofread a single file.
 -}
-processFile :: [Char] -> IO ()
-processFile filePath = do
+processFile :: [Char] -> Flags -> IO ()
+processFile filePath flags = do
     putStrLn (Text.concat [ "Proofreading ", Text.pack filePath ])
 
     contents    <- readFile filePath
     result      <- Proofread.proofread contents
 
-    handleResult result
+    handleResult result flags
 
 
 {-| Proofread stdin.
 -}
-processStdin :: IO ()
-processStdin = do
+processStdin :: Flags -> IO ()
+processStdin flags = do
     putStrLn ("Proofreading stdin" :: Text)
 
     contents    <- getContents
     result      <- Proofread.proofread contents
 
-    handleResult result
+    handleResult result flags
 
 
 
 -- 📮  ~  Generic
 
 
-handleResult :: Result Document Text -> IO ()
-handleResult (Err err) = putErrorLn err >> exitFailure
-handleResult (Ok (Document _ tests)) = do
+handleResult :: Result Document Text -> Flags -> IO ()
+handleResult (Err err) _ = putErrorLn err >> exitFailure
+handleResult (Ok (Document _ tests)) flags = do
     _ <- tests
         |> map renderTest
         |> sequence
 
-    -- Render first error, hide others
+    -- Render first error, hide others (unless all-errors flag is provided)
     -- Does nothing if no errors are present
     _ <- tests
-        |> List.find
+        |> List.filter
             (\t ->
                 case state t of
                     Error _     -> True
                     Unequal _   -> True
                     _           -> False
             )
-        |> maybe (return ()) renderTestError
+        |> (
+            if showAllErrors flags then
+                identity
+
+            else
+                List.take 1
+        )
+        |> map renderTestError
+        |> sequence
 
     -- Did all tests pass?
     let passedTests = filter (state .> (==) Equal) tests

package.yaml

@@ -9,6 +9,7 @@ category: Development
 
 
 default-extensions:
+  DeriveDataTypeable
   DisambiguateRecordFields
   DuplicateRecordFields
   NamedFieldPuns
@@ -24,10 +25,12 @@ ghc-options:
   -Wincomplete-record-updates
   -Wincomplete-uni-patterns
   -Wredundant-constraints
+  -fno-cse
 
 
 dependencies:
   - base >= 4.7 && < 5
+  - cmdargs == 0.10.*
   - flow == 1.*
   - megaparsec == 6.5.*
   - parser-combinators == 1.*

tests/fixtures/Errors.elm

@@ -0,0 +1,53 @@
+module Errors exposing (AdventureTime(..), add)
+
+import Dict
+
+
+{-| Adventure time.
+
+    >>> import Dict
+
+    >>> testPrep =
+    ..>   Dict.empty
+
+    >>> Finn
+    Jake
+
+    >>> "428a2f98 71374491 b5c0fbcf e9b5dba5 3956c25b 59f111f1 923f82a4 ab1c5ed5
+    ..> d807aa98 12835b01 243185be 550c7dc3 72be5d74 80deb1fe 9bdc06a7 c19bf174
+    ..> e49b69c1 efbe4786 0fc19dc6 240ca1cc 2de92c6f 4a7484aa 5cb0a9dc 76f988da
+    ..> 983e5152 a831c66d b00327c8 bf597fc7 c6e00bf3 d5a79147 06ca6351 14292967
+    ..> 27b70a85 2e1b2138 4d2c6dfc 53380d13 650a7354 766a0abb 81c2c92e 92722c85
+    ..> a2bfe8a1 a81a664b c24b8b70 c76c51a3 d192e819 d6990624 f40e3585 106aa070
+    ..> 19a4c116 1e376c08 2748774c 34b0bcb5 391c0cb3 4ed8aa4a 5b9cca4f 682e6ff3
+    ..> 748f82ee 78a5636f 84c87814 8cc70208 90befffa a4506ceb bef9a3f7 c67178f2"
+    "42"
+
+-}
+type AdventureTime
+    = Finn
+    | Jake
+
+
+{-|
+
+    >>> add 1 2
+    4
+
+    >>> import Tuple
+    >>> nine =
+    ..>   Tuple.first ( 9, True )
+
+    >>> 1.0
+    ..>     |> round
+    ..>     |> add nine
+    add
+        (round 5.0)
+        6
+
+    Hello ✌️
+
+-}
+add : number -> number -> number
+add x y =
+    Debug.log "ignoreThis" (x + y)