Enable build time warnings for IDE code analysis rules

* Enables build time warnings for readonly, modifier ordering and const
* Fixes all of the warnings

Author: pranavkm

.editorconfig

@@ -195,6 +195,7 @@ dotnet_diagnostic.CA2208.severity = warning
 dotnet_diagnostic.IDE0035.severity = warning
 
 # IDE0036: Order modifiers
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
 dotnet_diagnostic.IDE0036.severity = warning
 
 # IDE0043: Format string contains invalid placeholder
@@ -204,7 +205,7 @@ dotnet_diagnostic.IDE0043.severity = warning
 dotnet_diagnostic.IDE0044.severity = warning
 
 # IDE0073: File header
-dotnet_diagnostic.IDE0073.severity = warning
+dotnet_diagnostic.IDE0073.severity = suggestion
 file_header_template = Copyright (c) .NET Foundation. All rights reserved.\nLicensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 [**/{test,samples,perf}/**.{cs,vb}]

eng/targets/CSharp.Common.targets

@@ -27,6 +27,9 @@
         '$(ISBenchmarkProject)' == 'true' OR
         '$(IsSampleProject)' == 'true' OR
         '$(IsMicrobenchmarksProject)' == 'true'">$(NoWarn);CA1416</NoWarn>
+
+    <!-- Enable .NET code style analysis during build for src projects. -->
+    <EnforceCodeStyleInBuild Condition="'$(EnforceCodeStyleInBuild)' == ''">true</EnforceCodeStyleInBuild>
   </PropertyGroup>
 
   <ItemGroup Condition=" '$(DotNetBuildFromSource)' != 'true' AND $(AddPublicApiAnalyzers) ">

src/Analyzers/Analyzers/src/StartupAnalysis.cs

@@ -8,7 +8,7 @@ namespace Microsoft.AspNetCore.Analyzers
 {
     internal class StartupAnalysis
     {
-        private ImmutableDictionary<INamedTypeSymbol, ImmutableArray<object>> _analysesByType;
+        private readonly ImmutableDictionary<INamedTypeSymbol, ImmutableArray<object>> _analysesByType;
 
         public StartupAnalysis(
             StartupSymbols startupSymbols,

src/Analyzers/Analyzers/src/StartupAnalyzer.Diagnostics.cs

@@ -27,7 +27,7 @@ static Diagnostics()
                 });
             }
 
-            internal readonly static DiagnosticDescriptor BuildServiceProviderShouldNotCalledInConfigureServicesMethod = new DiagnosticDescriptor(
+            internal static readonly DiagnosticDescriptor BuildServiceProviderShouldNotCalledInConfigureServicesMethod = new DiagnosticDescriptor(
                 "ASP0000",
                 "Do not call 'IServiceCollection.BuildServiceProvider' in 'ConfigureServices'",
                 "Calling 'BuildServiceProvider' from application code results in an additional copy of singleton services being created. Consider alternatives such as dependency injecting services as parameters to 'Configure'.",
@@ -36,7 +36,7 @@ static Diagnostics()
                 isEnabledByDefault: true,
                 helpLinkUri: "https://aka.ms/AA5k895");
 
-            internal readonly static DiagnosticDescriptor UnsupportedUseMvcWithEndpointRouting = new DiagnosticDescriptor(
+            internal static readonly DiagnosticDescriptor UnsupportedUseMvcWithEndpointRouting = new DiagnosticDescriptor(
                 "MVC1005",
                 "Cannot use UseMvc with Endpoint Routing.",
                 "Using '{0}' to configure MVC is not supported while using Endpoint Routing. To continue using '{0}', please set 'MvcOptions.EnableEndpointRouting = false' inside '{1}'.",
@@ -45,7 +45,7 @@ static Diagnostics()
                 isEnabledByDefault: true,
                 helpLinkUri: "https://aka.ms/YJggeFn");
 
-            internal readonly static DiagnosticDescriptor IncorrectlyConfiguredAuthorizationMiddleware = new DiagnosticDescriptor(
+            internal static readonly DiagnosticDescriptor IncorrectlyConfiguredAuthorizationMiddleware = new DiagnosticDescriptor(
                 "ASP0001",
                 "Authorization middleware is incorrectly configured.",
                 "The call to UseAuthorization should appear between app.UseRouting() and app.UseEndpoints(..) for authorization to be correctly evaluated.",

src/Azure/AzureAD/Authentication.AzureADB2C.UI/src/AzureAdB2COpenIDConnectEventHandlers.cs

@@ -13,7 +13,7 @@ namespace Microsoft.AspNetCore.Authentication.AzureADB2C.UI
     [Obsolete("This is obsolete and will be removed in a future version. Use Microsoft.Identity.Web instead. See https://aka.ms/ms-identity-web.")]
     internal class AzureADB2COpenIDConnectEventHandlers
     {
-        private IDictionary<string, string> _policyToIssuerAddress =
+        private readonly IDictionary<string, string> _policyToIssuerAddress =
             new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
 
         public AzureADB2COpenIDConnectEventHandlers(string schemeName, AzureADB2COptions options)

src/Caching/SqlServer/src/PlatformHelper.cs

@@ -7,7 +7,7 @@ namespace Microsoft.Extensions.Caching.SqlServer
 {
     internal static class PlatformHelper
     {
-        private static Lazy<bool> _isMono = new Lazy<bool>(() => Type.GetType("Mono.Runtime") != null);
+        private static readonly Lazy<bool> _isMono = new Lazy<bool>(() => Type.GetType("Mono.Runtime") != null);
 
         public static bool IsMono
         {
@@ -17,4 +17,4 @@ public static bool IsMono
             }
         }
     }
-}
+}

src/Components/Analyzers/test/TestFiles/ComponentInternalUsageDiagnosticsAnalyzerTest/UsesRendererTypesInDeclarations.cs

@@ -6,7 +6,7 @@ namespace Microsoft.AspNetCore.Components.Analyzers.Tests.TestFiles.ComponentInt
 {
     /*MMBaseClass*/class UsesRendererTypesInDeclarations : Renderer
     {
-        private Renderer /*MMField*/_field = null;
+        private readonly Renderer /*MMField*/_field = null;
 
         public UsesRendererTypesInDeclarations()
             /*MMInvocation*/: base(null, null)

src/Components/Components/src/CascadingParameterState.cs

@@ -13,7 +13,7 @@ namespace Microsoft.AspNetCore.Components
 {
     internal readonly struct CascadingParameterState
     {
-        private readonly static ConcurrentDictionary<Type, ReflectedCascadingParameterInfo[]> _cachedInfos = new();
+        private static readonly ConcurrentDictionary<Type, ReflectedCascadingParameterInfo[]> _cachedInfos = new();
 
         public string LocalValueName { get; }
         public ICascadingValueComponent ValueSupplier { get; }

src/Components/Components/src/DynamicComponent.cs

@@ -16,7 +16,7 @@ namespace Microsoft.AspNetCore.Components
     public class DynamicComponent : IComponent
     {
         private RenderHandle _renderHandle;
-        private RenderFragment _cachedRenderFragment;
+        private readonly RenderFragment _cachedRenderFragment;
 
         /// <summary>
         /// Constructs an instance of <see cref="DynamicComponent"/>.

src/Components/Components/src/Lifetime/ComponentApplicationLifetime.cs

@@ -16,7 +16,7 @@ namespace Microsoft.AspNetCore.Components.Lifetime
     public class ComponentApplicationLifetime
     {
         private bool _stateIsPersisted;
-        private List<ComponentApplicationState.OnPersistingCallback> _pauseCallbacks = new();
+        private readonly List<ComponentApplicationState.OnPersistingCallback> _pauseCallbacks = new();
         private readonly Dictionary<string, byte[]> _currentState = new();
         private readonly ILogger<ComponentApplicationLifetime> _logger;
 

src/Components/Components/src/RenderTree/EventArgsTypeCache.cs

@@ -9,7 +9,7 @@ namespace Microsoft.AspNetCore.Components.RenderTree
 {
     internal static class EventArgsTypeCache
     {
-        private static ConcurrentDictionary<MethodInfo, Type> Cache = new ConcurrentDictionary<MethodInfo, Type>();
+        private static readonly ConcurrentDictionary<MethodInfo, Type> Cache = new ConcurrentDictionary<MethodInfo, Type>();
 
         public static Type GetEventArgsType(MethodInfo methodInfo)
         {

src/Components/Components/src/Rendering/RenderTreeBuilder.cs

@@ -20,9 +20,9 @@ namespace Microsoft.AspNetCore.Components.Rendering
     /// </summary>
     public sealed class RenderTreeBuilder : IDisposable
     {
-        private readonly static object BoxedTrue = true;
-        private readonly static object BoxedFalse = false;
-        private readonly static string ComponentReferenceCaptureInvalidParentMessage = $"Component reference captures may only be added as children of frames of type {RenderTreeFrameType.Component}";
+        private static readonly object BoxedTrue = true;
+        private static readonly object BoxedFalse = false;
+        private static readonly string ComponentReferenceCaptureInvalidParentMessage = $"Component reference captures may only be added as children of frames of type {RenderTreeFrameType.Component}";
 
         private readonly RenderTreeFrameArrayBuilder _entries = new RenderTreeFrameArrayBuilder();
         private readonly Stack<int> _openElementIndices = new Stack<int>();

src/Components/Components/src/Rendering/SimplifiedStringHashComparer.cs

@@ -18,7 +18,7 @@ namespace Microsoft.AspNetCore.Components.Rendering
     /// </summary>
     internal class SimplifiedStringHashComparer : IEqualityComparer<string>
     {
-        public readonly static SimplifiedStringHashComparer Instance = new SimplifiedStringHashComparer();
+        public static readonly SimplifiedStringHashComparer Instance = new SimplifiedStringHashComparer();
 
         public bool Equals(string? x, string? y)
         {

src/Components/Components/test/Lifetime/ComponentApplicationLifetimeTest.cs

@@ -204,7 +204,7 @@ public TestRenderer() : base(new ServiceCollection().BuildServiceProvider(), Nul
             {
             }
 
-            private Dispatcher _dispatcher = Dispatcher.CreateDefault();
+            private readonly Dispatcher _dispatcher = Dispatcher.CreateDefault();
 
             public override Dispatcher Dispatcher => _dispatcher;
 

src/Components/Components/test/RendererTest.cs

@@ -4443,7 +4443,7 @@ protected override Task UpdateDisplayAsync(in RenderBatch renderBatch)
         private class TestComponent : IComponent, IDisposable
         {
             private RenderHandle _renderHandle;
-            private RenderFragment _renderFragment;
+            private readonly RenderFragment _renderFragment;
 
             public TestComponent(RenderFragment renderFragment)
             {
@@ -5211,7 +5211,7 @@ public Task SetParametersAsync(ParameterView parameters)
 
         private class TestErrorBoundary : AutoRenderComponent, IErrorBoundary
         {
-            private TaskCompletionSource receivedErrorTaskCompletionSource = new();
+            private readonly TaskCompletionSource receivedErrorTaskCompletionSource = new();
 
             public Exception ReceivedException { get; private set; }
             public Task ReceivedErrorTask => receivedErrorTaskCompletionSource.Task;

src/Components/Components/test/Routing/RouteTableFactoryTests.cs

@@ -1013,8 +1013,8 @@ public void SuppliesNullForUnusedHandlerParameters()
 
         private class TestRouteTableBuilder
         {
-            IList<(string Template, Type Handler)> _routeTemplates = new List<(string, Type)>();
-            Type _handler = typeof(object);
+            readonly IList<(string Template, Type Handler)> _routeTemplates = new List<(string, Type)>();
+            readonly Type _handler = typeof(object);
 
             public TestRouteTableBuilder AddRoute(string template, Type handler = null)
             {

src/Components/Forms/src/ValidationStateChangedEventArgs.cs

@@ -13,7 +13,7 @@ public sealed class ValidationStateChangedEventArgs : EventArgs
         /// <summary>
         /// Gets a shared empty instance of <see cref="ValidationStateChangedEventArgs"/>.
         /// </summary>
-        public new static readonly ValidationStateChangedEventArgs Empty = new ValidationStateChangedEventArgs();
+        public static new readonly ValidationStateChangedEventArgs Empty = new ValidationStateChangedEventArgs();
 
         /// <summary>
         /// Creates a new instance of <see cref="ValidationStateChangedEventArgs" />

src/Components/Ignitor/src/NodeSerializer.cs

@@ -37,7 +37,7 @@ private class Serializer
             private readonly TextWriter _writer;
             private int _depth;
             private bool _atStartOfLine;
-            private HashSet<Node> _visited = new HashSet<Node>();
+            private readonly HashSet<Node> _visited = new HashSet<Node>();
 
             public Serializer(TextWriter writer)
             {

src/Components/Server/test/Circuits/RemoteRendererTest.cs

@@ -452,7 +452,7 @@ public async Task RenderComponentAsync<TComponent>(ParameterView initialParamete
         private class TestComponent : IComponent, IHandleAfterRender
         {
             private RenderHandle _renderHandle;
-            private RenderFragment _renderFragment = (builder) =>
+            private readonly RenderFragment _renderFragment = (builder) =>
             {
                 builder.OpenElement(0, "my element");
                 builder.AddContent(1, "some text");

src/Components/Server/test/Circuits/RenderBatchWriterTest.cs

@@ -20,7 +20,7 @@ namespace Microsoft.AspNetCore.Components.Server
 {
     public class RenderBatchWriterTest
     {
-        static object NullStringMarker = new object();
+        static readonly object NullStringMarker = new object();
 
         [Fact]
         public void CanSerializeEmptyRenderBatch()

src/Components/Web/src/Forms/EditContextFieldClassExtensions.cs

@@ -12,7 +12,7 @@ namespace Microsoft.AspNetCore.Components.Forms
     /// </summary>
     public static class EditContextFieldClassExtensions
     {
-        private readonly static object FieldCssClassProviderKey = new object();
+        private static readonly object FieldCssClassProviderKey = new object();
 
         /// <summary>
         /// Gets a string that indicates the status of the specified field as a CSS class. This will include

src/Components/Web/src/Forms/FieldCssClassProvider.cs

@@ -11,7 +11,7 @@ namespace Microsoft.AspNetCore.Components.Forms
     /// </summary>
     public class FieldCssClassProvider
     {
-        internal readonly static FieldCssClassProvider Instance = new FieldCssClassProvider();
+        internal static readonly FieldCssClassProvider Instance = new FieldCssClassProvider();
 
         /// <summary>
         /// Gets a string that indicates the status of the specified field as a CSS class.

src/Components/WebAssembly/Server/src/TargetPickerUi.cs

@@ -27,8 +27,8 @@ public class TargetPickerUi
             DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
         };
 
-        private string _browserHost;
-        private string _debugProxyUrl;
+        private readonly string _browserHost;
+        private readonly string _debugProxyUrl;
 
         /// <summary>
         /// Initialize a new instance of <see cref="TargetPickerUi"/>.

src/Components/WebAssembly/WebAssembly.Authentication/test/RemoteAuthenticatorCoreTests.cs

@@ -752,7 +752,7 @@ public TestRemoteAuthenticationService(
             public Func<RemoteAuthenticationContext<RemoteAuthenticationState>, Task<RemoteAuthenticationResult<RemoteAuthenticationState>>> CompleteSignOutCallback { get; set; }
             public Func<ValueTask<ClaimsPrincipal>> GetAuthenticatedUserCallback { get; set; }
 
-            public async override Task<AuthenticationState> GetAuthenticationStateAsync() => new AuthenticationState(await GetAuthenticatedUserCallback());
+            public override async Task<AuthenticationState> GetAuthenticationStateAsync() => new AuthenticationState(await GetAuthenticatedUserCallback());
 
             public override Task<RemoteAuthenticationResult<RemoteAuthenticationState>> CompleteSignInAsync(RemoteAuthenticationContext<RemoteAuthenticationState> context) => CompleteSignInCallback(context);
 

src/Components/WebAssembly/WebAssembly/src/HotReload/WebAssemblyHotReload.cs

@@ -20,7 +20,7 @@ namespace Microsoft.AspNetCore.Components.WebAssembly.HotReload
     public static class WebAssemblyHotReload
     {
         private static HotReloadAgent? _hotReloadAgent;
-        private static UpdateDelta[] _updateDeltas = new[]
+        private static readonly UpdateDelta[] _updateDeltas = new[]
         {
             new UpdateDelta(),
         };

src/Components/WebAssembly/testassets/HostedInAspNet.Server/BootResourceRequestLog.cs

@@ -9,7 +9,7 @@ namespace HostedInAspNet.Server
 {
     public class BootResourceRequestLog
     {
-        private ConcurrentBag<string> _requestPaths = new ConcurrentBag<string>();
+        private readonly ConcurrentBag<string> _requestPaths = new ConcurrentBag<string>();
 
         public IReadOnlyCollection<string> RequestPaths => _requestPaths;
 

src/Components/WebAssembly/testassets/Wasm.Authentication.Client/PreferencesUserFactory.cs

@@ -21,7 +21,7 @@ public PreferencesUserFactory(NavigationManager navigationManager, IAccessTokenP
             _httpClient = new HttpClient { BaseAddress = new Uri(navigationManager.BaseUri) };
         }
 
-        public async override ValueTask<ClaimsPrincipal> CreateUserAsync(
+        public override async ValueTask<ClaimsPrincipal> CreateUserAsync(
             OidcAccount account,
             RemoteAuthenticationUserOptions options)
         {

src/Components/WebView/Samples/PhotinoPlatform/src/PhotinoWebViewManager.cs

@@ -19,11 +19,11 @@ internal class PhotinoWebViewManager : WebViewManager
         // because webview2 won't let you do top-level navigation to such a URL.
         // On Linux/Mac, we must use a custom scheme, because their webviews
         // don't have a way to intercept http:// scheme requests.
-        internal readonly static string BlazorAppScheme = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
+        internal static readonly string BlazorAppScheme = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
             ? "http"
             : "app";
 
-        internal readonly static string AppBaseUri
+        internal static readonly string AppBaseUri
             = $"{BlazorAppScheme}://0.0.0.0/";
 
         public PhotinoWebViewManager(PhotinoWindow window, IServiceProvider provider, Dispatcher dispatcher, Uri appBaseUri, IFileProvider fileProvider, string hostPageRelativePath)

src/Components/WebView/WebView/src/StaticContentProvider.cs

@@ -15,7 +15,7 @@ internal class StaticContentProvider
         private readonly Uri _appBaseUri;
         private readonly string _hostPageRelativePath;
         private static readonly FileExtensionContentTypeProvider ContentTypeProvider = new();
-        private static ManifestEmbeddedFileProvider _manifestProvider =
+        private static readonly ManifestEmbeddedFileProvider _manifestProvider =
             new ManifestEmbeddedFileProvider(typeof(StaticContentProvider).Assembly);
 
         public StaticContentProvider(IFileProvider fileProvider, Uri appBaseUri, string hostPageRelativePath)

src/Components/WebView/WebView/test/Infrastructure/TestWebViewManager.cs

@@ -9,8 +9,8 @@ namespace Microsoft.AspNetCore.Components.WebView
 {
     public class TestWebViewManager : WebViewManager
     {
-        private static Uri AppBaseUri = new Uri("app://testhost/");
-        private List<string> _sentIpcMessages = new();
+        private static readonly Uri AppBaseUri = new Uri("app://testhost/");
+        private readonly List<string> _sentIpcMessages = new();
 
         public TestWebViewManager(IServiceProvider provider, IFileProvider fileProvider)
             : base(provider, Dispatcher.CreateDefault(), AppBaseUri, fileProvider, hostPageRelativePath: "index.html")

src/Components/benchmarkapps/Wasm.Performance/Driver/Selenium.cs

@@ -14,9 +14,9 @@ namespace Wasm.Performance.Driver
     class Selenium
     {
         const int SeleniumPort = 4444;
-        static bool RunHeadlessBrowser = true;
+        const bool RunHeadlessBrowser = true;
 
-        static bool PoolForBrowserLogs = true;
+        const bool PoolForBrowserLogs = true;
 
         private static async ValueTask<Uri> WaitForServerAsync(int port, CancellationToken cancellationToken)
         {

src/Components/test/E2ETest/ServerExecutionTests/IgnitorTest.cs

@@ -83,7 +83,7 @@ protected virtual Task InitializeAsync()
             return Task.CompletedTask;
         }
 
-        protected async virtual Task DisposeAsync()
+        protected virtual async Task DisposeAsync()
         {
             if (TestSink != null)
             {

src/Components/test/E2ETest/ServerExecutionTests/InteropReliabilityTests.cs

@@ -27,7 +27,7 @@ public InteropReliabilityTests(BasicTestAppServerSiteFixture<ServerStartup> serv
         {
         }
 
-        protected async override Task InitializeAsync()
+        protected override async Task InitializeAsync()
         {
             var rootUri = ServerFixture.RootUri;
             await ConnectAutomaticallyAndWait(new Uri(rootUri, "/subdir"));

src/Components/test/E2ETestMigration/Infrastructure/PlaywrightTestBase.cs

@@ -25,7 +25,7 @@ public class PlaywrightTestBase : LoggedTest, IAsyncLifetime
 
         public PlaywrightTestBase(ITestOutputHelper output) : base(output) { }
 
-        protected async override Task InitializeCoreAsync(TestContext context)
+        protected override async Task InitializeCoreAsync(TestContext context)
         {
             BrowserManager = await BrowserManager.CreateAsync(CreateConfiguration(), LoggerFactory);
             BrowserContextInfo = new ContextInformation(LoggerFactory);

src/Components/test/testassets/BasicTestApp/PrependMessageLoggerProvider.cs

@@ -13,8 +13,8 @@ namespace BasicTestApp
     internal class PrependMessageLoggerProvider : ILoggerProvider
     {
         ILogger _logger;
-        string _message;
-        ILogger _defaultLogger;
+        readonly string _message;
+        readonly ILogger _defaultLogger;
         private bool _disposed = false;
 
         public PrependMessageLoggerProvider(string message, IJSRuntime runtime)

src/Components/test/testassets/TestServer/Controllers/UserController.cs

@@ -13,7 +13,7 @@ public class UserController : Controller
         // to the client. It's up to the developer to choose what kind of authentication state
         // data is needed on the client so it can display suitable options in the UI.
         // In this class, we inform the client only about certain roles and certain other claims.
-        static string[] ExposedRoles = new[] { "IrrelevantRole", "TestRole" };
+        static readonly string[] ExposedRoles = new[] { "IrrelevantRole", "TestRole" };
 
         // GET api/user
         [HttpGet]

src/Components/test/testassets/TestServer/ResourceRequestLog.cs

@@ -8,7 +8,7 @@ namespace TestServer
 {
     public class ResourceRequestLog
     {
-        private List<string> _requestPaths = new List<string>();
+        private readonly List<string> _requestPaths = new List<string>();
 
         public IReadOnlyCollection<string> RequestPaths => _requestPaths;