Rename Transformer to ResourceTransformer#1288
Merged
Conversation
Contributor
There was a problem hiding this comment.
PR Overview
This PR implements a breaking change by renaming the class Transformer to ResourceTransformer to better reflect its purpose and avoid conflicts with similarly named classes from other libraries.
- Renamed Transformer to ResourceTransformer in documentation.
- Updated the changelog to indicate the breaking change.
Reviewed Changes
| File | Description |
|---|---|
| src/docs/changes/README.md | Updated changelog marking the breaking change. |
Copilot reviewed 21 out of 21 changed files in this pull request and generated no comments.
ec7b77d to
f80ef11
Compare
Contributor
There was a problem hiding this comment.
PR Overview
This PR renames the interface from Transformer to ResourceTransformer to better reflect its role and align with established naming in related projects.
- Update changelog entry to indicate the breaking change.
- Update documentation examples by adjusting import statements and interface implementations.
Reviewed Changes
| File | Description |
|---|---|
| src/docs/changes/README.md | Updated changelog entry to reflect the renaming. |
| src/docs/configuration/merging/README.md | Revised import statements and interface implementation in examples. |
Copilot reviewed 24 out of 24 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (3)
src/docs/configuration/merging/README.md:12
- [nitpick] Consider updating this comment to '// Adding a ResourceTransformer' to reflect the renaming and avoid potential confusion.
// Adding a Transformer
src/docs/configuration/merging/README.md:41
- [nitpick] Consider updating this comment to '// Configuring a ResourceTransformer' for consistency with the renamed interface.
// Configuring a Transformer
src/docs/configuration/merging/README.md:74
- [nitpick] Consider updating this comment to '// Adding a ResourceTransformer Instance' to clearly convey the updated type.
// Adding a Transformer Instance
Aims to better align with the name of [org.apache.maven.plugins.shade.resource.ResourceTransformer.java](https://github.com/apache/maven-shade-plugin/blob/master/src/main/java/org/apache/maven/plugins/shade/resource/ResourceTransformer.java) and to distinguish itself from [org.gradle.api.Transformer.java](https://docs.gradle.org/current/javadoc/org/gradle/api/Transformer.html).
f80ef11 to
8f38bf5
Compare
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
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.
Aims to better align with the name of org.apache.maven.plugins.shade.resource.ResourceTransformer.java and to distinguish itself from org.gradle.api.Transformer.java.