RazorCodeDocument: Convert GetFileKind to non-nullable property

DustinCampbell · DustinCampbell · commit df86a5f91189 · 2025-03-12T10:57:48.000-07:00
This is a purely mechanical change that makes the RazorCodeDocument.GetFileKind() a readonly, computed property that delegates to ParserOptions.FileKind.
diff --git a/src/Compiler/Microsoft.AspNetCore.Razor.Language/test/DefaultRazorProjectEngineIntegrationTest.cs b/src/Compiler/Microsoft.AspNetCore.Razor.Language/test/DefaultRazorProjectEngineIntegrationTest.cs
@@ -153,7 +153,7 @@ public void Process_WithFileKind_SetsOnCodeDocument()
         var codeDocument = projectEngine.Process(RazorSourceDocument.ReadFrom(projectItem), "test", importSources: default, tagHelpers: null);
 
         // Assert
-        var actual = codeDocument.GetFileKind();
+        var actual = codeDocument.FileKind;
         Assert.Equal("test", actual);
     }
 
@@ -201,7 +201,7 @@ public void Process_SetsInferredFileKindOnCodeDocument_MvcFile()
         var codeDocument = projectEngine.Process(projectItem);
 
         // Assert
-        var actual = codeDocument.GetFileKind();
+        var actual = codeDocument.FileKind;
         Assert.Same(FileKinds.Legacy, actual);
     }
 
@@ -217,7 +217,7 @@ public void Process_SetsInferredFileKindOnCodeDocument_Component()
         var codeDocument = projectEngine.Process(projectItem);
 
         // Assert
-        var actual = codeDocument.GetFileKind();
+        var actual = codeDocument.FileKind;
         Assert.Same(FileKinds.Component, actual);
     }
 
@@ -288,7 +288,7 @@ public void ProcessDesignTime_SetsInferredFileKindOnCodeDocument_MvcFile()
         var codeDocument = projectEngine.ProcessDesignTime(projectItem);
 
         // Assert
-        var actual = codeDocument.GetFileKind();
+        var actual = codeDocument.FileKind;
         Assert.Same(FileKinds.Legacy, actual);
     }
 
@@ -304,7 +304,7 @@ public void ProcessDesignTime_SetsInferredFileKindOnCodeDocument_Component()
         var codeDocument = projectEngine.ProcessDesignTime(projectItem);
 
         // Assert
-        var actual = codeDocument.GetFileKind();
+        var actual = codeDocument.FileKind;
         Assert.Same(FileKinds.Component, actual);
     }
 
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Components/ComponentDocumentClassifierPass.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Components/ComponentDocumentClassifierPass.cs
@@ -47,7 +47,7 @@ public ComponentDocumentClassifierPass(RazorLanguageVersion version)
 
     protected override bool IsMatch(RazorCodeDocument codeDocument, DocumentIntermediateNode documentNode)
     {
-        return FileKinds.IsComponent(codeDocument.GetFileKind());
+        return FileKinds.IsComponent(codeDocument.FileKind);
     }
 
     protected override CodeTarget CreateTarget(RazorCodeDocument codeDocument, RazorCodeGenerationOptions options)
@@ -95,7 +95,7 @@ protected override void OnDocumentStructureCreated(
         @class.Modifiers.Add("public");
         @class.Modifiers.Add("partial");
 
-        if (FileKinds.IsComponentImport(codeDocument.GetFileKind()))
+        if (FileKinds.IsComponentImport(codeDocument.FileKind))
         {
             // We don't want component imports to be considered as real component.
             // But we still want to generate code for it so we can get diagnostics.
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Components/ComponentPageDirectivePass.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Components/ComponentPageDirectivePass.cs
@@ -38,7 +38,7 @@ protected override void ExecuteCore(RazorCodeDocument codeDocument, DocumentInte
         for (var i = 0; i < directives.Count; i++)
         {
             var directive = directives[i];
-            if (FileKinds.IsComponentImport(codeDocument.GetFileKind()) || directive.Node.IsImported())
+            if (FileKinds.IsComponentImport(codeDocument.FileKind) || directive.Node.IsImported())
             {
                 directive.Node.Diagnostics.Add(ComponentDiagnosticFactory.CreatePageDirective_CannotBeImported(directive.Node.Source.GetValueOrDefault()));
             }
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/DefaultDirectiveSyntaxTreePass.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/DefaultDirectiveSyntaxTreePass.cs
@@ -14,7 +14,7 @@ internal class DefaultDirectiveSyntaxTreePass : RazorEngineFeatureBase, IRazorSy
 
     public RazorSyntaxTree Execute(RazorCodeDocument codeDocument, RazorSyntaxTree syntaxTree)
     {
-        if (FileKinds.IsComponent(codeDocument.GetFileKind()))
+        if (FileKinds.IsComponent(codeDocument.FileKind))
         {
             // Nothing to do here.
             return syntaxTree;
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/DefaultRazorIntermediateNodeLoweringPhase.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/DefaultRazorIntermediateNodeLoweringPhase.cs
@@ -43,7 +43,7 @@ protected override void ExecuteCore(RazorCodeDocument codeDocument, Cancellation
         // We need to decide up front if this document is a "component" file. This will affect how
         // lowering behaves.
         LoweringVisitor visitor;
-        if (FileKinds.IsComponentImport(codeDocument.GetFileKind()) &&
+        if (FileKinds.IsComponentImport(codeDocument.FileKind) &&
             syntaxTree.Options.AllowComponentFileKind)
         {
             visitor = new ComponentImportFileKindVisitor(documentNode, builder, syntaxTree.Options)
@@ -53,7 +53,7 @@ protected override void ExecuteCore(RazorCodeDocument codeDocument, Cancellation
 
             visitor.Visit(syntaxTree.Root);
         }
-        else if (FileKinds.IsComponent(codeDocument.GetFileKind()) &&
+        else if (FileKinds.IsComponent(codeDocument.FileKind) &&
             syntaxTree.Options.AllowComponentFileKind)
         {
             visitor = new ComponentFileKindVisitor(documentNode, builder, syntaxTree.Options)
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/DefaultRazorTagHelperContextDiscoveryPhase_Pooling.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/DefaultRazorTagHelperContextDiscoveryPhase_Pooling.cs
@@ -52,7 +52,7 @@ internal static PooledDirectiveVisitor GetPooledVisitor(
         out DirectiveVisitor visitor)
     {
         var useComponentDirectiveVisitor = codeDocument.ParserOptions.AllowComponentFileKind &&
-                                           FileKinds.IsComponent(codeDocument.GetFileKind());
+                                           FileKinds.IsComponent(codeDocument.FileKind);
 
         if (useComponentDirectiveVisitor)
         {
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Extensions/FunctionsDirectivePass.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Extensions/FunctionsDirectivePass.cs
@@ -23,7 +23,7 @@ protected override void ExecuteCore(RazorCodeDocument codeDocument, DocumentInte
         var directiveNodes = new List<IntermediateNodeReference>();
         directiveNodes.AddRange(documentNode.FindDirectiveReferences(FunctionsDirective.Directive));
 
-        if (FileKinds.IsComponent(codeDocument.GetFileKind()))
+        if (FileKinds.IsComponent(codeDocument.FileKind))
         {
             directiveNodes.AddRange(documentNode.FindDirectiveReferences(ComponentCodeDirective.Directive));
         }
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/RazorCodeDocument.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/RazorCodeDocument.cs
@@ -15,6 +15,8 @@ public sealed class RazorCodeDocument
     public RazorParserOptions ParserOptions { get; }
     public RazorCodeGenerationOptions CodeGenerationOptions { get; }
 
+    public string FileKind => ParserOptions.FileKind;
+
     private RazorCodeDocument(
         RazorSourceDocument source,
         ImmutableArray<RazorSourceDocument> imports,
@@ -50,7 +52,4 @@ public static RazorCodeDocument Create(
 
         return new RazorCodeDocument(source, imports, parserOptions, codeGenerationOptions);
     }
-
-    public string? GetFileKind()
-        => ParserOptions.FileKind;
 }
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/RazorCodeDocumentExtensions.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/RazorCodeDocumentExtensions.cs
@@ -340,7 +340,7 @@ bool TryComputeNamespaceCore(RazorCodeDocument codeDocument, bool fallbackToRoot
                 appendSuffix = true;
 
                 // Empty RootNamespace is allowed only in components.
-                if (!FileKinds.IsComponent(codeDocument.GetFileKind()) && string.IsNullOrEmpty(baseNamespace))
+                if (!FileKinds.IsComponent(codeDocument.FileKind) && string.IsNullOrEmpty(baseNamespace))
                 {
                     @namespace = null;
                     return false;
diff --git a/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/LinkedEditingRange/LinkedEditingRangeEndpoint.cs b/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/LinkedEditingRange/LinkedEditingRangeEndpoint.cs
@@ -45,7 +45,7 @@ public TextDocumentIdentifier GetTextDocumentIdentifier(LinkedEditingRangeParams
         var codeDocument = await documentContext.GetCodeDocumentAsync(cancellationToken).ConfigureAwait(false);
         if (codeDocument.IsUnsupported())
         {
-            _logger.LogWarning($"FileKind {codeDocument.GetFileKind()} is unsupported");
+            _logger.LogWarning($"FileKind {codeDocument.FileKind} is unsupported");
             return null;
         }
 
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Razor/CreateComponentCodeActionResolver.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Razor/CreateComponentCodeActionResolver.cs
@@ -40,7 +40,7 @@ internal class CreateComponentCodeActionResolver(LanguageServerFeatureOptions la
             return null;
         }
 
-        if (!FileKinds.IsComponent(codeDocument.GetFileKind()))
+        if (!FileKinds.IsComponent(codeDocument.FileKind))
         {
             return null;
         }
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Razor/ExtractToCodeBehindCodeActionProvider.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Razor/ExtractToCodeBehindCodeActionProvider.cs
@@ -31,7 +31,7 @@ public Task<ImmutableArray<RazorVSInternalCodeAction>> ProvideAsync(RazorCodeAct
             return SpecializedTasks.EmptyImmutableArray<RazorVSInternalCodeAction>();
         }
 
-        if (!FileKinds.IsComponent(context.CodeDocument.GetFileKind()))
+        if (!FileKinds.IsComponent(context.CodeDocument.FileKind))
         {
             return SpecializedTasks.EmptyImmutableArray<RazorVSInternalCodeAction>();
         }
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Razor/ExtractToCodeBehindCodeActionResolver.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Razor/ExtractToCodeBehindCodeActionResolver.cs
@@ -45,7 +45,7 @@ internal class ExtractToCodeBehindCodeActionResolver(
             return null;
         }
 
-        if (!FileKinds.IsComponent(codeDocument.GetFileKind()))
+        if (!FileKinds.IsComponent(codeDocument.FileKind))
         {
             return null;
         }
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Razor/ExtractToComponentCodeActionProvider.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/CodeActions/Razor/ExtractToComponentCodeActionProvider.cs
@@ -26,7 +26,7 @@ public Task<ImmutableArray<RazorVSInternalCodeAction>> ProvideAsync(RazorCodeAct
             return SpecializedTasks.EmptyImmutableArray<RazorVSInternalCodeAction>();
         }
 
-        if (!FileKinds.IsComponent(context.CodeDocument.GetFileKind()))
+        if (!FileKinds.IsComponent(context.CodeDocument.FileKind))
         {
             return SpecializedTasks.EmptyImmutableArray<RazorVSInternalCodeAction>();
         }
diff --git a/src/Razor/test/Microsoft.VisualStudio.LegacyEditor.Razor.Test/Parsing/VisualStudioRazorParserIntegrationTest.cs b/src/Razor/test/Microsoft.VisualStudio.LegacyEditor.Razor.Test/Parsing/VisualStudioRazorParserIntegrationTest.cs
@@ -61,7 +61,7 @@ public async Task NoDocumentSnapshotParsesComponentFileCorrectly()
 
             var codeDocument = await manager.InnerParser.GetLatestCodeDocumentAsync(snapshot);
             Assert.NotNull(codeDocument);
-            Assert.Equal(FileKinds.Component, codeDocument.GetFileKind());
+            Assert.Equal(FileKinds.Component, codeDocument.FileKind);
 
             // @code is only applicable in component files so we're verifying that `@code` was treated as a directive.
             var directiveNodes = manager.CurrentSyntaxTree!.Root.DescendantNodes().Where(child => child.Kind == SyntaxKind.RazorDirective);

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public ComponentDocumentClassifierPass(RazorLanguageVersion version)`
`47`	`47`
`48`	`48`	`protected override bool IsMatch(RazorCodeDocument codeDocument, DocumentIntermediateNode documentNode)`
`49`	`49`	`{`
`50`		`- return FileKinds.IsComponent(codeDocument.GetFileKind());`
	`50`	`+ return FileKinds.IsComponent(codeDocument.FileKind);`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`protected override CodeTarget CreateTarget(RazorCodeDocument codeDocument, RazorCodeGenerationOptions options)`
`@@ -95,7 +95,7 @@ protected override void OnDocumentStructureCreated(`
`95`	`95`	`@class.Modifiers.Add("public");`
`96`	`96`	`@class.Modifiers.Add("partial");`
`97`	`97`
`98`		`- if (FileKinds.IsComponentImport(codeDocument.GetFileKind()))`
	`98`	`+ if (FileKinds.IsComponentImport(codeDocument.FileKind))`
`99`	`99`	`{`
`100`	`100`	`// We don't want component imports to be considered as real component.`
`101`	`101`	`// But we still want to generate code for it so we can get diagnostics.`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ protected override void ExecuteCore(RazorCodeDocument codeDocument, DocumentInte`
`38`	`38`	`for (var i = 0; i < directives.Count; i++)`
`39`	`39`	`{`
`40`	`40`	`var directive = directives[i];`
`41`		`- if (FileKinds.IsComponentImport(codeDocument.GetFileKind()) \|\| directive.Node.IsImported())`
	`41`	`+ if (FileKinds.IsComponentImport(codeDocument.FileKind) \|\| directive.Node.IsImported())`
`42`	`42`	`{`
`43`	`43`	`directive.Node.Diagnostics.Add(ComponentDiagnosticFactory.CreatePageDirective_CannotBeImported(directive.Node.Source.GetValueOrDefault()));`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ internal class DefaultDirectiveSyntaxTreePass : RazorEngineFeatureBase, IRazorSy`
`14`	`14`
`15`	`15`	`public RazorSyntaxTree Execute(RazorCodeDocument codeDocument, RazorSyntaxTree syntaxTree)`
`16`	`16`	`{`
`17`		`- if (FileKinds.IsComponent(codeDocument.GetFileKind()))`
	`17`	`+ if (FileKinds.IsComponent(codeDocument.FileKind))`
`18`	`18`	`{`
`19`	`19`	`// Nothing to do here.`
`20`	`20`	`return syntaxTree;`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ protected override void ExecuteCore(RazorCodeDocument codeDocument, Cancellation`
`43`	`43`	`// We need to decide up front if this document is a "component" file. This will affect how`
`44`	`44`	`// lowering behaves.`
`45`	`45`	`LoweringVisitor visitor;`
`46`		`- if (FileKinds.IsComponentImport(codeDocument.GetFileKind()) &&`
	`46`	`+ if (FileKinds.IsComponentImport(codeDocument.FileKind) &&`
`47`	`47`	`syntaxTree.Options.AllowComponentFileKind)`
`48`	`48`	`{`
`49`	`49`	`visitor = new ComponentImportFileKindVisitor(documentNode, builder, syntaxTree.Options)`
`@@ -53,7 +53,7 @@ protected override void ExecuteCore(RazorCodeDocument codeDocument, Cancellation`
`53`	`53`
`54`	`54`	`visitor.Visit(syntaxTree.Root);`
`55`	`55`	`}`
`56`		`- else if (FileKinds.IsComponent(codeDocument.GetFileKind()) &&`
	`56`	`+ else if (FileKinds.IsComponent(codeDocument.FileKind) &&`
`57`	`57`	`syntaxTree.Options.AllowComponentFileKind)`
`58`	`58`	`{`
`59`	`59`	`visitor = new ComponentFileKindVisitor(documentNode, builder, syntaxTree.Options)`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ internal static PooledDirectiveVisitor GetPooledVisitor(`
`52`	`52`	`out DirectiveVisitor visitor)`
`53`	`53`	`{`
`54`	`54`	`var useComponentDirectiveVisitor = codeDocument.ParserOptions.AllowComponentFileKind &&`
`55`		`- FileKinds.IsComponent(codeDocument.GetFileKind());`
	`55`	`+ FileKinds.IsComponent(codeDocument.FileKind);`
`56`	`56`
`57`	`57`	`if (useComponentDirectiveVisitor)`
`58`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ protected override void ExecuteCore(RazorCodeDocument codeDocument, DocumentInte`
`23`	`23`	`var directiveNodes = new List<IntermediateNodeReference>();`
`24`	`24`	`directiveNodes.AddRange(documentNode.FindDirectiveReferences(FunctionsDirective.Directive));`
`25`	`25`
`26`		`- if (FileKinds.IsComponent(codeDocument.GetFileKind()))`
	`26`	`+ if (FileKinds.IsComponent(codeDocument.FileKind))`
`27`	`27`	`{`
`28`	`28`	`directiveNodes.AddRange(documentNode.FindDirectiveReferences(ComponentCodeDirective.Directive));`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@ public sealed class RazorCodeDocument`
`15`	`15`	`public RazorParserOptions ParserOptions { get; }`
`16`	`16`	`public RazorCodeGenerationOptions CodeGenerationOptions { get; }`
`17`	`17`
	`18`	`+ public string FileKind => ParserOptions.FileKind;`
	`19`	`+`
`18`	`20`	`private RazorCodeDocument(`
`19`	`21`	`RazorSourceDocument source,`
`20`	`22`	`ImmutableArray<RazorSourceDocument> imports,`
`@@ -50,7 +52,4 @@ public static RazorCodeDocument Create(`
`50`	`52`
`51`	`53`	`return new RazorCodeDocument(source, imports, parserOptions, codeGenerationOptions);`
`52`	`54`	`}`
`53`		`-`
`54`		`- public string? GetFileKind()`
`55`		`- => ParserOptions.FileKind;`
`56`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -340,7 +340,7 @@ bool TryComputeNamespaceCore(RazorCodeDocument codeDocument, bool fallbackToRoot`
`340`	`340`	`appendSuffix = true;`
`341`	`341`
`342`	`342`	`// Empty RootNamespace is allowed only in components.`
`343`		`- if (!FileKinds.IsComponent(codeDocument.GetFileKind()) && string.IsNullOrEmpty(baseNamespace))`
	`343`	`+ if (!FileKinds.IsComponent(codeDocument.FileKind) && string.IsNullOrEmpty(baseNamespace))`
`344`	`344`	`{`
`345`	`345`	`@namespace = null;`
`346`	`346`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public TextDocumentIdentifier GetTextDocumentIdentifier(LinkedEditingRangeParams`
`45`	`45`	`var codeDocument = await documentContext.GetCodeDocumentAsync(cancellationToken).ConfigureAwait(false);`
`46`	`46`	`if (codeDocument.IsUnsupported())`
`47`	`47`	`{`
`48`		`- _logger.LogWarning($"FileKind {codeDocument.GetFileKind()} is unsupported");`
	`48`	`+ _logger.LogWarning($"FileKind {codeDocument.FileKind} is unsupported");`
`49`	`49`	`return null;`
`50`	`50`	`}`
`51`	`51`