fix(jsii): prohibit exported const enums #372
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
'const enums' are inlined at the usage site by TypeScript and so the generated type will not be in the JavaScript source code in the assembly, even though the declaration will be there. This leads to "symbol not found" errors upon trying to load it. https://www.typescriptlang.org/docs/handbook/enums.html#const-enums Fixes aws/aws-cdk#1969
RomainMuller
reviewed
Mar 7, 2019
| this._diagnostic(decl, | ||
| ts.DiagnosticCategory.Error, | ||
| `Exported enum cannot be declared 'const'`); | ||
| } |
There was a problem hiding this comment.
Should we return from there? So we don't include it in the .jsii assembly we'd create?
RomainMuller
approved these changes
Mar 7, 2019
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.
'const enums' are inlined at the usage site by TypeScript and so the
generated type will not be in the JavaScript source code in the
assembly, even though the declaration will be there.
This leads to "symbol not found" errors upon trying to load it.
Ref: https://www.typescriptlang.org/docs/handbook/enums.html#const-enums
Related: aws/aws-cdk#1969
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.