Updates for 0.7

Author: paf31

Gruntfile.js

@@ -1,4 +1,11 @@
 # purescript-string-parsers
 
-A parsing library for parsing strings
+A parsing library for parsing strings.
 
+This library is a simpler, faster alternative to `purescript-parsing`, for when you know your input will be a string.
+
+## Installing
+
+    bower i purescript-string-parsers
+
+- [Module Documentation](docs/)

README.md

@@ -17,14 +17,14 @@
     "package.json"
   ],
   "dependencies": {
-    "purescript-control": "~0.2.0",
-    "purescript-arrays": "~0.3.0",
-    "purescript-maybe": "~0.2.0",
-    "purescript-strings": "~0.4.2",
-    "purescript-foldable-traversable": "~0.3.0"
+    "purescript-control": "^0.3.0",
+    "purescript-arrays": "^0.4.0",
+    "purescript-maybe": "^0.3.0",
+    "purescript-strings": "^0.5.0",
+    "purescript-foldable-traversable": "^0.4.0"
   },
   "devDependencies": {
-    "purescript-math": "~0.1.0",
-    "purescript-quickcheck": "~0.5.0"
+    "purescript-math": "^0.2.0",
+    "purescript-quickcheck": "^0.6.0"
   }
 }

bower.json

@@ -0,0 +1,99 @@
+## Module Text.Parsing.StringParser
+
+This module defines the `Parser` type of string parsers, and its instances.
+
+#### `Pos`
+
+``` purescript
+type Pos = Int
+```
+
+A poition in an input string.
+
+#### `PosString`
+
+``` purescript
+type PosString = { str :: String, pos :: Pos }
+```
+
+Strings are represented as a string with an index from the
+start of the string.
+
+`{ str: s, pos: n }` is interpreted as the substring of `s`
+starting at index n.
+
+This allows us to avoid repeatedly finding substrings
+every time we match a character.
+
+#### `ParseError`
+
+``` purescript
+data ParseError
+  = ParseError String
+```
+
+The type of parsing errors.
+
+##### Instances
+``` purescript
+instance showParseError :: Show ParseError
+```
+
+#### `Parser`
+
+``` purescript
+data Parser a
+  = Parser (forall r. PosString -> (Pos -> ParseError -> r) -> (a -> PosString -> r) -> r)
+```
+
+A parser is represented as a function which takes a pair of
+continuations for failure and success.
+
+##### Instances
+``` purescript
+instance functorParser :: Functor Parser
+instance applyParser :: Apply Parser
+instance applicativeParser :: Applicative Parser
+instance altParser :: Alt Parser
+instance plusParser :: Plus Parser
+instance alternativeParser :: Alternative Parser
+instance bindParser :: Bind Parser
+instance monadParser :: Monad Parser
+instance monadPlusParser :: MonadPlus Parser
+```
+
+#### `unParser`
+
+``` purescript
+unParser :: forall a r. Parser a -> PosString -> (Pos -> ParseError -> r) -> (a -> PosString -> r) -> r
+```
+
+Run a parser by providing success and failure continuations.
+
+#### `runParser`
+
+``` purescript
+runParser :: forall a. Parser a -> String -> Either ParseError a
+```
+
+Run a parser for an input string, returning either an error or a result.
+
+#### `fail`
+
+``` purescript
+fail :: forall a. String -> Parser a
+```
+
+Fail with the specified message.
+
+#### `try`
+
+``` purescript
+try :: forall a. Parser a -> Parser a
+```
+
+In case of error, the default behavior is to backtrack if no input was consumed.
+
+`try p` backtracks even if input was consumed.
+
+

docs/Text/Parsing/StringParser.md

@@ -0,0 +1,191 @@
+## Module Text.Parsing.StringParser.Combinators
+
+This module defines combinators for building string parsers.
+
+#### `lookAhead`
+
+``` purescript
+lookAhead :: forall a. Parser a -> Parser a
+```
+
+Read ahead without consuming input.
+
+#### `many`
+
+``` purescript
+many :: forall a. Parser a -> Parser (List a)
+```
+
+Match zero or more times.
+
+#### `many1`
+
+``` purescript
+many1 :: forall a. Parser a -> Parser (List a)
+```
+
+Match one or more times.
+
+#### `(<?>)`
+
+``` purescript
+(<?>) :: forall a. Parser a -> String -> Parser a
+```
+
+_left-associative / precedence -1_
+
+Provide an error message in case of failure.
+
+#### `fix`
+
+``` purescript
+fix :: forall a. (Parser a -> Parser a) -> Parser a
+```
+
+Take the fixed point of a parser function. This function is sometimes useful when building recursive parsers.
+
+#### `between`
+
+``` purescript
+between :: forall a open close. Parser open -> Parser close -> Parser a -> Parser a
+```
+
+Parse a string between opening and closing markers.
+
+#### `option`
+
+``` purescript
+option :: forall a. a -> Parser a -> Parser a
+```
+
+Parse a value with a default value in case of failure.
+
+#### `optional`
+
+``` purescript
+optional :: forall a. Parser a -> Parser Unit
+```
+
+Attempt to parse a value.
+
+#### `optionMaybe`
+
+``` purescript
+optionMaybe :: forall a. Parser a -> Parser (Maybe a)
+```
+
+Attempt to parse a value, returning `Nothing` in case of failure.
+
+#### `sepBy`
+
+``` purescript
+sepBy :: forall a sep. Parser a -> Parser sep -> Parser (List a)
+```
+
+Parse zero or more separated values.
+
+#### `sepBy1`
+
+``` purescript
+sepBy1 :: forall a sep. Parser a -> Parser sep -> Parser (List a)
+```
+
+Parse one or more separated values.
+
+#### `sepEndBy`
+
+``` purescript
+sepEndBy :: forall a sep. Parser a -> Parser sep -> Parser (List a)
+```
+
+Parse zero or more separated values, optionally ending with a separator.
+
+#### `sepEndBy1`
+
+``` purescript
+sepEndBy1 :: forall a sep. Parser a -> Parser sep -> Parser (List a)
+```
+
+Parse one or more separated values, optionally ending with a separator.
+
+#### `endBy1`
+
+``` purescript
+endBy1 :: forall a sep. Parser a -> Parser sep -> Parser (List a)
+```
+
+Parse zero or more separated values, ending with a separator.
+
+#### `endBy`
+
+``` purescript
+endBy :: forall a sep. Parser a -> Parser sep -> Parser (List a)
+```
+
+Parse one or more separated values, ending with a separator.
+
+#### `chainr`
+
+``` purescript
+chainr :: forall a. Parser a -> Parser (a -> a -> a) -> a -> Parser a
+```
+
+Parse zero or more values separated by a right-associative operator.
+
+#### `chainl`
+
+``` purescript
+chainl :: forall a. Parser a -> Parser (a -> a -> a) -> a -> Parser a
+```
+
+Parse zero or more values separated by a left-associative operator.
+
+#### `chainl1`
+
+``` purescript
+chainl1 :: forall a. Parser a -> Parser (a -> a -> a) -> Parser a
+```
+
+Parse one or more values separated by a left-associative operator.
+
+#### `chainl1'`
+
+``` purescript
+chainl1' :: forall a. Parser a -> Parser (a -> a -> a) -> a -> Parser a
+```
+
+Parse one or more values separated by a left-associative operator.
+
+#### `chainr1`
+
+``` purescript
+chainr1 :: forall a. Parser a -> Parser (a -> a -> a) -> Parser a
+```
+
+Parse one or more values separated by a right-associative operator.
+
+#### `chainr1'`
+
+``` purescript
+chainr1' :: forall a. Parser a -> Parser (a -> a -> a) -> a -> Parser a
+```
+
+Parse one or more values separated by a right-associative operator.
+
+#### `choice`
+
+``` purescript
+choice :: forall f a. (Foldable f) => f (Parser a) -> Parser a
+```
+
+Parse using any of a collection of parsers.
+
+#### `manyTill`
+
+``` purescript
+manyTill :: forall a end. Parser a -> Parser end -> Parser (List a)
+```
+
+Parse values until a terminator.
+
+