Improve CodeWriter newlines and indentation #529
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 simplifies and improves how the CodeWriter handles the automatic injection of newlines and indentation. Now, the *only* difference between write() and writeInline() is that write() appends a newline (there was previously a lot of special-cased code for writeInline). * writeInline() now properly handles indentation when necessary (e.g., if a previous call injected a newline). This includes a few edge cases like if the first call to the CodeWriter is to writeInline() and uses indentation. * The character used for newlines is now tracked by the current state rather than globally. * Trailing newlines are now *always* inserted to the given text if enabled There was a bug previously where they were not appended if the last call on the CodeWriter was a writeInline(). This could potentially affect usage of CodeWriters that only wrote with inline calls. * The automatic appending of a newline by methods like openBlock(), closeBlock(), and write() can now enabled or disabled using enableNewlines() and disableNewlines().
Would this allow additional helpers like openBlockInline to be defined, so I could have an inline block, but not add the trailing newline? |
|
I'm not 100% sure what |
CodeWriter can now configure the character used to start expressions in the current state, making it easier to generate code for language that give syntactic meaning to CodeWriter's default expression character, '$'.
kstich
approved these changes
Aug 17, 2020
Anything in particular we need to look out for w/ existing usage of CodeWriter? |
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 simplifies and improves how the CodeWriter handles the
automatic injection of newlines and indentation. Now, the only difference
between write() and writeInline() is that write() appends a newline
(there was previously a lot of special-cased code for writeInline).
a previous call injected a newline). This includes a few edge cases
like if the first call to the CodeWriter is to writeInline() and uses
indentation.
than globally.
There was a bug previously where they were not appended if the last call
on the CodeWriter was a writeInline(). This could potentially affect
usage of CodeWriters that only wrote with inline calls.
closeBlock(), and write() can now enabled or disabled using
enableNewlines() and disableNewlines().
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.