refactors: use readonly backing fields

Refactors constructors to use readonly backing fields for injected dependencies.

Adds .editorconfig settings for .NET code style and updates existing settings.

Author: arturcic

.editorconfig

@@ -1,7 +1,7 @@
+root = true
 # http://editorconfig.org
 
 # top-most EditorConfig file
-root = true
 
 [*]
 indent_style = space
@@ -10,6 +10,12 @@ end_of_line = lf
 trim_trailing_whitespace = true
 insert_final_newline = true
 
+# Microsoft .NET properties
+dotnet_style_qualification_for_event = false:none
+dotnet_style_qualification_for_field = false:none
+dotnet_style_qualification_for_method = false:none
+dotnet_style_qualification_for_property = false:none
+
 [*.yml]
 indent_size = 2
 
@@ -156,18 +162,18 @@ resharper_csharp_align_multiline_parameter = true
 resharper_csharp_instance_members_qualify_members = field
 
 # IDE0005: Using directive is unnecessary.
-dotnet_diagnostic.IDE0005.severity = warning
+dotnet_diagnostic.ide0005.severity = warning
 
 # RCS1037: Remove trailing white-space.
-dotnet_diagnostic.RCS1037.severity = error
+dotnet_diagnostic.rcs1037.severity = error
 
 # RCS1036: Remove redundant empty line.
-dotnet_diagnostic.RCS1036.severity = error
+dotnet_diagnostic.rcs1036.severity = error
 
 xml_space_before_self_closing = true
 
 resharper_arrange_object_creation_when_type_not_evident_highlighting = none
 
 resharper_unused_auto_property_accessor_global_highlighting = none
 
-resharper_unused_method_return_value_global_highlighting = none
+resharper_unused_method_return_value_global_highlighting = none

new-cli/GitVersion.Calculation/CalculateCommand.cs

@@ -9,20 +9,20 @@ public record CalculateSettings : GitVersionSettings;
 [Command("calculate", "Calculates the version object from the git history.")]
 public class CalculateCommand(ILogger logger, IService service, IGitRepository repository) : ICommand<CalculateSettings>
 {
-    private readonly ILogger logger = logger.NotNull();
-    private readonly IService service = service.NotNull();
-    private readonly IGitRepository repository = repository.NotNull();
+    private readonly ILogger _logger = logger.NotNull();
+    private readonly IService _service = service.NotNull();
+    private readonly IGitRepository _repository = repository.NotNull();
 
     public Task<int> InvokeAsync(CalculateSettings settings, CancellationToken cancellationToken = default)
     {
-        var value = service.Call();
+        var value = _service.Call();
         if (settings.WorkDir != null)
         {
-            this.repository.DiscoverRepository(settings.WorkDir.FullName);
-            var branches = this.repository.Branches.ToList();
-            this.logger.LogInformation("Command : 'calculate', LogFile : '{logFile}', WorkDir : '{workDir}' ",
+            _repository.DiscoverRepository(settings.WorkDir.FullName);
+            var branches = _repository.Branches.ToList();
+            _logger.LogInformation("Command : 'calculate', LogFile : '{logFile}', WorkDir : '{workDir}' ",
                 settings.LogFile, settings.WorkDir);
-            this.logger.LogInformation("Found {count} branches", branches.Count);
+            _logger.LogInformation("Found {count} branches", branches.Count);
         }
 
         return Task.FromResult(value);

new-cli/GitVersion.Cli.Generator/TypeVisitor.cs

@@ -5,7 +5,7 @@ internal class TypeVisitor(Func<INamedTypeSymbol, bool> searchQuery, Cancellatio
 {
     private readonly HashSet<INamedTypeSymbol> _exportedTypes = new(SymbolEqualityComparer.Default);
 
-    public ImmutableArray<INamedTypeSymbol> GetResults() => [.. this._exportedTypes];
+    public ImmutableArray<INamedTypeSymbol> GetResults() => [.. _exportedTypes];
 
     public override void VisitAssembly(IAssemblySymbol symbol)
     {
@@ -28,7 +28,7 @@ public override void VisitNamedType(INamedTypeSymbol type)
 
         if (searchQuery(type))
         {
-            this._exportedTypes.Add(type);
+            _exportedTypes.Add(type);
         }
     }
 }

new-cli/GitVersion.Cli/SystemCommandline/GitVersionAppRunner.cs

@@ -23,7 +23,7 @@ public Task<int> RunAsync(string[] args, CancellationToken cancellationToken)
         return parseResult.InvokeAsync(cancellationToken: cancellationToken);
     }
 
-    // Note: there are 2 locations to watch for dotnet-suggest
+    // Note: there are 2 locations to watch for the dotnet-suggest tool
     // - sentinel file: $env:TEMP\system-commandline-sentinel-files\ and
     // - registration file: $env:LOCALAPPDATA\.dotnet-suggest-registration.txt or $HOME/.dotnet-suggest-registration.txt
 

new-cli/GitVersion.Configuration/ConfigCommand.cs

@@ -8,13 +8,13 @@ public record ConfigSettings : GitVersionSettings;
 [Command("config", "Manages the GitVersion configuration file.")]
 public class ConfigCommand(ILogger logger, IService service) : ICommand<ConfigSettings>
 {
-    private readonly ILogger logger = logger.NotNull();
-    private readonly IService service = service.NotNull();
+    private readonly ILogger _logger = logger.NotNull();
+    private readonly IService _service = service.NotNull();
 
     public Task<int> InvokeAsync(ConfigSettings settings, CancellationToken cancellationToken = default)
     {
-        var value = service.Call();
-        logger.LogInformation($"Command : 'config', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
+        var value = _service.Call();
+        _logger.LogInformation($"Command : 'config', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
         return Task.FromResult(value);
     }
 }

new-cli/GitVersion.Configuration/Init/ConfigInitCommand.cs

@@ -8,13 +8,13 @@ public record ConfigInitSettings : ConfigSettings;
 [Command<ConfigCommand>("init", "Inits the configuration for current repository.")]
 public class ConfigInitCommand(ILogger logger, IService service) : ICommand<ConfigInitSettings>
 {
-    private readonly ILogger logger = logger.NotNull();
-    private readonly IService service = service.NotNull();
+    private readonly ILogger _logger = logger.NotNull();
+    private readonly IService _service = service.NotNull();
 
     public Task<int> InvokeAsync(ConfigInitSettings settings, CancellationToken cancellationToken = default)
     {
-        var value = service.Call();
-        logger.LogInformation($"Command : 'config init', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
+        var value = _service.Call();
+        _logger.LogInformation($"Command : 'config init', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
         return Task.FromResult(value);
     }
 }

new-cli/GitVersion.Configuration/Show/ConfigShowCommand.cs

@@ -8,13 +8,13 @@ public record ConfigShowSettings : ConfigSettings;
 [Command<ConfigCommand>("show", "Shows the effective configuration.")]
 public class ConfigShowCommand(ILogger logger, IService service) : ICommand<ConfigShowSettings>
 {
-    private readonly ILogger logger = logger.NotNull();
-    private readonly IService service = service.NotNull();
+    private readonly ILogger _logger = logger.NotNull();
+    private readonly IService _service = service.NotNull();
 
     public Task<int> InvokeAsync(ConfigShowSettings settings, CancellationToken cancellationToken = default)
     {
-        var value = service.Call();
-        logger.LogInformation($"Command : 'config show', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
+        var value = _service.Call();
+        _logger.LogInformation($"Command : 'config show', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
         return Task.FromResult(value);
     }
 }

new-cli/GitVersion.Core/Extensions/ServiceCollectionExtensions.cs

@@ -2,6 +2,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Serilog;
+using ILogger = Serilog.ILogger;
 
 namespace GitVersion.Extensions;
 
@@ -23,6 +24,7 @@ public static IServiceCollection RegisterLogging(this IServiceCollection service
             var logger = CreateLogger();
             builder.AddSerilog(logger, dispose: true);
         });
+
         return services;
     }
 
@@ -37,9 +39,9 @@ private static Serilog.Core.Logger CreateLogger()
             // serilog.sinks.map will defer the configuration of the sink to be on demand,
             // allowing us to look at the properties set by the enricher to set the path appropriately
             .WriteTo.Console()
-            .WriteTo.Map(LoggingEnricher.LogFilePathPropertyName, (logFilePath, wt) =>
+            .WriteTo.Map(LoggingEnricher.LogFilePathPropertyName, (logFilePath, sinkConfiguration) =>
             {
-                if (!string.IsNullOrEmpty(logFilePath)) wt.File(logFilePath);
+                if (!string.IsNullOrEmpty(logFilePath)) sinkConfiguration.File(logFilePath);
             }, 1)
             .CreateLogger();
         return logger;

new-cli/GitVersion.Core/Infrastructure/LoggingEnricher.cs

@@ -20,17 +20,17 @@ public void Enrich(LogEvent logEvent, ILogEventPropertyFactory propertyFactory)
         // we won't have the setting, so a default value for the log file will be required
         LogEventProperty logFilePathProperty;
 
-        if (this._cachedLogFilePathProperty != null && Path.Equals(this._cachedLogFilePath))
+        if (_cachedLogFilePathProperty != null && Path.Equals(_cachedLogFilePath))
         {
             // The Path hasn't changed, so let's use the cached property
-            logFilePathProperty = this._cachedLogFilePathProperty;
+            logFilePathProperty = _cachedLogFilePathProperty;
         }
         else
         {
             // We've got a new path for the log. Let's create a new property
             // and cache it for future log events to use
-            this._cachedLogFilePath = Path;
-            this._cachedLogFilePathProperty = logFilePathProperty = propertyFactory.CreateProperty(LogFilePathPropertyName, Path);
+            _cachedLogFilePath = Path;
+            _cachedLogFilePathProperty = logFilePathProperty = propertyFactory.CreateProperty(LogFilePathPropertyName, Path);
         }
 
         logEvent.AddPropertyIfAbsent(logFilePathProperty);

new-cli/GitVersion.Normalization/NormalizeCommand.cs

@@ -8,13 +8,13 @@ public record NormalizeSettings : GitVersionSettings;
 [Command("normalize", "Normalizes the git repository for GitVersion calculations.")]
 public class NormalizeCommand(ILogger logger, IService service) : ICommand<NormalizeSettings>
 {
-    private readonly ILogger logger = logger.NotNull();
-    private readonly IService service = service.NotNull();
+    private readonly ILogger _logger = logger.NotNull();
+    private readonly IService _service = service.NotNull();
 
     public Task<int> InvokeAsync(NormalizeSettings settings, CancellationToken cancellationToken = default)
     {
-        var value = service.Call();
-        logger.LogInformation($"Command : 'normalize', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
+        var value = _service.Call();
+        _logger.LogInformation($"Command : 'normalize', LogFile : '{settings.LogFile}', WorkDir : '{settings.WorkDir}' ");
         return Task.FromResult(value);
     }
 }