Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit da73dcc

Browse files
authored
Merge pull request #388 from SethTisue/readme-2.0
readme updates, post-2.0.0
2 parents eb606c5 + c742e6b commit da73dcc

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
# scala-parser-combinators
22

33
[<img src="https://img.shields.io/travis/scala/scala-parser-combinators.svg"/>](https://travis-ci.org/scala/scala-parser-combinators)
4-
[<img src="https://img.shields.io/maven-central/v/org.scala-lang.modules/scala-parser-combinators_2.11.svg?label=latest%20release%20for%202.11"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-parser-combinators_2.11)
54
[<img src="https://img.shields.io/maven-central/v/org.scala-lang.modules/scala-parser-combinators_2.12.svg?label=latest%20release%20for%202.12"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3Aorg.scala-lang.modules%20a%3Ascala-parser-combinators_2.12)
65
[<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)
6+
[<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)
77

88
### Scala Standard Parser Combinator Library
99

1010
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).
1111

12-
The latest stable release is 1.1.2.
13-
14-
The 1.2.0-RCx series supports Scala 3.
12+
The latest stable release is 2.0.0.
1513

1614
## Documentation
1715

18-
* [Current API](https://javadoc.io/page/org.scala-lang.modules/scala-parser-combinators_2.12/latest/scala/util/parsing/combinator/index.html)
16+
* [Current API](https://javadoc.io/page/org.scala-lang.modules/scala-parser-combinators_2.13/latest/scala/util/parsing/combinator/index.html)
1917
* The [Getting Started](docs/Getting_Started.md) guide
2018
* A more complicated example, [Building a lexer and parser with Scala's Parser Combinators](https://enear.github.io/2016/03/31/parser-combinators/)
2119
* "Combinator Parsing", chapter 33 of [_Programming in Scala, Third Edition_](http://www.artima.com/shop/programming_in_scala), shows how to apply this library to e.g. parsing of arithmetic expressions. The second half of the chapter examines how the library is implemented.
@@ -24,7 +22,7 @@ The 1.2.0-RCx series supports Scala 3.
2422
To depend on scala-parser-combinators in sbt, add something like this to your build.sbt:
2523

2624
```
27-
libraryDependencies += "org.scala-lang.modules" %% "scala-parser-combinators" % "1.1.2"
25+
libraryDependencies += "org.scala-lang.modules" %% "scala-parser-combinators" % "2.0.0"
2826
```
2927

3028
To support multiple Scala versions, see the example in [scala/scala-module-dependency-sample](https://github.com/scala/scala-module-dependency-sample).
@@ -34,7 +32,7 @@ To support multiple Scala versions, see the example in [scala/scala-module-depen
3432
Scala-parser-combinators is also available for Scala.js and Scala Native:
3533

3634
```
37-
libraryDependencies += "org.scala-lang.modules" %%% "scala-parser-combinators" % "1.1.2"
35+
libraryDependencies += "org.scala-lang.modules" %%% "scala-parser-combinators" % "2.0.0"
3836
```
3937

4038
## Example

build.sbt

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,21 @@ lazy val parserCombinators = crossProject(JVMPlatform, JSPlatform, NativePlatfor
1111
.settings(
1212
ScalaModulePlugin.scalaModuleSettings,
1313
name := "scala-parser-combinators",
14+
15+
// once https://github.com/lightbend/mima/issues/630 is fixed and sbt-scala-module
16+
// adopts the fixed version, we'll be able to just do:
17+
// scalaModuleMimaPreviousVersion := Some("2.0.0"),
18+
// but for the time being we must still:
1419
scalaModuleMimaPreviousVersion := (CrossVersion.partialVersion(scalaVersion.value) match {
15-
// pending resolution of https://github.com/scalacenter/sbt-version-policy/issues/62
16-
case Some((3, _)) => None
17-
case _ => Some("1.2.0-RC1")
18-
}),
20+
// pending resolution of https://github.com/scalacenter/sbt-version-policy/issues/62
21+
case Some((3, _)) => None
22+
case _ => Some("1.2.0-RC1")
23+
}),
1924

2025
libraryDependencies += "junit" % "junit" % "4.13.2" % Test,
2126
libraryDependencies += "com.novocode" % "junit-interface" % "0.11" % Test,
2227
// so we can `@nowarn` in test code, but only in test code, so the dependency
23-
// doesn't leak downstream
28+
// doesn't leak downstream. can be dropped when we drop 2.11 from the crossbuild
2429
libraryDependencies += "org.scala-lang.modules" %% "scala-collection-compat" % "2.4.4" % Test,
2530

2631
apiMappings ++= scalaInstance.value.libraryJars.collect {

0 commit comments

Comments
 (0)