Skip to content

Commit decd4d7

Browse files
authored
add library pros and cons to README (#500)
1 parent 537211c commit decd4d7

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,24 @@
44
[<img src="https://img.shields.io/maven-central/v/org.scala-lang.modules/scala-parser-combinators_2.13.svg?label=latest%20release%20for%202.13"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-parser-combinators_2.13)
55
[<img src="https://img.shields.io/maven-central/v/org.scala-lang.modules/scala-parser-combinators_3.svg?label=latest%20release%20for%203"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-parser-combinators_3)
66

7-
### Scala Standard Parser Combinator Library
7+
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).
88

9-
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).
9+
## Choosing a parsing library
10+
11+
This library's main strengths are:
12+
13+
* Stability. It's been around and in wide use for more than a decade.
14+
* The codebase is modest in size and its internals are fairly simple.
15+
* It's plain vanilla Scala. No macros, code generation, or other magic is involved.
16+
* All versions of Scala (2.11, 2.12, 2.13, 3) are supported on all back ends (JVM, JS, Native).
17+
18+
Its main weaknesses are:
19+
20+
* Performance. If you are ingesting large amounts of data, you may want something faster.
21+
* Minimal feature set.
22+
* Inflexible, unstructured error reporting.
23+
24+
A number of other parsing libraries for Scala are available -- [see list on Scaladex](https://index.scala-lang.org/awesome/parsing?sort=stars).
1025

1126
## Documentation
1227

@@ -68,7 +83,3 @@ For a detailed unpacking of this example see
6883
* Have a look at [existing issues](https://github.com/scala/scala-parser-combinators/issues)
6984
* Ask questions and discuss [in GitHub Discussions](https://github.com/scala/scala-parser-combinators/discussions)
7085
* Feel free to open draft pull requests with partially completed changes, to get feedback.
71-
72-
## Alternatives
73-
74-
A number of other parsing libraries for Scala are available; see https://index.scala-lang.org/awesome/parsing?sort=stars

0 commit comments

Comments
 (0)