Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Transformer to ResourceTransformer #1288

Merged
merged 1 commit into from
Feb 27, 2025

Conversation

Goooler
Copy link
Member

@Goooler Goooler commented Feb 27, 2025

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.


  • CHANGELOG's "Unreleased" section has been updated, if applicable.

@Goooler Goooler requested a review from Copilot February 27, 2025 02:17

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Goooler Goooler force-pushed the g/20250227/rename-transformer branch 3 times, most recently from ec7b77d to f80ef11 Compare February 27, 2025 03:48
@Goooler Goooler requested a review from Copilot February 27, 2025 03:48

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).
@Goooler Goooler force-pushed the g/20250227/rename-transformer branch from f80ef11 to 8f38bf5 Compare February 27, 2025 03:50
@Goooler Goooler merged commit b8b320b into main Feb 27, 2025
7 checks passed
@Goooler Goooler deleted the g/20250227/rename-transformer branch February 27, 2025 04:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant