Add CodegenWriter abstractions #587
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
force-pushed
the
file-delegator
branch
2 times, most recently
from
19d56bb to
d7a921f
Compare
mtdowling
force-pushed
the
file-delegator
branch
from
d7a921f to
3434273
Compare
kstich
reviewed
Oct 9, 2020
smithy-utils/src/main/java/software/amazon/smithy/utils/CodeWriter.java
Outdated
Show resolved
Hide resolved
rcoh
reviewed
Oct 12, 2020
...en-core/src/main/java/software/amazon/smithy/codegen/core/writer/UseShapeWriterObserver.java
Outdated
Show resolved
Hide resolved
CodegenWriter, CodegenWriterDelegator, et al. are meant to make it easier to develop code generators that utilize Smithy's Symbol, SymbolReference, and SymbolDependency abstractions. CodegenWriterDelegator provides abstractions for creating and handing out references to CodegenWriters while collecting all of the imports needed for an entire project. CodegenWriter is used to write code, symbols, documentation, and manage the imports needed for a specific file. Other abstractions were added that make it easier to build-up and compose CodegenWriters and delegators, for example, the JavaStyleDocumentationWriter can make it easier to implement writing documentation for programming languages that use Java-style comments.
mtdowling
force-pushed
the
file-delegator
branch
from
3434273 to
ac7e907
Compare
kstich
approved these changes
Oct 12, 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.
CodegenWriter, CodegenWriterDelegator, et al. are meant to make it
easier to develop code generators that utilize Smithy's Symbol,
SymbolReference, and SymbolDependency abstractions.
CodegenWriterDelegator provides abstractions for creating and handing
out references to CodegenWriters while collecting all of the imports
needed for an entire project. CodegenWriter is used to write code,
symbols, documentation, and manage the imports needed for a specific
file. Other abstractions were added that make it easier to build-up and
compose CodegenWriters and delegators, for example, the
JavaStyleDocumentationWriter can make it easier to implement writing
documentation for programming languages that use Java-style comments.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.