Add support for customizable type and contract generator settings

[christianhelle]

The changes here allow customization of the NSwag type and contracts generator through the .refitter settings file. This is done by specifying the codeGeneratorSettings property, which is documented in the README files and will be included documentation site (https://refitter.github.io) after this is merged

The following OpenAPI spec:

{
  "swagger": "2.0",
  "info": {
    "title": "Dummy API",
    "version": "0.0.0"
  },
  "host": "x.io",
  "basePath": "/",
  "schemes": [
    "https"
  ],
  "paths": {
    "/dummy/{id}": {
      "get": {
        "operationId": "Get Dummy",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "the specific dummy",
            "required": true,
            "format": "int64",
            "type": "integer"
          },
          {
            "name": "valid_from",
            "in": "query",
            "description": "the start of the period",
            "required": true,
            "format": "date",
            "type": "string"
          },
          {
            "name": "valid_to",
            "in": "query",
            "description": "the end of the period",
            "required": true,
            "format": "date",
            "type": "string"
          },
          {
            "name": "test_time",
            "in": "query",
            "description": "test parameter",
            "required": true,
            "format": "time",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "No response was specified"
          }
        }
      }
    }
  }
}

used with the following .refitter settings file

{
  "contractsGeneratorSettings": {
    "dateType": "System.DateTime",
    "dateTimeType": "System.DateTime"
  }
}

will generated an interface like this:

[System.CodeDom.Compiler.GeneratedCode("Refitter", "1.0.0.0")]
public partial interface IDummyAPI
{
    [Get("/t/dummy/{employee_id}")]
    Task GetDummy(
        long employee_id, 
        [Query] System.DateTime valid_from, 
        [Query] System.DateTime valid_to, 
        [Query] System.TimeSpan test_time);
}

This implements #186 suggested by @bielik01

codeGeneratorSettings exposes the following properties with the following default values:

"codeGeneratorSettings": {
    "namespace": "GeneratedCode",
    "requiredPropertiesMustBeDefined": true,
    "generateDataAnnotations": true,
    "anyType": "object",
    "dateType": "System.DateTimeOffset",
    "dateTimeType": "System.DateTimeOffset",
    "timeType": "System.TimeSpan",
    "timeSpanType": "System.TimeSpan",
    "arrayType": "System.Collections.Generic.ICollection",
    "dictionaryType": "System.Collections.Generic.IDictionary",
    "arrayInstanceType": "System.Collections.ObjectModel.Collection",
    "dictionaryInstanceType": "System.Collections.Generic.Dictionary",
    "arrayBaseType": "System.Collections.ObjectModel.Collection",
    "dictionaryBaseType": "System.Collections.Generic.Dictionary",
    "propertySetterAccessModifier": "",
    "generateImmutableArrayProperties": false,
    "generateImmutableDictionaryProperties": false,
    "handleReferences": false,
    "jsonSerializerSettingsTransformationMethod": null,
    "generateJsonMethods": false,
    "enforceFlagEnums": false,
    "inlineNamedDictionaries": false,
    "inlineNamedTuples": true,
    "inlineNamedArrays": false,
    "generateOptionalPropertiesAsNullable": false,
    "generateNullableReferenceTypes": false,
    "generateNativeRecords": false,
    "generateDefaultValues": true,
    "inlineNamedAny": false,
    "excludedTypeNames": [ ]
  }

[christianhelle]

Does this work for you @bielik01 ?

[codecov]

Codecov Report

Merging #188 (a4f5799) into main (6960270) will increase coverage by 0.15%.
Report is 9 commits behind head on main.
The diff coverage is 100.00%.

❗ Current head a4f5799 differs from pull request most recent head e2c24b8. Consider uploading reports for the commit e2c24b8 to get more accurate results

@@            Coverage Diff             @@
##             main     #188      +/-   ##
==========================================
+ Coverage   98.48%   98.64%   +0.15%     
==========================================
  Files          47       52       +5     
  Lines        1651     1841     +190     
==========================================
+ Hits         1626     1816     +190     
  Misses          9        9              
  Partials       16       16              

Flag	Coverage Δ
unittests	98.64% <100.00%> (+0.15%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
src/Refitter.Core/CSharpClientGeneratorFactory.cs	100.00% <100.00%> (ø)
src/Refitter.Core/Serializer.cs	100.00% <100.00%> (ø)
...rc/Refitter.Core/Settings/CodeGeneratorSettings.cs	100.00% <100.00%> (ø)
...itter.Core/Settings/DependencyInjectionSettings.cs	100.00% <100.00%> (ø)
...fitter.Tests/CustomCSharpGeneratorSettingsTests.cs	100.00% <100.00%> (ø)
...s/Examples/CustomCodeGeneratorWithDateTimeTests.cs	100.00% <100.00%> (ø)
src/Refitter.Tests/SerializerTests.cs	100.00% <100.00%> (ø)

[bielik01]

that's more like it, thanks!

[bielik01]

although you could also add CodeGeneratorSettingsBase properties, because I'll need ExcludedTypeNames as well

[christianhelle]

although you could also add CodeGeneratorSettingsBase properties, because I'll need ExcludedTypeNames as well

Sure

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

[bielik01]

perfect ❤