regex docs and tests

Author: jamesdbrock

src/Text/Parsing/Parser/String.purs

@@ -225,12 +225,18 @@ unCodePoint = unsafeCoerce
 -- | at the current parser position. On success, it will return the matched
 -- | substring.
 -- |
+-- | If the `Regex` pattern string fails to compile then this parser will fail.
+-- | (Note: It’s not possible to use a precompiled `Regex` because this parser
+-- | must set flags and make adjustments to the `Regex` pattern string.)
+-- |
 -- | This parser may be useful for quickly consuming a large section of the
 -- | input `String`, because in a JavaScript runtime environment the `RegExp`
 -- | runtime is a lot faster than primitive parsers.
 -- |
 -- | [*MDN Regular Expressions Cheatsheet*](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Cheatsheet)
 -- |
+-- | #### Flags
+-- |
 -- | The `Record flags` argument to the parser is for `Regex` flags. Here are
 -- | the default flags.
 -- |
@@ -249,10 +255,6 @@ unCodePoint = unsafeCoerce
 -- | and use of the other flags may cause strange behavior in the parser.
 -- |
 -- | [*MDN Advanced searching with flags*](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#advanced_searching_with_flags)
--- |
--- | If the `Regex` pattern string fails to compile then this parser will fail.
--- | (Note: It’s not possible to use a precompiled `Regex` because this parser
--- | must set flags and make adjustments to the `Regex` pattern string.)
 regex
   :: forall m flags f_
    . Monad m

test/Main.purs

@@ -688,6 +688,8 @@ main = do
   parseTest "regexregex" "regexregex" (regex {} "(regex)*")
   parseTest "regexregex" "regex" (regex {} "(^regex)*")
   parseTest "ReGeX" "ReGeX" (regex { ignoreCase: true } "regex")
+  parseTest "regexcapregexcap" "regexcap" (regex {} "(?<CaptureGroupName>regexcap)")
+  parseTest "regexcapregexcap" "regexcap" (regex {} "(((?<CaptureGroupName>(r)e(g)excap)))")
 
   -- Maybe it is nonsense to allow multiline regex.
   -- Because an end-of-line regex pattern `$` will match but then the