feat(jsii): emit warnings when using reserved words #704
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
Emits warnings when an exported API is named after a reserved word in any of the supported target languages (best-effort). This warns users that their code may have toruble compiling for certain target languages and invites them to use a different name. Additionally, a `--fail-on-warnings` / `--Werr` option was added to the CLI that allows treating warnings as errors, allowing users to create and maintain a codebase that does not rely on naming things in ways that will cause conflicts in target languages. Fixes #701
skinny85
approved these changes
Aug 14, 2019
|
Thank you for contributing! ❤️ I will now look into making sure |
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.
Emits warnings when an exported API is named after a reserved word in
any of the supported target languages (best-effort). This warns users
that their code may have toruble compiling for certain target languages
and invites them to use a different name.
Additionally, a
--fail-on-warnings/--Werroption was added to theCLI that allows treating warnings as errors, allowing users to create
and maintain a codebase that does not rely on naming things in ways that
will cause conflicts in target languages.
Fixes #701
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.