Update project documentation (#80)

Author: thomashoneyman

README.md

@@ -1,7 +1,11 @@
 module Data.Argonaut.Decode
   ( module Data.Argonaut.Decode.Class
   , module Data.Argonaut.Decode.Combinators
+  , module Data.Argonaut.Decode.Error
+  , module Data.Argonaut.Decode.Parser
   ) where
 
 import Data.Argonaut.Decode.Class (class DecodeJson, decodeJson)
 import Data.Argonaut.Decode.Combinators (getField, getFieldDeprecated, getFieldOptional, getFieldOptionalDeprecated, getFieldOptional', defaultField, defaultFieldDeprecated, (.:), (.?), (.:!), (.:?), (.??), (.!=), (.?=))
+import Data.Argonaut.Decode.Error (JsonDecodeError(..), printJsonDecodeError)
+import Data.Argonaut.Decode.Parser (parseJson)

src/Data/Argonaut/Decode.purs

@@ -3,7 +3,7 @@ module Data.Argonaut.Decode.Class where
 import Prelude (class Ord, Unit, Void, bind, ($), (<<<))
 
 import Data.Argonaut.Core (Json, toObject)
-import Data.Argonaut.Decode.Errors (JsonDecodeError(..))
+import Data.Argonaut.Decode.Error (JsonDecodeError(..))
 import Data.Array.NonEmpty (NonEmptyArray)
 import Data.Either (Either(..))
 import Data.Bifunctor (lmap)

src/Data/Argonaut/Decode/Class.purs

@@ -18,7 +18,7 @@ module Data.Argonaut.Decode.Combinators
 import Prelude ((<$>))
 
 import Data.Argonaut.Core (Json)
-import Data.Argonaut.Decode.Errors (JsonDecodeError)
+import Data.Argonaut.Decode.Error (JsonDecodeError)
 import Data.Argonaut.Decode.Class (class DecodeJson, decodeJson)
 import Data.Either (Either)
 import Data.Maybe (Maybe, fromMaybe)

src/Data/Argonaut/Decode/Combinators.purs

@@ -3,7 +3,7 @@ module Data.Argonaut.Decode.Decoders where
 import Prelude
 
 import Data.Argonaut.Core (Json, caseJsonBoolean, caseJsonNull, caseJsonNumber, caseJsonString, isNull, toArray, toObject, toString, fromString)
-import Data.Argonaut.Decode.Errors (JsonDecodeError(..))
+import Data.Argonaut.Decode.Error (JsonDecodeError(..))
 import Data.Array as Arr
 import Data.Array.NonEmpty (NonEmptyArray)
 import Data.Array.NonEmpty as NEA

src/Data/Argonaut/Decode/Decoders.purs

@@ -1,6 +1,6 @@
 -- | Originally implemented in: 
 -- | https://github.com/garyb/purescript-codec-argonaut
-module Data.Argonaut.Decode.Errors where
+module Data.Argonaut.Decode.Error where
 
 import Prelude
 

src/Data/Argonaut/Decode/Errors.purs renamed to src/Data/Argonaut/Decode/Error.purs

@@ -0,0 +1,14 @@
+module Data.Argonaut.Decode.Parser where
+
+import Prelude
+
+import Data.Argonaut.Core (Json)
+import Data.Argonaut.Decode.Error (JsonDecodeError(..))
+import Data.Argonaut.Parser (jsonParser)
+import Data.Bifunctor (lmap)
+import Data.Either (Either)
+
+-- | Attempt to parse a string as `Json`, failing with a typed error if the
+-- | JSON string is malformed.
+parseJson :: String -> Either JsonDecodeError Json
+parseJson = lmap (\_ -> TypeMismatch "JSON") <<< jsonParser

src/Data/Argonaut/Decode/Parser.purs

@@ -6,7 +6,7 @@ import Control.Monad.Gen.Common (genMaybe)
 import Control.Monad.Reader (ReaderT, ask, local, runReaderT)
 import Data.Argonaut.Core (Json, isObject, stringify, toObject)
 import Data.Argonaut.Decode (class DecodeJson, decodeJson, (.:), (.:!), (.:?), (.!=))
-import Data.Argonaut.Decode.Errors (JsonDecodeError, printJsonDecodeError)
+import Data.Argonaut.Decode.Error (JsonDecodeError, printJsonDecodeError)
 import Data.Argonaut.Encode (encodeJson, (:=), (:=?), (~>), (~>?))
 import Data.Argonaut.Gen (genJson)
 import Data.Argonaut.Parser (jsonParser)