From 95d4ad832f58f43eb28e9d5b24a04bd194ef2af8 Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Thu, 26 Jan 2023 09:05:22 -0800 Subject: [PATCH 1/4] add library pros and cons to README --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b3071a82..959f4dfc 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,21 @@ [](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-parser-combinators_2.13) [](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-parser-combinators_3) -### Scala Standard Parser Combinator Library +This was originally part of the Scala standard library, but is now community-maintained, under the guidance of the Scala team at Lightbend. If you are interested in joining the maintainers team, please contact [@Philippus](https://github.com/philippus) or [@SethTisue](https://github.com/SethTisue). -This library was originally part of the Scala standard library, but is now community-maintained, under the guidance of the Scala team at Lightbend. If you are interested in helping please contact [@Philippus](https://github.com/philippus) or [@SethTisue](https://github.com/SethTisue). +## Choosing a parsing library + +This library's main strengths are: + +* It's been around and in wide use for more than a decade. +* The codebase is modest in size and its internals are fairly simple. +* It's plain vanilla Scala. No macros, code generation, or other magic is involved. + +Its main weaknesses are: + +* Performance. If you are ingesting large amounts of data, you may want something faster. + +A number of other parsing libraries for Scala are available -- [see list on Scaladex](https://index.scala-lang.org/awesome/parsing?sort=stars). ## Documentation @@ -68,7 +80,3 @@ For a detailed unpacking of this example see * Have a look at [existing issues](https://github.com/scala/scala-parser-combinators/issues) * Ask questions and discuss [in GitHub Discussions](https://github.com/scala/scala-parser-combinators/discussions) * Feel free to open draft pull requests with partially completed changes, to get feedback. - -## Alternatives - -A number of other parsing libraries for Scala are available; see https://index.scala-lang.org/awesome/parsing?sort=stars From 491d962ea5e74d5aa60f8c7af5ed75eb9e447960 Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Thu, 26 Jan 2023 09:21:19 -0800 Subject: [PATCH 2/4] add a weakness --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 959f4dfc..a55b21e0 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,13 @@ This was originally part of the Scala standard library, but is now community-mai This library's main strengths are: -* It's been around and in wide use for more than a decade. +* Stability. It's been around and in wide use for more than a decade. * The codebase is modest in size and its internals are fairly simple. * It's plain vanilla Scala. No macros, code generation, or other magic is involved. Its main weaknesses are: +* Minimal feature set. * Performance. If you are ingesting large amounts of data, you may want something faster. A number of other parsing libraries for Scala are available -- [see list on Scaladex](https://index.scala-lang.org/awesome/parsing?sort=stars). From 908716c3c9eea1d4aac4c079d8232638af394cc0 Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Thu, 26 Jan 2023 09:25:39 -0800 Subject: [PATCH 3/4] add one more bullet --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a55b21e0..4cf8b9b6 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,9 @@ This library's main strengths are: Its main weaknesses are: -* Minimal feature set. * Performance. If you are ingesting large amounts of data, you may want something faster. +* Minimal feature set. +* Inflexible, unstructured error reporting. A number of other parsing libraries for Scala are available -- [see list on Scaladex](https://index.scala-lang.org/awesome/parsing?sort=stars). From 04952746cdc5fbb0452b1a87245a2e53d7f0a73b Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Thu, 26 Jan 2023 10:11:07 -0800 Subject: [PATCH 4/4] add matrix bullet --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 4cf8b9b6..bd0377c0 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ This library's main strengths are: * Stability. It's been around and in wide use for more than a decade. * The codebase is modest in size and its internals are fairly simple. * It's plain vanilla Scala. No macros, code generation, or other magic is involved. +* All versions of Scala (2.11, 2.12, 2.13, 3) are supported on all back ends (JVM, JS, Native). Its main weaknesses are: