feat(api): annotate code-valued string parameters with [StringSyntax] - #3367
Open
Simon Cropp (SimonCropp) wants to merge 1 commit into
Open
Simon Cropp (SimonCropp) wants to merge 1 commit into
Simon Cropp (SimonCropp) wants to merge 1 commit into
Conversation
Parameters and options holding JavaScript, CSS, HTML or a URL - the expression passed to EvaluateAsync, the html passed to SetContentAsync, AddStyleTagOptions .Content and so on - are now annotated, so IDEs inject and highlight that language inside the string literal. API/Generated is deleted and recreated on every roll, so the annotations are applied by a new patch-string-syntax step in build.sh rather than by the upstream generator. Every rule has to match at least once, so a signature that changes shape upstream fails the roll instead of silently losing its annotation. StringSyntaxAttribute ships in the .NET 7+ BCL and is unavailable on netstandard2.0, so an internal polyfill is included.
This file contains hidden or 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
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.
Parameters and options holding JavaScript, CSS, HTML or a URL - the expression passed to EvaluateAsync, the html passed to SetContentAsync, AddStyleTagOptions .Content and so on - are now annotated, so IDEs inject and highlight that language inside the string literal.
API/Generated is deleted and recreated on every roll, so the annotations are applied by a new patch-string-syntax step in build.sh rather than by the upstream generator. Every rule has to match at least once, so a signature that changes shape upstream fails the roll instead of silently losing its annotation.
StringSyntaxAttribute ships in the .NET 7+ BCL and is unavailable on netstandard2.0, so an internal polyfill is included.