Add debug info and typed context to CodeWriter #1095
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
This commit introduces typed properties for CodeWriter, allowing context properties to be retrieved and assert they are a specific type. While implementing this, I realized that if there is a type mismatch, it could be hard to track down where in the process of writing code the error occurred. So this commit also introduces some open debugging facilities to CodeWriter that includes information about the state of the CodeWriter (a '/' delimited path to the current state in the stack of pushed states), the last N lines of code written (defaults to 2), and any additional metadata subclasses want to introduce. This information is then presented when CodeWriterDebugInfo is cast to a string. Most exceptions thrown by CodeWriter will now include this debug output.
CodegenWriter is supposed to be an opinionated implementation of CodeWriter that automatically brings Symbols and imports together with a CodeWriter. This commit adds a built-in "T" formatter for handling Symbol and SymbolReference objects. This should work for most Smithy codegen implementations, but the ones that it doesn't can either override the "T" formatter or not use CodegenWriter.
adamthom-amzn
approved these changes
Feb 21, 2022
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.
This commit introduces typed properties for CodeWriter, allowing context
properties to be retrieved and assert they are a specific type.
While implementing this, I realized that if there is a type mismatch, it
could be hard to track down where in the process of writing code the error
occurred. So this commit also introduces some open debugging facilities
to CodeWriter that includes information about the state of the
CodeWriter (a '/' delimited path to the current state in the stack of
pushed states), the last N lines of code written (defaults to 2), and
any additional metadata subclasses want to introduce. This information
is then presented when CodeWriterDebugInfo is cast to a string.
Most exceptions thrown by CodeWriter will now include this debug output.
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.