Refactoring to DI (#1243)

Author: waldekmastykarz

.editorconfig

@@ -39,7 +39,7 @@ dotnet_style_parentheses_in_other_operators = never_if_unnecessary
 dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity
 
 # Modifier preferences
-dotnet_style_require_accessibility_modifiers = for_non_interface_members
+dotnet_style_require_accessibility_modifiers = never
 
 # Expression-level preferences
 dotnet_style_coalesce_expression = true
@@ -76,17 +76,17 @@ dotnet_style_allow_statement_immediately_after_block_experimental = true
 #### C# Coding Conventions ####
 
 # var preferences
-csharp_style_var_elsewhere = false
-csharp_style_var_for_built_in_types = false
-csharp_style_var_when_type_is_apparent = false
+csharp_style_var_elsewhere = true
+csharp_style_var_for_built_in_types = true
+csharp_style_var_when_type_is_apparent = true
 
 # Expression-bodied members
 csharp_style_expression_bodied_accessors = true
 csharp_style_expression_bodied_constructors = false
 csharp_style_expression_bodied_indexers = true
 csharp_style_expression_bodied_lambdas = true
 csharp_style_expression_bodied_local_functions = false
-csharp_style_expression_bodied_methods = false
+csharp_style_expression_bodied_methods = when_on_single_line
 csharp_style_expression_bodied_operators = false
 csharp_style_expression_bodied_properties = true
 
@@ -108,7 +108,7 @@ csharp_preferred_modifier_order = public,private,protected,internal,static,exter
 # Code-block preferences
 csharp_prefer_braces = true
 csharp_prefer_simple_using_statement = true
-csharp_style_namespace_declarations = block_scoped
+csharp_style_namespace_declarations = file_scoped
 csharp_style_prefer_method_group_conversion = true
 csharp_style_prefer_top_level_statements = true
 
@@ -223,3 +223,44 @@ dotnet_naming_style.begins_with_i.required_prefix = I
 dotnet_naming_style.begins_with_i.required_suffix = 
 dotnet_naming_style.begins_with_i.word_separator = 
 dotnet_naming_style.begins_with_i.capitalization = pascal_case
+
+# Do not catch general exception types
+dotnet_diagnostic.CA1031.severity = none
+# URI parameters should not be strings
+dotnet_diagnostic.CA1054.severity = none
+# URI properties should not be strings
+dotnet_diagnostic.CA1056.severity = none
+# Do not pass literals as localized parameters
+dotnet_diagnostic.CA1303.severity = none
+# Normalize strings to uppercase
+dotnet_diagnostic.CA1308.severity = none
+# Avoid uninstantiated internal classes
+dotnet_diagnostic.CA1812.severity = none
+# Use the LoggerMessage delegates
+dotnet_diagnostic.CA1848.severity = none
+# Possible multiple enumerations of IEnumerable collection
+dotnet_diagnostic.CA1851.severity = none
+# Do not directly await a Task
+dotnet_diagnostic.CA2007.severity = none
+# Pass System.Uri objects instead of strings
+dotnet_diagnostic.CA2234.severity = none
+# Do not use insecure randomness
+dotnet_diagnostic.CA5394.severity = none
+# IDE0005: Using directive is unnecessary
+dotnet_diagnostic.IDE0005.severity = warning
+# Use expression body for methods
+dotnet_diagnostic.IDE0022.severity = none
+# Use conditional expression for assignment
+dotnet_diagnostic.IDE0045.severity = none
+# Use conditional expression for return
+dotnet_diagnostic.IDE0046.severity = none
+# Use GeneratedRegexAttribute to generate the regular expression implementation at compile time.
+dotnet_diagnostic.SYSLIB1045.severity = none
+# Implement internal logic asynchronously
+dotnet_diagnostic.VSTHRD102.severity = none
+# Offer async option
+dotnet_diagnostic.VSTHRD104.severity = none
+# Add .ConfigureAwait(bool) to your await expression
+dotnet_diagnostic.VSTHRD111.severity = none
+
+dotnet_analyzer_diagnostic.severity = warning

.gitattributes

@@ -1 +1,2 @@
+* text=auto
 *.sh text eol=lf

.github/workflows/create-release.yml

@@ -39,27 +39,27 @@ jobs:
         if: contains(github.ref_name, '-beta')
         run: |
           pushd
-          cd ./dev-proxy
-          $content = Get-Content dev-proxy.csproj
-          $content -replace '<AssemblyName>devproxy</AssemblyName>', '<AssemblyName>devproxy-beta</AssemblyName>' | Set-Content dev-proxy.csproj
+          cd ./DevProxy
+          $content = Get-Content DevProxy.csproj
+          $content -replace '<AssemblyName>devproxy</AssemblyName>', '<AssemblyName>devproxy-beta</AssemblyName>' | Set-Content DevProxy.csproj
           popd
       - name: Set newVersionNotification for beta
         if: contains(github.ref_name, '-beta')
         run: |
           pushd
-          cd ./dev-proxy
+          cd ./DevProxy
           $content = Get-Content devproxyrc.json
           $content -replace '"newVersionNotification": "stable"', '"newVersionNotification": "beta"' | Set-Content devproxyrc.json
           popd
       - name: Publish ${{ matrix.architecture }}
-        run: dotnet publish ./dev-proxy/dev-proxy.csproj -c Release -p:PublishSingleFile=true -p:InformationalVersion=$("${{ github.ref_name }}".Substring(1)) -r ${{ matrix.architecture }} --self-contained -o ./${{ env.release }}
+        run: dotnet publish ./DevProxy/DevProxy.csproj -c Release -p:PublishSingleFile=true -p:InformationalVersion=$("${{ github.ref_name }}".Substring(1)) -r ${{ matrix.architecture }} --self-contained -o ./${{ env.release }}
       - name: Build plugins
-        run: dotnet build ./dev-proxy-plugins/dev-proxy-plugins.csproj -p:InformationalVersion=$("${{ github.ref_name }}".Substring(1)) -c Release -r ${{ matrix.architecture }} --no-self-contained
+        run: dotnet build ./DevProxy.Plugins/DevProxy.Plugins.csproj -p:InformationalVersion=$("${{ github.ref_name }}".Substring(1)) -c Release -r ${{ matrix.architecture }} --no-self-contained
       - name: Build abstractions
         if: matrix.architecture == 'win-x64'
-        run: dotnet build ./dev-proxy-abstractions/dev-proxy-abstractions.csproj -p:InformationalVersion=$("${{ github.ref_name }}".Substring(1)) -c Release --no-self-contained
+        run: dotnet build ./DevProxy.Abstractions/DevProxy.Abstractions.csproj -p:InformationalVersion=$("${{ github.ref_name }}".Substring(1)) -c Release --no-self-contained
       - name: Add plugins to output
-        run: cp ./dev-proxy/bin/Release/net9.0/${{ matrix.architecture }}/plugins ./${{ env.release }} -r
+        run: cp ./DevProxy/bin/Release/net9.0/${{ matrix.architecture }}/plugins ./${{ env.release }} -r
       - name: Remove unnecessary files
         run: |
           pushd
@@ -84,7 +84,7 @@ jobs:
         shell: pwsh
         run: >
           ../sign code azure-key-vault
-          **/dev*proxy*
+          **/DevProxy*
           --publisher-name "${{ env.APP_PUBLISHER }}"
           --description "${{ env.APP_DESCRIPTION }}"
           --description-url "${{ env.APP_DESCRIPTION_URL }}"
@@ -112,7 +112,7 @@ jobs:
         shell: pwsh
         run: >
           ./sign code azure-key-vault
-          ./dev-proxy-abstractions/bin/Release/net9.0/dev-proxy-abstractions.dll
+          ./DevProxy.Abstractions/bin/Release/net9.0/DevProxy.Abstractions.dll
           --publisher-name "${{ env.APP_PUBLISHER }}"
           --description "${{ env.APP_DESCRIPTION }}"
           --description-url "${{ env.APP_DESCRIPTION_URL }}"
@@ -126,15 +126,15 @@ jobs:
         if: matrix.architecture == 'win-x64'
         uses: thedoctor0/zip-release@b57d897cb5d60cb78b51a507f63fa184cfe35554 # master
         with:
-          filename: '../../../../dev-proxy-abstractions-${{ github.ref_name }}.zip'
-          directory: './dev-proxy-abstractions/bin/Release/net9.0'
+          filename: '../../../../DevProxy.Abstractions-${{ github.ref_name }}.zip'
+          directory: './DevProxy.Abstractions/bin/Release/net9.0'
           exclusions: '*.json'
       - name: Upload abstractions
         if: matrix.architecture == 'win-x64'
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: binaries-dev-proxy-abstractions-${{ github.ref_name }}
-          path: ./dev-proxy-abstractions-${{ github.ref_name }}.zip
+          path: ./DevProxy.Abstractions-${{ github.ref_name }}.zip
       - name: Add installer icon
         if: contains(matrix.architecture, 'win-')
         run: |

.github/workflows/dotnet.yml

@@ -26,12 +26,12 @@ jobs:
     - name: Restore workloads
       run: dotnet workload restore
     - name: Restore dependencies
-      run: dotnet restore dev-proxy.sln --locked-mode
+      run: dotnet restore DevProxy.sln --locked-mode
     - name: Build
-      run: dotnet build dev-proxy.sln --no-restore
+      run: dotnet build DevProxy.sln --no-restore
     # We really should have tests, putting these steps here for when we have a build process
     # - name: Test
-    #   run: dotnet test dev-proxy.sln --no-build --verbosity normal --collect:"XPlat Code Coverage"
+    #   run: dotnet test DevProxy.sln --no-build --verbosity normal --collect:"XPlat Code Coverage"
     # - name: Install report generator
     #   run: dotnet tool install --global dotnet-reportgenerator-globaltool
     # - name: Generate coverage report

.vscode/launch.json

@@ -10,9 +10,9 @@
       "request": "launch",
       "preLaunchTask": "build",
       // If you have changed target frameworks, make sure to update the program path.
-      "program": "${workspaceFolder}/dev-proxy/bin/Debug/net9.0/devproxy.dll",
+      "program": "${workspaceFolder}/DevProxy/bin/Debug/net9.0/devproxy.dll",
       "args": [],
-      "cwd": "${workspaceFolder}/dev-proxy/bin/Debug/net9.0",
+      "cwd": "${workspaceFolder}/DevProxy/bin/Debug/net9.0",
       // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
       "console": "integratedTerminal",
       "stopAtEntry": false,

.vscode/tasks.json

@@ -7,7 +7,7 @@
       "type": "process",
       "args": [
         "build",
-        "${workspaceFolder}/dev-proxy.sln",
+        "${workspaceFolder}/DevProxy.sln",
         "/property:GenerateFullPaths=true",
         "/consoleloggerparameters:NoSummary"
       ],
@@ -23,7 +23,7 @@
       "type": "process",
       "args": [
         "publish",
-        "${workspaceFolder}/dev-proxy.sln",
+        "${workspaceFolder}/DevProxy.sln",
         "/property:GenerateFullPaths=true",
         "/consoleloggerparameters:NoSummary"
       ],
@@ -37,7 +37,7 @@
         "watch",
         "run",
         "--project",
-        "${workspaceFolder}/dev-proxy.sln"
+        "${workspaceFolder}/DevProxy.sln"
       ],
       "problemMatcher": "$msCompile"
     }

dev-proxy-abstractions/dev-proxy-abstractions.csproj renamed to DevProxy.Abstractions/DevProxy.Abstractions.csproj

@@ -8,6 +8,8 @@
     <Version>0.28.0</Version>
     <IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
     <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <AnalysisMode>AllEnabledByDefault</AnalysisMode>
   </PropertyGroup>
 
   <ItemGroup>

dev-proxy-abstractions/CommandLineExtensions.cs renamed to DevProxy.Abstractions/Extensions/CommandLineExtensions.cs

@@ -1,57 +1,56 @@
-// 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.CommandLine;
-using System.CommandLine.Parsing;
-
-namespace DevProxy.Abstractions;
-
-public static class CommandLineExtensions
-{
-    public static T? GetValueForOption<T>(this ParseResult parseResult, string optionName, Option[] options)
-    {
-        // we need to remove the leading - because CommandLine stores the option
-        // name without them
-        if (options
-            .FirstOrDefault(o => o.Name == optionName.TrimStart('-')) is not Option<T> option)
-        {
-            throw new InvalidOperationException($"Could not find option with name {optionName} and value type {typeof(T).Name}");
-        }
-
-        return parseResult.GetValueForOption(option);
-    }
-
-    private static string ByName<T>(T symbol) where T : Symbol => symbol.Name;
-
-    public static IEnumerable<T> OrderByName<T>(this IEnumerable<T> symbols) where T : Symbol
-    {
-        ArgumentNullException.ThrowIfNull(symbols);
-
-        return symbols.OrderBy(ByName, StringComparer.Ordinal);
-    }
-
-    public static Command AddCommands(this Command command, IEnumerable<Command> subcommands)
-    {
-        ArgumentNullException.ThrowIfNull(command);
-        ArgumentNullException.ThrowIfNull(subcommands);
-
-        foreach (var subcommand in subcommands)
-        {
-            command.AddCommand(subcommand);
-        }
-        return command;
-    }
-
-    public static Command AddOptions(this Command command, IEnumerable<Option> options)
-    {
-        ArgumentNullException.ThrowIfNull(command);
-        ArgumentNullException.ThrowIfNull(options);
-
-        foreach (var option in options)
-        {
-            command.AddOption(option);
-        }
-        return command;
-    }
-}
+// 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.
+
+#pragma warning disable IDE0130
+namespace System.CommandLine.Parsing;
+#pragma warning restore IDE0130
+
+public static class CommandLineExtensions
+{
+    public static T? GetValueForOption<T>(this ParseResult parseResult, string optionName, IReadOnlyList<Option> options)
+    {
+        ArgumentNullException.ThrowIfNull(parseResult);
+
+        // we need to remove the leading - because CommandLine stores the option
+        // name without them
+        if (options
+            .FirstOrDefault(o => o.Name == optionName.TrimStart('-')) is not Option<T> option)
+        {
+            throw new InvalidOperationException($"Could not find option with name {optionName} and value type {typeof(T).Name}");
+        }
+
+        return parseResult.GetValueForOption(option);
+    }
+
+    public static IEnumerable<T> OrderByName<T>(this IEnumerable<T> symbols) where T : Symbol
+    {
+        ArgumentNullException.ThrowIfNull(symbols);
+
+        return symbols.OrderBy(ByName, StringComparer.Ordinal);
+    }
+
+    public static void AddCommands(this Command command, IEnumerable<Command> subcommands)
+    {
+        ArgumentNullException.ThrowIfNull(command);
+        ArgumentNullException.ThrowIfNull(subcommands);
+
+        foreach (var subcommand in subcommands)
+        {
+            command.AddCommand(subcommand);
+        }
+    }
+
+    public static void AddOptions(this Command command, IEnumerable<Option> options)
+    {
+        ArgumentNullException.ThrowIfNull(command);
+        ArgumentNullException.ThrowIfNull(options);
+
+        foreach (var option in options)
+        {
+            command.AddOption(option);
+        }
+    }
+
+    private static string ByName<T>(T symbol) where T : Symbol => symbol.Name;
+}