feat(rosetta): transliterate loose mode #2892
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
When transliterating code samples from a published package tarball, supporting files such as fixtures and literate source files may be missing (typically because they are part of the `.npmignore` file). The new `--loose` option to `jsii transliterate` allows ignoring those problems by: - Ignoring missing fixtures (the behavior is then the same as if no fixture was requested) - Falling back to the `.lit.js` file when the `.lit.ts` file cannot be found, or replacing the source with a placeholder if neither file could be found
iliapolo
reviewed
Jun 29, 2021
| // In loose mode, we'll fall back to the `.js` file if it exists... | ||
| const jsFile = fullPath.replace(/\.ts(x?)$/, '.js$1'); | ||
| if (fs.existsSync(jsFile)) { | ||
| return fs.readFileSync(jsFile, { encoding: 'utf-8' }); |
There was a problem hiding this comment.
Maybe add a header here saying we are showing js code because the expected file is missing?
There was a problem hiding this comment.
There is unfortunately no way to reliably do this... Leading comments will be ignored if they are not attached to a render-able statement, which may not even exist.
iliapolo
approved these changes
Jun 29, 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.
When transliterating code samples from a published package tarball,
supporting files such as fixtures and literate source files may be
missing (typically because they are part of the
.npmignorefile).The new
--looseoption tojsii transliterateallows ignoring thoseproblems by:
fixture was requested)
.lit.jsfile when the.lit.tsfile cannot befound, or replacing the source with a placeholder if neither file
could be found
This addresses the issue outlined in cdklabs/construct-hub#127
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.