Skip to content

Commit 5980250

Browse files
jjohannesjjohannes
committed
Initial version 0.1 of plugin
0 parents  commit 5980250

File tree

95 files changed

+5421
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+5421
-0
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.gradle
2+
.idea
3+
build

‎LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2019 Louis Jacomet
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.MD

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Gradle Plugin: Java Module Dependencies
2+
3+
A Gradle 7.2+ plugin to make Gradle use dependencies from _module-info.java_ files automatically.
4+
If you have a project that fully uses Java Modules, you do **not** need to declare dependencies in the `dependencies {}` block anymore.
5+
Gradle will use the information from your `module-info.java` directly.
6+
7+
Furthermore, you manage the versions of the module dependencies in a central place by employing the `[version]` block
8+
of Gradle's new [version catalog](https://docs.gradle.org/current/userguide/platforms.html#sub:version-catalog) feature.
9+
10+
# How to use?
11+
12+
You can find a full example here: [samples/basic](samples/basic)
13+
14+
For general information about how to structure Gradle builds and apply community plugins like this one to all subprojects
15+
you can check out my [Understanding Gradle video series](https://www.youtube.com/playlist?list=PLWQK2ZdV4Yl2k2OmC_gsjDpdIBTN0qqkE).
16+
17+
## Plugin dependency
18+
19+
Add this to the build file of your convention plugin's build
20+
(e.g. `build-logic/build.gradle(.kts)` or `buildSrc/build.gradle(.kts)`).
21+
22+
```
23+
dependencies {
24+
implementation("de.jjohannes.gradle:java-module-dependencies:0.1")
25+
}
26+
```
27+
28+
## Apply the plugin
29+
30+
In your convention plugin, apply the plugin.
31+
32+
```
33+
plugins {
34+
...
35+
id("de.jjohannes.java-module-dependencies")
36+
}
37+
```
38+
39+
## Add Module Name mapping information (if needed)
40+
41+
You may define additional mappings from _module name_ to _group:name (GA) coordinates_.
42+
The plugin already knows about all the _real_ modules available on Maven Central.
43+
That [information](src/main/resources/de/jjohannes/gradle/moduledependencies/modules.properties)
44+
is extracted from [modules.properties](https://github.com/sormuras/modules/blob/4eddb1225ee534e108075df1f1eed4b6f7ba1c5c/com.github.sormuras.modules/com/github/sormuras/modules/modules.properties)
45+
by [@sormuras](https://github.com/sormuras).
46+
47+
```
48+
// optional configuration if required
49+
javaModuleDependencies {
50+
// Make an automatic module known
51+
moduleNameToGA.put("org.apache.commons.lang3", "org.apache.commons:commons-lang3")
52+
// Do not warn if a module version is not know
53+
warnForMissingVersions.set(false)
54+
}
55+
```
56+
57+
## Modules in the build (module name = name + . + group)
58+
59+
This plugin makes the following assumption about _Module Names_ of your own modules in the build to establish dependencies between them:
60+
61+
- **Module Name** == `"${project.name}.${project.group}"`
62+
63+
A project name is determined by the `include(projectName)` statement in the settings file.
64+
The group is defined via the `group = ...` statement in the build files / convention plugin.
65+
This corresponds to how GA coordinates are typically mapped to module names.
66+
67+
## Defining module versions
68+
69+
Versions are defined in `[version]` block of a dependencies [version catalog](https://docs.gradle.org/current/userguide/platforms.html#sub:version-catalog).
70+
- *Note 1:* Since `.` is not supported, you need to use `_` as delimiter in the module names.
71+
- *Note 2:* Version catalogs are a preview feature right now and you have to enable them via `enableFeaturePreview("VERSION_CATALOGS")` in _settings.gradle(.kts)_.
72+
73+
**gradle/libs.versions.toml**
74+
```
75+
[versions]
76+
org_apache_xmlbeans = "5.0.1"
77+
com_fasterxml_jackson_databind = "2.12.5"
78+
org_slf4j = "1.7.32"
79+
80+
org_junit_jupiter_api = "5.7.2"
81+
```
82+
83+
## Custom version management
84+
85+
You may map a module name to the corresponding GA coordinates using `javaModuleDependencies.ga("my.module.name")`.
86+
You can for example use this to define dependency versions by other means (e.g. dependency constraints).
87+
If you want to do that, you can disable the warnings about missing versions and catalog by
88+
`javaModuleDependencies.warnForMissingVersions.set(false)`.
89+
90+
## Using Gradle's configuration cache
91+
92+
This plugin reads all your `module-info.java` files during build configuration.
93+
This is, because they provide the additional dependency information for setting up the build correctly.
94+
The files are rather small and we do not extract all the information from them (only the dependencies).
95+
Therefore, it should not have much configuration time performance impact even on larger builds.
96+
97+
However, if you enable (the currently experimental) [configuration cache](https://docs.gradle.org/current/userguide/configuration_cache.html)
98+
feature of Gradle, the result of the configuration phase is cached, avoiding parsing `module-info.java` files again in a successive build run.
99+
100+
```
101+
org.gradle.unsafe.configuration-cache=true
102+
```
103+

‎build.gradle.kts

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
plugins {
2+
id("java-gradle-plugin")
3+
id("maven-publish")
4+
id("com.gradle.plugin-publish") version "0.16.0"
5+
}
6+
7+
group = "de.jjohannes.gradle"
8+
version = "0.1"
9+
10+
java {
11+
toolchain.languageVersion.set(JavaLanguageVersion.of(9))
12+
}
13+
14+
dependencies {
15+
testImplementation("org.gradle.exemplar:samples-check:1.0.0")
16+
}
17+
18+
gradlePlugin {
19+
plugins {
20+
create(project.name) {
21+
id = "de.jjohannes.java-module-dependencies"
22+
implementationClass = "de.jjohannes.gradle.moduledependencies.JavaModuleDependenciesPlugin"
23+
displayName = "Java Module Dependencies"
24+
description = "A plugin that makes Gradle respect the dependencies defined in 'module-info.java' files."
25+
}
26+
}
27+
}
28+
29+
pluginBundle {
30+
website = "https://github.com/jjohannes/java-module-dependencies"
31+
vcsUrl = "https://github.com/jjohannes/java-module-dependencies.git"
32+
tags = listOf("java", "modularity", "jigsaw", "jpms", "dependencies", "versions")
33+
}
34+
35+
tasks.test {
36+
inputs.dir(layout.projectDirectory.dir("samples"))
37+
}

‎gradle.properties

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
org.gradle.caching=true
2+
org.gradle.parallel=true

‎gradle/wrapper/gradle-wrapper.jar

58.1 KB
Binary file not shown.

‎gradle/wrapper/gradle-wrapper.properties

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists

0 commit comments

Comments
 (0)