fix(rosetta): stop skipping example values #3128
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
In CDK, we use the `@example` tag a lot to indicate example values of some property, instead of code examples. For example, a `bucketArn` property might have as annotation `@example arn:aws:s3:....`. Rosetta would try to compile those, and fail. To get around this, we would skip values that *looked* like they weren't source in `rosetta extract`. This doesn't combine well with pacmak live-translation. We are either forced to try and compile them again during pacmak (adding compile time), or fail pacmak as soon as we encounter these. And all of this is to work around abuse of the `@example` tag for something it's not intended for. So stop treating these examples specially. They will just fail compilation unless rewritten. This will force us to deal with them properly in the CDK source code.
kaizencc
approved these changes
Nov 5, 2021
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
|
Merging (with squash)... |
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.
In CDK, we use the
@exampletag a lot to indicate example valuesof some property, instead of code examples. For example, a
bucketArnproperty might have as annotation
@example arn:aws:s3:.....Rosetta would try to compile those, and fail. To get around this, we would skip
values that looked like they weren't source in
rosetta extract.This doesn't combine well with pacmak live-translation. We are either forced to
try and compile them again during pacmak (adding compile time), or fail
pacmak as soon as we encounter these. And all of this is to work around
abuse of the
@exampletag for something it's not intended for.So stop treating these examples specially. They will just fail compilation
unless rewritten. This will force us to deal with them properly in the
CDK source code.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.