Skip to content

Commit b4e2ccb

Browse files
committed
Polish readme text
1 parent 74b4358 commit b4e2ccb

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ For each named jOOQ configuration declared in the build, the plugin adds a task
1414
generated Java sources in the matching source set, if existing. The code generation tasks participate
1515
in [task configuration avoidance](https://docs.gradle.org/current/userguide/task_configuration_avoidance.html),
1616
in [build configuration caching](https://docs.gradle.org/nightly/userguide/configuration_cache.html),
17-
in [incremental builds](https://docs.gradle.org/current/userguide/more_about_tasks.html#sec:up_to_date_checks),
17+
in [incremental builds](https://docs.gradle.org/current/userguide/incremental_build.html),
1818
in [task output caching](https://docs.gradle.org/current/userguide/build_cache.html),
1919
and in [toolchains](https://docs.gradle.org/current/userguide/toolchains.html). The plugin can be applied on both Java projects and Android projects.
2020

@@ -39,9 +39,8 @@ The following functionality is provided by the jOOQ plugin:
3939

4040
The following Gradle configuration changes are contributed by the jOOQ plugin:
4141

42-
* Add the `org.jooq:jooq-codegen` dependency needed to execute the jOOQ code generation tool to the new `jooqGenerate` configuration
43-
* Add the `org.jooq:jooq` dependency to the name-matching `implementation` configuration to successfully compile the Java sources generated from the database schema
44-
* Use the customizable jOOQ version across all resolved `org.jooq*:jooq*` dependencies
42+
* Add the `<edition>:jooq-codegen:<version>` dependency needed to execute the jOOQ code generation tool to the new `jooqGenerate` configuration
43+
* Add the `<edition>:jooq:<version>` dependency to the name-matching `implementation` configuration to successfully compile the Java sources generated from the database schema
4544

4645
The following Gradle features are supported by the jOOQ plugin:
4746

@@ -109,9 +108,11 @@ dependencies {
109108

110109
## Specifying the jOOQ version and edition
111110

112-
Specify the version and [edition](https://github.com/etiennestuder/gradle-jooq-plugin/blob/master/src/main/groovy/nu/studer/gradle/jooq/JooqEdition.java) that should be applied to all jOOQ dependencies that are declared in your project either explicitly or pulled in transitively.
111+
Specify the version and [edition](https://github.com/etiennestuder/gradle-jooq-plugin/blob/master/src/main/groovy/nu/studer/gradle/jooq/JooqEdition.java) of the jOOQ dependencies automatically added by the plugin.
113112

114-
Note that the `org.jooq:jooq` dependency of the specified version and edition is automatically added to the `implementation` configuration of the source set that matches the name of the declared jOOQ configuration.
113+
The `<edition>:jooq-codegen:<version>` dependency of the specified version and edition is automatically added to the `jooqGenerator` configuration.
114+
115+
The `<edition>:jooq:<version>` dependency of the specified version and edition is automatically added to the `implementation` configuration of the source set that matches the name of the declared jOOQ configuration, if any.
115116

116117
### Gradle Groovy DSL
117118

@@ -133,15 +134,16 @@ jooq {
133134

134135
## Enforcing the jOOQ configuration XML schema version
135136

136-
Enforce a certain version of the jOOQ configuration XML schema by declaring what version of the jOOQ code generation tool to
137-
make available to the jOOQ plugin at configuration time, i.e. in the DSL of the jOOQ plugin.
137+
Enforce a certain version of the jOOQ configuration XML schema that is different to the default version and edition
138+
configured by the jOOQ plugin by declaring what version of the jOOQ code generation tool to make available to the
139+
jOOQ plugin at configuration time, i.e. in the DSL of the jOOQ plugin.
138140

139141
### Gradle Groovy DSL
140142

141143
```groovy
142144
buildscript {
143145
configurations['classpath'].resolutionStrategy.eachDependency {
144-
if (requested.group == 'org.jooq') {
146+
if (requested.group.startsWith('org.jooq') && requested.name.startsWith('jooq')) {
145147
useVersion '3.17.3'
146148
}
147149
}
@@ -153,7 +155,7 @@ buildscript {
153155
```kotlin
154156
buildscript {
155157
configurations["classpath"].resolutionStrategy.eachDependency {
156-
if (requested.group == "org.jooq") {
158+
if (requested.group.startsWith("org.jooq") && requested.name.startsWith("jooq")) {
157159
useVersion("3.17.3")
158160
}
159161
}

example/specify_jooq_config_xml_schema_version/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
buildscript {
22
configurations['classpath'].resolutionStrategy.eachDependency {
3-
if (requested.group == 'org.jooq') {
3+
if (requested.group.startsWith('org.jooq') && requested.name.startsWith('jooq')) {
44
// set jOOQ version used at configuration time to enforce a specific jOOQ config XML schema version
55
useVersion '3.16.1'
66
}

0 commit comments

Comments
 (0)