Declare api and implementation dependencies to better align with code usages #1574
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…cy on labkey-client-api
labkey-susanh
requested review from
labkey-adam,
labkey-jeckels and
labkey-tchad
This was referenced Sep 17, 2020
Merged
Merged
Merged
Merged
labkey-jeckels
approved these changes
Sep 17, 2020
api/build.gradle
Outdated
|
|
||
| List charting = [ | ||
| "org.jfree:jfreechart:${jfreechartVersion}" | ||
| "org.jfree:jfreechart:${jfreechartVersion}", |
Contributor
There was a problem hiding this comment.
Intentional trailing comma?
labkey-adam
approved these changes
Sep 17, 2020
api/build.gradle
Outdated
|
|
||
| List charting = [ | ||
| "org.jfree:jfreechart:${jfreechartVersion}" | ||
| "org.jfree:jfreechart:${jfreechartVersion}", |
labkey-tchad
approved these changes
Sep 21, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rationale
It is generally best practice to explicitly declare dependencies that are used in your code rather than relying on transitive dependencies to supply them for you if for no other reason than it documents what is in use. Though in reality the risk of these transitive dependencies disappearing is low and would usually be easily noticed, the declaration of proper
apidependencies will assure that our publishedpomfiles are accurate and others will not have to separately declare some dependencies that we rely on when using our jar files.The changes made here were done with the help of this Gradle dependency-analysis plugin, which is still not at v1.0 and seems to have a few quirks, but my spot checks of the suggestions given seem like they provide solid advice.
Some of the dependencies we have been declaring in the
apimodule are no longer (perhaps never were) used within that module, so a few other modules have been updated to include these dependencies. This means, of course, that some jar files will be included twice for certain distributions, but there are not many and this is part of the price of keeping things modular. However, if the repetition of things likecommons-math3seems cumbersome or silly we can go back to including these inapi(at least for now), but it is really best practice to own up to your dependencies.Related Pull Requests
Changes