Make decorators order independent #11380
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
…tadata({description: ...}) regardless of order
shenglol
reviewed
Jul 28, 2023
src/Bicep.Core/Analyzers/Linter/Rules/NoConflictingMetadataRule.cs
Outdated
Show resolved
Hide resolved
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.
Resolves #11308
This PR updates the TemplateWriter to apply type modifying decorators in a fixed order rather than one dependent on the order in which the decorators appear in the template's Bicep source.
Because
@metadata()and@description()may sometimes be in conflict with one another, TemplateWriter will now prefer whatever appears within the@description()decorator due to its higher specificity and to match the information shown in hovers/tooltips in such scenarios. A linter has been added that will warn template authors when@metadata()and@description()are in conflict.Microsoft Reviewers: codeflow:open?pullrequest=https://github.com/Azure/bicep/pull/11380&drop=dogfoodAlpha