Rationalize FileKinds methods

DustinCampbell · DustinCampbell · commit 90fb4944a54f · 2025-04-08T13:05:03.000-07:00
- Add TryGetFileKindFromPath
- Rename FilePathToRazorFileKind to GetFileKindFromPath and implement using TryGetFileKindFromPath.
- Remove ComponentFilePathToRazorFileKind
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/FileKinds.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/FileKinds.cs
@@ -9,6 +9,9 @@ namespace Microsoft.AspNetCore.Razor.Language;
 
 public static class FileKinds
 {
+    private const string ComponentFileExtension = ".razor";
+    private const string LegacyFileExtension = ".cshtml";
+
     /// <summary>
     ///  Returns <see langword="true"/> if the specified value represents a component or component import.
     /// </summary>
@@ -19,43 +22,54 @@ public static bool IsComponent(this RazorFileKind fileKind)
     ///  Returns <see langword="true"/> if the specified value represents a component import.
     /// </summary>
     public static bool IsComponentImport(this RazorFileKind fileKind)
-        => fileKind == RazorFileKind.ComponentImport;
+        => fileKind is RazorFileKind.ComponentImport;
 
     /// <summary>
     ///  Returns <see langword="true"/> if the specified value represents a legacy file kind.
     /// </summary>
-    internal static bool IsLegacy(this RazorFileKind fileKind)
-        => fileKind == RazorFileKind.Legacy;
+    public static bool IsLegacy(this RazorFileKind fileKind)
+        => fileKind is RazorFileKind.Legacy;
 
-    public static RazorFileKind ComponentFilePathToRazorFileKind(string filePath)
+    /// <summary>
+    ///  Compares the given file path to known Razor file extensions and names to determine the <see cref="RazorFileKind"/>.
+    ///  Returns <see langword="true"/> if a file kind can be determined; otherwise, <see langword="false"/>.
+    /// </summary>
+    public static bool TryGetFileKindFromPath(string filePath, out RazorFileKind fileKind)
     {
         ArgHelper.ThrowIfNull(filePath);
 
-        if (string.Equals(ComponentMetadata.ImportsFileName, Path.GetFileName(filePath), StringComparison.Ordinal))
-        {
-            return RazorFileKind.ComponentImport;
-        }
-        else
+        var fileName = Path.GetFileName(filePath);
+
+        if (string.Equals(ComponentMetadata.ImportsFileName, fileName, StringComparison.Ordinal))
         {
-            return RazorFileKind.Component;
+            fileKind = RazorFileKind.ComponentImport;
+            return true;
         }
-    }
 
-    public static RazorFileKind FilePathToRazorFileKind(string filePath)
-    {
-        ArgHelper.ThrowIfNull(filePath);
+        var extension = Path.GetExtension(filePath);
 
-        if (string.Equals(ComponentMetadata.ImportsFileName, Path.GetFileName(filePath), StringComparison.Ordinal))
-        {
-            return RazorFileKind.ComponentImport;
-        }
-        else if (string.Equals(".razor", Path.GetExtension(filePath), StringComparison.OrdinalIgnoreCase))
+        if (string.Equals(ComponentFileExtension, extension, StringComparison.OrdinalIgnoreCase))
         {
-            return RazorFileKind.Component;
+            fileKind = RazorFileKind.Component;
+            return true;
         }
-        else
+
+        if (string.Equals(LegacyFileExtension, extension, StringComparison.OrdinalIgnoreCase))
         {
-            return RazorFileKind.Legacy;
+            fileKind = RazorFileKind.Legacy;
+            return true;
         }
+
+        fileKind = default;
+        return false;
     }
+
+    /// <summary>
+    ///  Compares the given file path to known Razor file extensions and names to determine the <see cref="RazorFileKind"/>.
+    ///  If a file kind can't be determined, the result is <see cref="RazorFileKind.Legacy"/>.
+    /// </summary>
+    public static RazorFileKind GetFileKindFromPath(string filePath)
+        => TryGetFileKindFromPath(filePath, out var fileKind)
+            ? fileKind
+            : RazorFileKind.Legacy;
 }
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/NotFoundProjectItem.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/NotFoundProjectItem.cs
@@ -22,7 +22,7 @@ internal class NotFoundProjectItem(string path, RazorFileKind? fileKind) : Razor
 
     /// <inheritdoc />
     public override RazorFileKind FileKind { get; }
-        = fileKind ?? FileKinds.FilePathToRazorFileKind(path);
+        = fileKind ?? FileKinds.GetFileKindFromPath(path);
 
     /// <inheritdoc />
     public override bool Exists => false;
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/RazorProjectEngineExtensions.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/RazorProjectEngineExtensions.cs
@@ -65,7 +65,7 @@ private static RazorCodeDocument CreateCodeDocumentCore(
         IReadOnlyList<TagHelperDescriptor>? tagHelpers = null)
     {
         var fileKindValue = fileKind ?? (source.FilePath is string filePath
-            ? FileKinds.FilePathToRazorFileKind(filePath)
+            ? FileKinds.GetFileKindFromPath(filePath)
             : DefaultFileKind);
 
         return projectEngine.CreateCodeDocument(source, fileKindValue, importSources, tagHelpers, cssScope: null);
@@ -126,7 +126,7 @@ private static RazorCodeDocument CreateDesignTimeCodeDocumentCore(
         IReadOnlyList<TagHelperDescriptor>? tagHelpers = null)
     {
         var fileKindValue = fileKind ?? (source.FilePath is string filePath
-            ? FileKinds.FilePathToRazorFileKind(filePath)
+            ? FileKinds.GetFileKindFromPath(filePath)
             : DefaultFileKind);
 
         return projectEngine.CreateDesignTimeCodeDocument(source, fileKindValue, importSources, tagHelpers);
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/RazorProjectItem.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/RazorProjectItem.cs
@@ -48,7 +48,7 @@ public abstract class RazorProjectItem
     public virtual RazorFileKind FileKind
         => FilePath == null
             ? RazorFileKind.None
-            : FileKinds.FilePathToRazorFileKind(FilePath);
+            : FileKinds.GetFileKindFromPath(FilePath);
 
     /// <summary>
     /// Gets the file contents as readonly <see cref="Stream"/>.
diff --git a/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/SourceGenerators/RazorSourceGenerator.RazorProviders.cs b/src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/SourceGenerators/RazorSourceGenerator.RazorProviders.cs
@@ -96,7 +96,7 @@ private static (SourceGeneratorProjectItem?, Diagnostic?) ComputeProjectItems((A
                     .Replace(Path.DirectorySeparatorChar, '/')
                     .Replace("//", "/"),
                 relativePhysicalPath: relativePath,
-                fileKind: FileKinds.FilePathToRazorFileKind(additionalText.Path),
+                fileKind: FileKinds.GetFileKindFromPath(additionalText.Path),
                 additionalText: additionalText,
                 cssScope: cssScope);
             return (projectItem, null);
diff --git a/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/RemoteProjectItem.cs b/src/Razor/src/Microsoft.AspNetCore.Razor.LanguageServer/RemoteProjectItem.cs
@@ -13,7 +13,7 @@ public RemoteProjectItem(string filePath, string physicalPath, RazorFileKind? fi
     {
         FilePath = filePath;
         PhysicalPath = physicalPath;
-        FileKind = fileKind ?? FileKinds.FilePathToRazorFileKind(FilePath);
+        FileKind = fileKind ?? FileKinds.GetFileKindFromPath(FilePath);
         RelativePhysicalPath = FilePath.StartsWith('/')
             ? FilePath[1..]
             : FilePath;
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Hover/HoverFactory.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Hover/HoverFactory.cs
@@ -225,7 +225,7 @@ internal static class HoverFactory
         CancellationToken cancellationToken)
     {
         // Filter out attribute descriptors since we're creating an element hover
-        var keepAttributeInfo = FileKinds.FilePathToRazorFileKind(documentFilePath) == RazorFileKind.Legacy;
+        var keepAttributeInfo = FileKinds.GetFileKindFromPath(documentFilePath) == RazorFileKind.Legacy;
         var descriptionInfos = descriptors
             .Where(d => keepAttributeInfo || !d.IsAttributeDescriptor())
             .SelectAsArray(BoundElementDescriptionInfo.From);
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/ProjectSystem/HostDocument.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/ProjectSystem/HostDocument.cs
@@ -15,6 +15,6 @@ public HostDocument(string filePath, string targetPath, RazorFileKind? fileKind
     {
         FilePath = filePath;
         TargetPath = targetPath;
-        FileKind = fileKind ?? FileKinds.FilePathToRazorFileKind(filePath);
+        FileKind = fileKind ?? FileKinds.GetFileKindFromPath(filePath);
     }
 }
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Utilities/RazorProjectInfoFactory.cs b/src/Razor/src/Microsoft.CodeAnalysis.Razor.Workspaces/Utilities/RazorProjectInfoFactory.cs
@@ -150,7 +150,7 @@ internal static ImmutableArray<DocumentSnapshotHandle> GetDocuments(Project proj
         foreach (var document in project.AdditionalDocuments)
         {
             if (document.FilePath is { } filePath &&
-                TryGetFileKind(filePath, out var kind))
+                FileKinds.TryGetFileKindFromPath(filePath, out var kind))
             {
                 documents.Add(new DocumentSnapshotHandle(filePath, GetTargetPath(filePath, normalizedProjectPath), kind));
             }
@@ -165,7 +165,7 @@ internal static ImmutableArray<DocumentSnapshotHandle> GetDocuments(Project proj
             foreach (var document in project.Documents)
             {
                 if (TryGetRazorFileName(document.FilePath, out var razorFilePath) &&
-                    TryGetFileKind(razorFilePath, out var kind))
+                    FileKinds.TryGetFileKindFromPath(razorFilePath, out var kind))
                 {
                     documents.Add(new DocumentSnapshotHandle(razorFilePath, GetTargetPath(razorFilePath, normalizedProjectPath), kind));
                 }
@@ -190,25 +190,6 @@ private static string GetTargetPath(string documentFilePath, string normalizedPr
         return normalizedTargetFilePath;
     }
 
-    private static bool TryGetFileKind(string filePath, out RazorFileKind fileKind)
-    {
-        var extension = Path.GetExtension(filePath);
-
-        if (extension.Equals(".cshtml", s_stringComparison))
-        {
-            fileKind = RazorFileKind.Legacy;
-            return true;
-        }
-        else if (extension.Equals(".razor", s_stringComparison))
-        {
-            fileKind = FileKinds.ComponentFilePathToRazorFileKind(filePath);
-            return true;
-        }
-
-        fileKind = default;
-        return false;
-    }
-
     private static bool TryGetRazorFileName(string? filePath, [NotNullWhen(true)] out string? razorFilePath)
     {
         if (filePath is null)
diff --git a/src/Razor/src/Microsoft.CodeAnalysis.Remote.Razor/ProjectSystem/RemoteDocumentSnapshot.cs b/src/Razor/src/Microsoft.CodeAnalysis.Remote.Razor/ProjectSystem/RemoteDocumentSnapshot.cs
@@ -31,7 +31,7 @@ public RemoteDocumentSnapshot(TextDocument textDocument, RemoteProjectSnapshot p
         ProjectSnapshot = projectSnapshot;
     }
 
-    public RazorFileKind FileKind => FileKinds.FilePathToRazorFileKind(FilePath);
+    public RazorFileKind FileKind => FileKinds.GetFileKindFromPath(FilePath);
     public string FilePath => TextDocument.FilePath.AssumeNotNull();
     public string TargetPath => TextDocument.FilePath.AssumeNotNull();
 
diff --git a/src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/ProjectSystem/DefaultWindowsRazorProjectHost.cs b/src/Razor/src/Microsoft.VisualStudio.LanguageServices.Razor/ProjectSystem/DefaultWindowsRazorProjectHost.cs
@@ -322,7 +322,10 @@ private HostDocument[] GetCurrentDocuments(IProjectSubscriptionUpdate update)
                     !string.IsNullOrWhiteSpace(targetPath))
                 {
                     var filePath = CommonServices.UnconfiguredProject.MakeRooted(kvp.Key);
-                    var fileKind = FileKinds.ComponentFilePathToRazorFileKind(filePath);
+
+                    var fileKind = FileKinds.TryGetFileKindFromPath(filePath, out var kind) && kind != RazorFileKind.Legacy
+                        ? kind
+                        : RazorFileKind.Component;
 
                     documents.Add(new HostDocument(filePath, targetPath, fileKind));
                 }
@@ -360,7 +363,10 @@ private HostDocument[] GetChangedAndRemovedDocuments(IProjectSubscriptionUpdate
                         !string.IsNullOrWhiteSpace(targetPath))
                     {
                         var filePath = CommonServices.UnconfiguredProject.MakeRooted(key);
-                        var fileKind = FileKinds.ComponentFilePathToRazorFileKind(filePath);
+
+                        var fileKind = FileKinds.TryGetFileKindFromPath(filePath, out var kind) && kind != RazorFileKind.Legacy
+                            ? kind
+                            : RazorFileKind.Component;
 
                         documents.Add(new HostDocument(filePath, targetPath, fileKind));
                     }
diff --git a/src/Razor/src/Microsoft.VisualStudio.LegacyEditor.Razor/Parsing/VisualStudioRazorParser.cs b/src/Razor/src/Microsoft.VisualStudio.LegacyEditor.Razor/Parsing/VisualStudioRazorParser.cs
@@ -230,7 +230,7 @@ internal void StartParser()
 
         // We might not have a document snapshot in the case of an ephemeral project.
         // If we don't have a document then infer the FileKind from the FilePath.
-        var fileKind = projectSnapshot.GetDocument(_documentTracker.FilePath)?.FileKind ?? FileKinds.FilePathToRazorFileKind(_documentTracker.FilePath);
+        var fileKind = projectSnapshot.GetDocument(_documentTracker.FilePath)?.FileKind ?? FileKinds.GetFileKindFromPath(_documentTracker.FilePath);
 
         var projectDirectory = Path.GetDirectoryName(_documentTracker.ProjectPath);
         _parser = new BackgroundParser(_projectEngine, FilePath, projectDirectory, fileKind);
diff --git a/src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/TestRazorProjectService.cs b/src/Razor/test/Microsoft.AspNetCore.Razor.LanguageServer.Test/TestRazorProjectService.cs
@@ -40,7 +40,7 @@ private static IRazorProjectInfoDriver CreateProjectInfoDriver()
     public async Task AddDocumentToPotentialProjectsAsync(string textDocumentPath, CancellationToken cancellationToken)
     {
         var document = new DocumentSnapshotHandle(
-            textDocumentPath, textDocumentPath, FileKinds.FilePathToRazorFileKind(textDocumentPath));
+            textDocumentPath, textDocumentPath, FileKinds.GetFileKindFromPath(textDocumentPath));
 
         foreach (var projectSnapshot in _projectManager.FindPotentialProjects(textDocumentPath))
         {
diff --git a/src/Razor/test/Microsoft.AspNetCore.Razor.Test.Common.Tooling/LanguageServer/LanguageServerTestBase.cs b/src/Razor/test/Microsoft.AspNetCore.Razor.Test.Common.Tooling/LanguageServer/LanguageServerTestBase.cs
@@ -51,7 +51,7 @@ protected static RazorCodeDocument CreateCodeDocument(string text, ImmutableArra
     {
         filePath ??= "test.cshtml";
 
-        var fileKind = FileKinds.FilePathToRazorFileKind(filePath);
+        var fileKind = FileKinds.GetFileKindFromPath(filePath);
         tagHelpers = tagHelpers.NullToEmpty();
 
         if (fileKind == RazorFileKind.Component)
diff --git a/src/Razor/test/Microsoft.AspNetCore.Razor.Test.Common.Tooling/RazorCodeDocumentFactory.cs b/src/Razor/test/Microsoft.AspNetCore.Razor.Test.Common.Tooling/RazorCodeDocumentFactory.cs
@@ -35,7 +35,7 @@ public static RazorCodeDocument CreateCodeDocument(string text, string filePath,
             RazorExtensions.Register(builder);
         });
 
-        var fileKind = FileKinds.FilePathToRazorFileKind(filePath);
+        var fileKind = FileKinds.GetFileKindFromPath(filePath);
 
         return projectEngine.ProcessDesignTime(sourceDocument, fileKind, importSources: default, tagHelpers);
     }

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public RemoteProjectItem(string filePath, string physicalPath, RazorFileKind? fi`
`13`	`13`	`{`
`14`	`14`	`FilePath = filePath;`
`15`	`15`	`PhysicalPath = physicalPath;`
`16`		`- FileKind = fileKind ?? FileKinds.FilePathToRazorFileKind(FilePath);`
	`16`	`+ FileKind = fileKind ?? FileKinds.GetFileKindFromPath(FilePath);`
`17`	`17`	`RelativePhysicalPath = FilePath.StartsWith('/')`
`18`	`18`	`? FilePath[1..]`
`19`	`19`	`: FilePath;`
Original file line number	Diff line number	Diff line change
`@@ -225,7 +225,7 @@ internal static class HoverFactory`
`225`	`225`	`CancellationToken cancellationToken)`
`226`	`226`	`{`
`227`	`227`	`// Filter out attribute descriptors since we're creating an element hover`
`228`		`- var keepAttributeInfo = FileKinds.FilePathToRazorFileKind(documentFilePath) == RazorFileKind.Legacy;`
	`228`	`+ var keepAttributeInfo = FileKinds.GetFileKindFromPath(documentFilePath) == RazorFileKind.Legacy;`
`229`	`229`	`var descriptionInfos = descriptors`
`230`	`230`	`.Where(d => keepAttributeInfo \|\| !d.IsAttributeDescriptor())`
`231`	`231`	`.SelectAsArray(BoundElementDescriptionInfo.From);`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,6 @@ public HostDocument(string filePath, string targetPath, RazorFileKind? fileKind`
`15`	`15`	`{`
`16`	`16`	`FilePath = filePath;`
`17`	`17`	`TargetPath = targetPath;`
`18`		`- FileKind = fileKind ?? FileKinds.FilePathToRazorFileKind(filePath);`
	`18`	`+ FileKind = fileKind ?? FileKinds.GetFileKindFromPath(filePath);`
`19`	`19`	`}`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,7 @@ internal static ImmutableArray<DocumentSnapshotHandle> GetDocuments(Project proj`
`150`	`150`	`foreach (var document in project.AdditionalDocuments)`
`151`	`151`	`{`
`152`	`152`	`if (document.FilePath is { } filePath &&`
`153`		`- TryGetFileKind(filePath, out var kind))`
	`153`	`+ FileKinds.TryGetFileKindFromPath(filePath, out var kind))`
`154`	`154`	`{`
`155`	`155`	`documents.Add(new DocumentSnapshotHandle(filePath, GetTargetPath(filePath, normalizedProjectPath), kind));`
`156`	`156`	`}`
`@@ -165,7 +165,7 @@ internal static ImmutableArray<DocumentSnapshotHandle> GetDocuments(Project proj`
`165`	`165`	`foreach (var document in project.Documents)`
`166`	`166`	`{`
`167`	`167`	`if (TryGetRazorFileName(document.FilePath, out var razorFilePath) &&`
`168`		`- TryGetFileKind(razorFilePath, out var kind))`
	`168`	`+ FileKinds.TryGetFileKindFromPath(razorFilePath, out var kind))`
`169`	`169`	`{`
`170`	`170`	`documents.Add(new DocumentSnapshotHandle(razorFilePath, GetTargetPath(razorFilePath, normalizedProjectPath), kind));`
`171`	`171`	`}`
`@@ -190,25 +190,6 @@ private static string GetTargetPath(string documentFilePath, string normalizedPr`
`190`	`190`	`return normalizedTargetFilePath;`
`191`	`191`	`}`
`192`	`192`
`193`		`- private static bool TryGetFileKind(string filePath, out RazorFileKind fileKind)`
`194`		`- {`
`195`		`- var extension = Path.GetExtension(filePath);`
`196`		`-`
`197`		`- if (extension.Equals(".cshtml", s_stringComparison))`
`198`		`- {`
`199`		`- fileKind = RazorFileKind.Legacy;`
`200`		`- return true;`
`201`		`- }`
`202`		`- else if (extension.Equals(".razor", s_stringComparison))`
`203`		`- {`
`204`		`- fileKind = FileKinds.ComponentFilePathToRazorFileKind(filePath);`
`205`		`- return true;`
`206`		`- }`
`207`		`-`
`208`		`- fileKind = default;`
`209`		`- return false;`
`210`		`- }`
`211`		`-`
`212`	`193`	`private static bool TryGetRazorFileName(string? filePath, [NotNullWhen(true)] out string? razorFilePath)`
`213`	`194`	`{`
`214`	`195`	`if (filePath is null)`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public RemoteDocumentSnapshot(TextDocument textDocument, RemoteProjectSnapshot p`
`31`	`31`	`ProjectSnapshot = projectSnapshot;`
`32`	`32`	`}`
`33`	`33`
`34`		`- public RazorFileKind FileKind => FileKinds.FilePathToRazorFileKind(FilePath);`
	`34`	`+ public RazorFileKind FileKind => FileKinds.GetFileKindFromPath(FilePath);`
`35`	`35`	`public string FilePath => TextDocument.FilePath.AssumeNotNull();`
`36`	`36`	`public string TargetPath => TextDocument.FilePath.AssumeNotNull();`
`37`	`37`