chore: Fix code formatting (dotnet#10176)

* chore: remove BOM from project files and extra whitespaces

* chore: apply `dotnet format whitespace` command

* chore: Apply `dotnet format style` command

* chore: enable file header template rule & apply `dotnet format style` command

* chore: fix build error

---------

Co-authored-by: Yufei Huang <[email protected]>

.editorconfig

@@ -141,7 +141,8 @@ csharp_prefer_simple_using_statement = false:none                       # IDE006
 csharp_using_directive_placement = outside_namespace:suggestion         # IDE0065: using directive placement
 
 # File header preferences
-file_header_template = unset                                            # IDE0073: Require file header
+dotnet_diagnostic.IDE0073.severity = warning                            # IDE0073: Require file header
+file_header_template = Licensed to the .NET Foundation under one or more agreements.\nThe .NET Foundation licenses this file to you under the MIT license.
 
 # Namespace naming preferences
 dotnet_style_namespace_match_folder = true:suggestion                   # IDE0130: Namespace does not match folder structure

src/Docfx.App/Docfx.App.csproj

@@ -15,7 +15,7 @@
     <InternalsVisibleTo Include="docfx.Tests" />
     <InternalsVisibleTo Include="docfx.Snapshot.Tests" />
   </ItemGroup>
-  
+
   <ItemGroup>
     <InternalsAssemblyName Include="UglyToad.PdfPig" />
   </ItemGroup>

src/Docfx.App/Helpers/MetadataMerger.cs

@@ -31,11 +31,11 @@ public void Merge(MetadataMergeParameters parameters)
         }
         parameters.Metadata ??= ImmutableDictionary<string, object>.Empty;
 
-            Directory.CreateDirectory(parameters.OutputBaseDir);
-            Logger.LogInfo("Start merge metadata...");
-            MergePageViewModel(parameters);
-            MergeToc(parameters);
-            Logger.LogInfo("Merge metadata completed.");
+        Directory.CreateDirectory(parameters.OutputBaseDir);
+        Logger.LogInfo("Start merge metadata...");
+        MergePageViewModel(parameters);
+        MergeToc(parameters);
+        Logger.LogInfo("Merge metadata completed.");
     }
 
     private void MergePageViewModel(MetadataMergeParameters parameters)

src/Docfx.Build.Common/Docfx.Build.Common.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
     <ProjectReference Include="..\Docfx.Common\Docfx.Common.csproj" />
     <ProjectReference Include="..\Docfx.DataContracts.Common\Docfx.DataContracts.Common.csproj" />

src/Docfx.Build.ManagedReference/Docfx.Build.ManagedReference.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
     <ProjectReference Include="..\Docfx.Build.Common\Docfx.Build.Common.csproj" />
     <ProjectReference Include="..\Docfx.Common\Docfx.Common.csproj" />

src/Docfx.Build.OverwriteDocuments/Docfx.Build.OverwriteDocuments.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
     <PackageReference Include="Markdig" />
   </ItemGroup>

src/Docfx.Build.RestApi/Docfx.Build.RestApi.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
     <ProjectReference Include="..\Docfx.Build.Common\Docfx.Build.Common.csproj" />
     <ProjectReference Include="..\Docfx.Common\Docfx.Common.csproj" />

src/Docfx.Build.TagLevelRestApi/Docfx.Build.TagLevelRestApi.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
     <ProjectReference Include="..\..\src\Docfx.Build.Common\Docfx.Build.Common.csproj" />
     <ProjectReference Include="..\..\src\Docfx.Common\Docfx.Common.csproj" />

src/Docfx.Build.UniversalReference/Docfx.Build.UniversalReference.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
     <ProjectReference Include="..\Docfx.Build.Common\Docfx.Build.Common.csproj" />
     <ProjectReference Include="..\Docfx.Common\Docfx.Common.csproj" />

src/Docfx.Build/ApiPage/ApiPageProcessor.cs

@@ -46,7 +46,7 @@ public FileModel Load(FileAndType file, ImmutableDictionary<string, object> meta
             foreach (var (key, value) in data.metadata.OrderBy(item => item.Key))
                 content[key] = value.Value;
         }
-        
+
         content["title"] = data.title;
         content["content"] = ApiPageHtmlTemplate.Render(data, Markup).ToString();
         content["yamlmime"] = "ApiPage";

src/Docfx.Build/ManifestUtility.cs

@@ -40,8 +40,8 @@ public static Manifest MergeManifest(List<Manifest> manifests)
         ArgumentNullException.ThrowIfNull(manifests);
 
         var xrefMaps = (from manifest in manifests
-                                where manifest.Xrefmap != null
-                                select manifest.Xrefmap).ToList();
+                        where manifest.Xrefmap != null
+                        select manifest.Xrefmap).ToList();
         var manifestGroupInfos = (from manifest in manifests
                                   from g in manifest.Groups ?? Enumerable.Empty<ManifestGroupInfo>()
                                   select g).ToList();

src/Docfx.Build/OneOfJsonConverterFactory.cs

@@ -3,8 +3,8 @@
 
 using System.Diagnostics;
 using System.Reflection;
-using System.Text.Json.Serialization;
 using System.Text.Json;
+using System.Text.Json.Serialization;
 using OneOf;
 
 #nullable enable

src/Docfx.Build/ResourceFiles/IResourceFileConfig.cs

@@ -1,4 +1,7 @@
-namespace Docfx.Build.ResourceFiles;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Docfx.Build.ResourceFiles;
 
 public interface IResourceFileConfig
 {

src/Docfx.Build/TableOfContents/MarkdownTocReader.cs

@@ -1,4 +1,7 @@
-using System.Text.RegularExpressions;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Text.RegularExpressions;
 using Docfx.Common;
 using Docfx.DataContracts.Common;
 using Docfx.Plugins;

src/Docfx.Build/TableOfContents/TocResolver.cs

@@ -125,9 +125,9 @@ private TocItemInfo ResolveItemCore(TocItemInfo wrapper, Stack<FileAndType> stac
                 if (item.Items != null && item.Items.Count > 0)
                 {
                     item.Items = new List<TocItemViewModel>(from i in item.Items
-                                                  select ResolveItem(new TocItemInfo(file, i), stack) into r
-                                                  where r != null
-                                                  select r.Content);
+                                                            select ResolveItem(new TocItemInfo(file, i), stack) into r
+                                                            where r != null
+                                                            select r.Content);
                     if (string.IsNullOrEmpty(item.TopicHref) && string.IsNullOrEmpty(item.TopicUid))
                     {
                         var defaultItem = GetDefaultHomepageItem(item);

src/Docfx.Build/TemplateProcessors/Preprocessors/JintProcessorHelper.cs

@@ -23,7 +23,7 @@ public static JsValue ConvertObjectToJsValue(Jint.Engine engine, object raw)
         {
             // allow Jint to take ownership of the array
             var elements = new JsValue[list.Count];
-            for (int i = 0; i < (uint) elements.Length; i++)
+            for (int i = 0; i < (uint)elements.Length; i++)
             {
                 elements[i] = ConvertObjectToJsValue(engine, list[i]);
             }

src/Docfx.Common/ConvertToObjectHelper.cs

@@ -3,9 +3,8 @@
 
 using System.Diagnostics.CodeAnalysis;
 using System.Dynamic;
-
-using Newtonsoft.Json.Linq;
 using System.Runtime.CompilerServices;
+using Newtonsoft.Json.Linq;
 
 namespace Docfx.Common;
 

src/Docfx.Common/EntityMergers/IMergeContext.cs

@@ -1,4 +1,7 @@
-namespace Docfx.Common.EntityMergers;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Docfx.Common.EntityMergers;
 
 public interface IMergeContext
 {

src/Docfx.Common/EntityMergers/IMergeHandler.cs

@@ -1,4 +1,7 @@
-namespace Docfx.Common.EntityMergers;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Docfx.Common.EntityMergers;
 
 public interface IMergeHandler
 {

src/Docfx.Common/EntityMergers/MergeContext.cs

@@ -1,4 +1,7 @@
-namespace Docfx.Common.EntityMergers;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Docfx.Common.EntityMergers;
 
 internal sealed class MergeContext : IMergeContext
 {

src/Docfx.Common/EntityMergers/MergePlacement.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.\r
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
 

src/Docfx.Common/EntityMergers/ReflectionEntityMerger.cs

@@ -92,10 +92,10 @@ public void Merge(ref object source, object overrides, IMergeContext context)
                     placement =
                         placementValue switch
                         {
-                            "after"   => MergePlacement.After,
-                            "before"  => MergePlacement.Before,
+                            "after" => MergePlacement.After,
+                            "before" => MergePlacement.Before,
                             "replace" => MergePlacement.Replace,
-                            _         => MergePlacement.None
+                            _ => MergePlacement.None
                         };
                 }
             }
@@ -117,8 +117,8 @@ public void Merge(ref object source, object overrides, IMergeContext context)
 
                     s = placement switch
                     {
-                        MergePlacement.After   => $"{s}{o}",
-                        MergePlacement.Before  => $"{o}{s}",
+                        MergePlacement.After => $"{s}{o}",
+                        MergePlacement.Before => $"{o}{s}",
                         MergePlacement.Replace => o.ToString()
                     };
 

src/Docfx.Common/IItemWithMetadata.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.\r
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
 

src/Docfx.Common/LruList.cs

@@ -1,4 +1,7 @@
-namespace Docfx.Common;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Docfx.Common;
 
 public class LruList<T>
 {

src/Docfx.Common/Path/PathUtility.cs

@@ -71,7 +71,7 @@ public static string MakeRelativePath(string basePath, string absolutePath)
 
         if (toUri.IsFile && !toUri.OriginalString.StartsWith("file://", StringComparison.InvariantCultureIgnoreCase))
         {
-           return Path.GetRelativePath(basePath, absolutePath).BackSlashToForwardSlash();
+            return Path.GetRelativePath(basePath, absolutePath).BackSlashToForwardSlash();
         }
 
         Uri relativeUri = fromUri.MakeRelativeUri(toUri);

src/Docfx.DataContracts.Common/Docfx.DataContracts.Common.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
     <ProjectReference Include="..\Docfx.Common\Docfx.Common.csproj" />
   </ItemGroup>

src/Docfx.DataContracts.Common/ExternalReferences/ExternalReferencePackageCollection.cs

@@ -1,4 +1,7 @@
-using System.Collections.Immutable;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Collections.Immutable;
 
 using Docfx.Common;
 

src/Docfx.DataContracts.RestApi/Docfx.DataContracts.RestApi.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
     <ProjectReference Include="..\Docfx.DataContracts.Common\Docfx.DataContracts.Common.csproj" />
     <ProjectReference Include="..\Docfx.Common\Docfx.Common.csproj" />

src/Docfx.DataContracts.UniversalReference/Docfx.DataContracts.UniversalReference.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <ItemGroup>
     <ProjectReference Include="..\Docfx.Common\Docfx.Common.csproj" />
     <ProjectReference Include="..\Docfx.YamlSerialization\Docfx.YamlSerialization.csproj" />

src/Docfx.Dotnet/CompilationHelper.cs

@@ -109,8 +109,8 @@ public static (Compilation, IAssemblySymbol) CreateCompilationFromAssembly(strin
         var compilation = CS.CSharpCompilation.Create(
             assemblyName: null,
             options: new CS.CSharpCompilationOptions(
-                outputKind            : OutputKind.DynamicallyLinkedLibrary,
-                metadataImportOptions : includePrivateMembers
+                outputKind: OutputKind.DynamicallyLinkedLibrary,
+                metadataImportOptions: includePrivateMembers
                     ? MetadataImportOptions.All
                     : MetadataImportOptions.Public
             ),

src/Docfx.Dotnet/DotnetApiCatalog.Toc.cs

@@ -263,7 +263,7 @@ void InsertCategory(TocNodeType type, string name)
 
                     // Insert category as text label.
                     case CategoryLayout.Flattened:
-                    default:                    
+                    default:
                         {
                             if (items.FirstOrDefault(i => i.type == type) is { } node)
                                 items.Insert(items.IndexOf(node), new() { name = name });

src/Docfx.Dotnet/ManagedReference/Models/AdditionalNotes.cs

@@ -10,13 +10,13 @@
 namespace Docfx.DataContracts.ManagedReference;
 
 public class AdditionalNotes
-{   
+{
     [YamlMember(Alias = "caller")]
     [JsonProperty("caller")]
     [JsonPropertyName("caller")]
     [MarkdownContent]
     public string Caller { get; set; }
-        
+
     [YamlMember(Alias = "implementer")]
     [JsonProperty("implementer")]
     [JsonPropertyName("implementer")]

src/Docfx.Dotnet/ManagedReference/Visitors/SymbolVisitorAdapter.cs

@@ -96,7 +96,7 @@ public override MetadataItem VisitAssembly(IAssemblySymbol symbol)
             {
                 { SyntaxLanguage.Default, symbol.MetadataName },
             },
-                DisplayQualifiedNames = new SortedList<SyntaxLanguage, string>
+            DisplayQualifiedNames = new SortedList<SyntaxLanguage, string>
             {
                 { SyntaxLanguage.Default, symbol.MetadataName },
             },
@@ -185,7 +185,7 @@ public override MetadataItem VisitNamedType(INamedTypeSymbol symbol)
             var member in symbol.GetMembers()
             .Where(static s =>
                 s is not INamedTypeSymbol
-                && ! s.Name.StartsWith('<')
+                && !s.Name.StartsWith('<')
                 && (s is not IMethodSymbol ms || ms.MethodKind != MethodKind.StaticConstructor)
             ))
         {

src/Docfx.Dotnet/Parsers/XHtmlWriter.cs

@@ -1,4 +1,7 @@
-using System.Xml;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Xml;
 
 /// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.

src/Docfx.Dotnet/Parsers/XmlComment.cs

@@ -374,9 +374,9 @@ private void ResolveCrefLink(XNode node, string nodeSelector, Action<string, str
 
                 if (detailedInfo.Length == 0 && node is XDocument doc)
                 {
-                    var memberName = (string) doc.Element("member")?.Attribute("name");
+                    var memberName = (string)doc.Element("member")?.Attribute("name");
 
-                    if (! string.IsNullOrEmpty(memberName))
+                    if (!string.IsNullOrEmpty(memberName))
                     {
                         detailedInfo.Append(", member name is ");
                         detailedInfo.Append(memberName);

src/Docfx.Dotnet/SourceLink/PortableCustomDebugInfoKinds.cs

@@ -1,6 +1,5 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
 
 namespace Microsoft.CodeAnalysis.Debugging;
 

src/Docfx.Dotnet/SourceLink/SourceLinkMap.cs

@@ -1,6 +1,5 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
 
 using System.Collections.ObjectModel;
 using System.Diagnostics;

src/Docfx.Dotnet/SourceLink/SymbolSourceDocumentFinder.cs

@@ -1,6 +1,5 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
-// See the LICENSE file in the project root for more information.
 
 using System.Reflection.Metadata;
 using System.Reflection.Metadata.Ecma335;

src/Docfx.Dotnet/SymbolFormatter.Symbols.cs

@@ -1,4 +1,7 @@
-using System.Collections.Immutable;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Collections.Immutable;
 using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.Reflection;

src/Docfx.Dotnet/SymbolFormatter.Syntax.cs

@@ -1,4 +1,7 @@
-using System.Collections.Immutable;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Collections.Immutable;
 using Docfx.DataContracts.ManagedReference;
 using Microsoft.CodeAnalysis;
 using CS = Microsoft.CodeAnalysis.CSharp;

src/Docfx.Dotnet/SymbolFormatter.cs

@@ -1,4 +1,7 @@
-using System.Collections.Immutable;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Collections.Immutable;
 using Docfx.DataContracts.ManagedReference;
 using Microsoft.CodeAnalysis;
 using CS = Microsoft.CodeAnalysis.CSharp;

src/Docfx.Dotnet/SymbolHelper.cs

@@ -1,4 +1,7 @@
-using System.Diagnostics.CodeAnalysis;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Diagnostics.CodeAnalysis;
 using Microsoft.CodeAnalysis;
 
 #nullable enable