Fix CodeWriter backwards compatibility #1123
Merged
Conversation
This file contains 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
mtdowling
requested changes
Mar 9, 2022
smithy-utils/src/main/java/software/amazon/smithy/utils/TypedCodeWriter.java
Outdated
Show resolved
Hide resolved
smithy-utils/src/main/java/software/amazon/smithy/utils/TypedCodeWriter.java
Outdated
Show resolved
Hide resolved
adamthom-amzn
force-pushed
the
fork-codewriter
branch
from
b8d1cf6 to
e20304f
Compare
adamthom-amzn
changed the title
adamthom-amzn
force-pushed
the
fork-codewriter
branch
2 times, most recently
from
3ed4fb3 to
a418430
Compare
mtdowling
requested changes
Mar 10, 2022
smithy-utils/src/main/java/software/amazon/smithy/utils/SimpleCodeWriter.java
Show resolved
Hide resolved
...re/src/main/java/software/amazon/smithy/codegen/core/writer/AbstractDocumentationWriter.java
Outdated
Show resolved
Hide resolved
...degen-core/src/main/java/software/amazon/smithy/codegen/core/writer/DocumentationWriter.java
Show resolved
Hide resolved
...ain/java/software/amazon/smithy/codegen/core/writer/JavaStyleDocumentationWriterBuilder.java
Show resolved
Hide resolved
smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/writer/DocWriter.java
Show resolved
Hide resolved
smithy-codegen-core/src/main/java/software/amazon/smithy/codegen/core/writer/CodegenWriter.java
Show resolved
Hide resolved
...degen-core/src/main/java/software/amazon/smithy/codegen/core/writer/SimpleCodegenWriter.java
Outdated
Show resolved
Hide resolved
mtdowling
approved these changes
Mar 10, 2022
Adding a parent of CodeWriter that changed the return type of its methods, even though those returned objects were always in practice the same type as they had been before, broke binary backwards compatibility for consumers of CodeWriter. This returns CodeWriter back to its previous state, mostly, and adds a new default extension of AbstractCodeWriter called SimpleCodeWriter. Current consumers of CodeWriter will continue to work, and have access to some new features.
adamthom-amzn
force-pushed
the
fork-codewriter
branch
from
a418430 to
a2d0eea
Compare
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.
Description of changes:
Adding a parent of CodeWriter that changed the return type of its methods, even
though those returned objects were always in practice the same type as they had
been before, broke binary backwards compatibility for consumers of CodeWriter.
This forks CodeWriter back to its previous state, mostly, and adds a new
default extension of AbstractCodeWriter called TypedCodeWriter. Current
consumers of CodeWriter will continue to work, and have access to some new
features, such as the C formatter (though their Consumer will receive an
AbstractCodeWriter, not CodeWriter), and will keep onSectionPrepend and
onSectionAppend, but not have access to typed sections.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.