Module Parsing.String.Replace

Copied from
https://github.com/jamesdbrock/purescript-parsing-replace

Author: jamesdbrock

CHANGELOG.md

@@ -46,6 +46,8 @@ Breaking changes:
 New features:
 
 - Add the `anyTill` primitive `String` combinator. (#186 by @jamesdbrock)
+- Add the `Parsing.String.Replace` module, copied from
+  https://github.com/jamesdbrock/purescript-parsing-replace (#188 by @jamesdbrock)
 
 Bugfixes:
 

README.md

@@ -130,7 +130,6 @@ There are lots of other great monadic parsing tutorials on the internet.
 ## Related Packages
 
 - [__`parsing-dataview`__](https://pursuit.purescript.org/packages/purescript-parsing-dataview) primitive parsers for binary parsing of `ArrayBuffer`.
-- [__`parsing-replace`__](https://pursuit.purescript.org/packages/purescript-parsing-replace) for finding text patterns, and also replacing or splitting on the found patterns.
 - [__`datetime-parsing`__](https://pursuit.purescript.org/packages/purescript-datetime-parsing) for parsing dates and times.
 
 ## Documentation

bower.json

@@ -1,40 +1,43 @@
 {
-  "name": "purescript-parsing",
-  "license": [
-    "BSD-2-Clause"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/purescript-contrib/purescript-parsing.git"
-  },
-  "ignore": [
-    "**/.*",
-    "node_modules",
-    "bower_components",
-    "output"
-  ],
-  "dependencies": {
-    "purescript-arrays": "master",
-    "purescript-control": "master",
-    "purescript-either": "master",
-    "purescript-foldable-traversable": "master",
-    "purescript-identity": "master",
-    "purescript-integers": "master",
-    "purescript-lists": "master",
-    "purescript-maybe": "master",
-    "purescript-newtype": "master",
-    "purescript-numbers": "master",
-    "purescript-prelude": "master",
-    "purescript-record": "master",
-    "purescript-strings": "master",
-    "purescript-tailrec": "master",
-    "purescript-transformers": "master",
-    "purescript-tuples": "master",
-    "purescript-unfoldable": "master",
-    "purescript-unicode": "main",
-    "purescript-unsafe-coerce": "master"
-  },
-  "devDependencies": {
-    "purescript-assert": "master"
-  }
+    "name": "purescript-parsing",
+    "license": [
+        "BSD-2-Clause"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/purescript-contrib/purescript-parsing.git"
+    },
+    "ignore": [
+        "**/.*",
+        "node_modules",
+        "bower_components",
+        "output"
+    ],
+    "dependencies": {
+        "purescript-arrays": "https://github.com/purescript/purescript-arrays.git#master",
+        "purescript-control": "https://github.com/purescript/purescript-control.git#master",
+        "purescript-either": "https://github.com/purescript/purescript-either.git#master",
+        "purescript-enums": "https://github.com/purescript/purescript-enums.git#master",
+        "purescript-foldable-traversable": "https://github.com/purescript/purescript-foldable-traversable.git#master",
+        "purescript-functions": "https://github.com/purescript/purescript-functions.git#master",
+        "purescript-identity": "https://github.com/purescript/purescript-identity.git#master",
+        "purescript-integers": "https://github.com/purescript/purescript-integers.git#master",
+        "purescript-lazy": "https://github.com/purescript/purescript-lazy.git#master",
+        "purescript-lists": "https://github.com/purescript/purescript-lists.git#master",
+        "purescript-maybe": "https://github.com/purescript/purescript-maybe.git#master",
+        "purescript-newtype": "https://github.com/purescript/purescript-newtype.git#master",
+        "purescript-nonempty": "https://github.com/purescript/purescript-nonempty.git#master",
+        "purescript-nullable": "https://github.com/purescript-contrib/purescript-nullable.git#main",
+        "purescript-numbers": "https://github.com/purescript/purescript-numbers.git#master",
+        "purescript-partial": "https://github.com/purescript/purescript-partial.git#master",
+        "purescript-prelude": "https://github.com/purescript/purescript-prelude.git#master",
+        "purescript-st": "https://github.com/purescript/purescript-st.git#master",
+        "purescript-strings": "https://github.com/purescript/purescript-strings.git#master",
+        "purescript-tailrec": "https://github.com/purescript/purescript-tailrec.git#master",
+        "purescript-transformers": "https://github.com/purescript/purescript-transformers.git#master",
+        "purescript-tuples": "https://github.com/purescript/purescript-tuples.git#master",
+        "purescript-unfoldable": "https://github.com/purescript/purescript-unfoldable.git#master",
+        "purescript-unicode": "https://github.com/purescript-contrib/purescript-unicode.git#main",
+        "purescript-unsafe-coerce": "https://github.com/purescript/purescript-unsafe-coerce.git#master"
+    }
 }

spago-dev.dhall

@@ -11,11 +11,13 @@ in conf //
 { sources = [ "src/**/*.purs", "test/**/*.purs", "bench/**/*.purs" ]
 , dependencies = conf.dependencies #
   [ "assert"
+  , "bifunctors"
   , "console"
   , "enums"
   , "effect"
   , "psci-support"
   , "minibench"
+  , "node-process"
   , "exceptions"
   , "string-parsers"
   , "partial"

spago.dhall

@@ -14,15 +14,19 @@
   , "lists"
   , "maybe"
   , "newtype"
+  , "nonempty"
   , "numbers"
+  , "nullable"
   , "partial"
   , "prelude"
+  , "st"
   , "strings"
   , "tailrec"
   , "transformers"
   , "tuples"
   , "unfoldable"
   , "unicode"
+  , "unsafe-coerce"
   ]
 , packages = ./packages.dhall
 , sources = [ "src/**/*.purs" ]

src/Parsing/String.purs

@@ -98,7 +98,7 @@ anyChar :: forall m. ParserT String m Char
 anyChar = satisfy (const true)
 
 -- | Match any Unicode character.
--- | Always succeeds.
+-- | Always succeeds when any input remains.
 anyCodePoint :: forall m. ParserT String m CodePoint
 anyCodePoint = satisfyCodePoint (const true)
 
@@ -290,9 +290,19 @@ consumeWith f = ParserT
 -- | Will fail if no section of the input is parseable. To backtrack the input
 -- | stream on failure, combine with `tryRethrow`.
 -- |
+-- | This combinator works like
+-- | [Data.String.takeWhile](https://pursuit.purescript.org/packages/purescript-strings/docs/Data.String#v:takeWhile)
+-- | or
+-- | [Data.String.Regex.search](https://pursuit.purescript.org/packages/purescript-strings/docs/Data.String.Regex#v:search)
+-- | and it allows using a parser for the pattern search.
+-- |
 -- | This combinator is equivalent to `manyTill_ anyCodePoint`, but it will be
 -- | faster because it returns a slice of the input `String` for the
 -- | section preceding the parse instead of a `List CodePoint`.
+-- |
+-- | Be careful not to look too far
+-- | ahead; if the phrase parser looks to the end of the input then `anyTill`
+-- | could be *O(n²)*.
 anyTill
   :: forall m a
    . Monad m