fix(rosetta): fails on "Debug Failure" #2917
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 cases where a literate source file was missing, the substitution value was not valid TypeScript, which could cause the comipler to fail on an opaque error (`Debug Failure`). This changes the substitution text to make it more clear that an example could not be rendered because the source for it could not be found, and also makes sure to rescue the `Debug Failure` where it is emitted from, that is in the call to `program.getDeclarationDiagnostics`. Both of this changes result in greater chances of transliteration success. Related to cdklabs/jsii-docgen#369
iliapolo
approved these changes
Jul 21, 2021
RomainMuller
removed
the
pr/do-not-merge
iliapolo
approved these changes
Jul 21, 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)... |
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 cases where a literate source file was missing, the substitution
value was not valid TypeScript, which could cause the comipler to fail
on an opaque error (
Debug Failure).This falls back to the visible code for the snippet instead of inserting a
placeholder, and also makes sure to rescue the
Debug Failurewhereit is emitted from, that is in the call to
program.getDeclarationDiagnostics.Both of this changes result in greater chances of transliteration
success.
Related to cdklabs/jsii-docgen#369
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.