Stop allowing FileKind to be set on a RazorCodeDocument independently from the RazorParserOptions #11612
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
Move the GetFileKind and SetFileKind extension methods to RazorCodeDocument and make them instance methods backed by a simple field.
Add a RazorParserOptions.Create(...) convenience factory method to make it easier to create RazorParserOptions with different RazorLanguageVersion and FileKind values.
RazorCodeDocument already exposes ParserOptions.FileKind, so a separate mechanism for getting and setting the file kind is both unneeded and a potential source of bugs. Most of the changes are in tooling tests, which have unfortunately proliferated a bit of an anti-pattern for constructing code documents through copy-paste. I'll take a look at cleaning that up in a follow-up pull request. This change tries to keep test clean up to a minimum.
This is a purely mechanical change that makes the RazorCodeDocument.GetFileKind() a readonly, computed property that delegates to ParserOptions.FileKind.
This property is unused and it is less error-prone to only define it in a single place, i.e. RazorParserOptions.
There's just one use of RazorCodeGenerationOptions.Builder.LanguageVersion blocking its removal, and it can easily be removed.
This property is unused and it is less error-prone to only define it in a single place, i.e. RazorParserOptions.
For consistency with RazorParserOptions, add a RazorCodeGenerationOptions.Create(...) convenience factory method to make it easier to create new RazorCodeGenerationOptions.
chsienki
approved these changes
Mar 12, 2025
src/Compiler/Microsoft.AspNetCore.Razor.Language/test/RazorCodeDocumentExtensionsTest.cs
Outdated
Show resolved
Hide resolved
davidwengier
approved these changes
Mar 12, 2025
333fred
approved these changes
Mar 12, 2025
This was referenced Mar 13, 2025
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.
There are two extension methods targeting
RazorCodeDocumentthat allow consumers to set or get the file kind for the document. However, this can result in inconsistencies because that file kind value (stored inRazorCodeDocument.Items) is independent fromRazorCodeDocument.ParserOptions.FileKind. This PR removes both methods in favorRazorParserOptions.FileKind.Summary of changes:
GetFileKind()andSetFileKind(...)extension methods and expose a convenienceRazorCodeDocument.FileKindproperty that delegates toParserOptions.FileKind.RazorParserOptions.Create(...)andRazorCodeGenerationOptions.Create(...)convenience factory methods.LanguageVersionandFileKindfromRazorCodeGenerationOptionsto avoid the possibility of aRazorCodeDocumentcontaining parser options and code generation options that disagree about these values.SetFileKind(...)and pass the value as part ofRazorCodeDocumentcreation.Note
GetFileKind()andSetFileKind(...)are public extension methods but are not used by the RazorSdk, so they should be safe to remove.