Skip to content

Commit c1db440

Browse files
committed
Mark jakarta.json as implementation dep
This is used internally, so it shouldn't need to be exposed to the caller. However it's likely that the caller still needs to bring their own implementation. Use org.eclipse.parsson:parsson:1.1.1 unless you have other preferences.
1 parent 07b9f46 commit c1db440

File tree

2 files changed

+21
-7
lines changed

2 files changed

+21
-7
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,25 @@ data from JSON Strings or files in parameterized tests.
2020
### Apache Maven
2121

2222
```xml
23-
<dependency>
24-
<groupId>net.joshka</groupId>
25-
<artifactId>junit-json-params</artifactId>
26-
<version>5.9.2-r0</version>
27-
</dependency>
23+
<dependencies>
24+
<dependency>
25+
<groupId>net.joshka</groupId>
26+
<artifactId>junit-json-params</artifactId>
27+
<version>5.9.2-r1</version>
28+
</dependency>
29+
<dependency>
30+
<groupId>org.eclipse.parsson</groupId>
31+
<artifactId>parsson</artifactId>
32+
<version>1.1.1</version>
33+
</dependency>
34+
</dependencies>
2835
```
2936

3037
### Gradle
3138

3239
```groovy
33-
compile 'net.joshka:junit-json-params:5.9.2-r0'
40+
testImplementation 'net.joshka:junit-json-params:5.9.2-r0'
41+
testImplementation 'org.eclipse.parsson:parsson:1.1.1'
3442
```
3543

3644
## Examples

build.gradle

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,13 @@ dependencies {
3333
api platform('org.junit:junit-bom:5.9.2')
3434
api 'org.junit.jupiter:junit-jupiter-api'
3535
api 'org.junit.jupiter:junit-jupiter-params'
36-
api 'jakarta.json:jakarta.json-api:2.1.1'
36+
37+
// jakarta.json-api is not exposed on any public members, so does not need
38+
// to be exposed to use the library
39+
implementation 'jakarta.json:jakarta.json-api:2.1.1'
40+
41+
// this is the reference implementation of jakarta.json, a consumer of this
42+
// library needs to bring their own version (probably this)
3743
testImplementation 'org.eclipse.parsson:parsson:1.1.1'
3844
testImplementation 'org.junit.jupiter:junit-jupiter-engine'
3945
testImplementation 'org.assertj:assertj-core:3.24.2'

0 commit comments

Comments
 (0)