Add support for customizing the default Integer format

[christianhelle]

This implements #167

With the changes here, using the --integer-type Int64 on the following OpenAPI spec:

{
  "openapi": "3.0.1",
  "info": {
    "title": "Test API",
    "version": "1.0.0"
  },
  "paths": {
    "/test": {
      "get": {
        "operationId": "TestEndpoint",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TestModel"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "TestModel": {
        "type": "object",
        "properties": {
          "integerWithoutFormat": {
            "type": "integer",
            "description": "Integer without format - should default to int but optionally be long"
          },
          "integerWithInt32Format": {
            "type": "integer",
            "format": "int32"
          },
          "integerWithInt64Format": {
            "type": "integer",
            "format": "int64"
          }
        }
      }
    }
  }
}

will generated the following type:

public partial class TestModel
{
    /// <summary>
    /// Integer without format - should default to int but optionally be long
    /// </summary>
    [JsonPropertyName("integerWithoutFormat")]
    public long IntegerWithoutFormat { get; set; }

    [JsonPropertyName("integerWithInt32Format")]
    public int IntegerWithInt32Format { get; set; }

    [JsonPropertyName("integerWithInt64Format")]
    public long IntegerWithInt64Format { get; set; }

    private IDictionary<string, object> _additionalProperties;

    [JsonExtensionData]
    public IDictionary<string, object> AdditionalProperties
    {
        get { return _additionalProperties ?? (_additionalProperties = new Dictionary<string, object>()); }
        set { _additionalProperties = value; }
    }
}

Summary by CodeRabbit

• New Features

  • Added --integer-type CLI option and integerType config (default Int32; choices: Int32, Int64) to control .NET type used for OpenAPI integers without a format.

• Documentation

  • Updated CLI help, README, config schema and examples to document the new option and setting.

• Tests

  • Added tests validating generated code and buildability for both Int32 and Int64 integer handling.

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Adds a new IntegerType enum (Int32/Int64), exposes it via a --integer-type CLI flag and .refitter config property, documents and updates the JSON schema, implements schema transformations in the C# generator to honor the setting, and adds tests validating generated integer types and buildability.

Changes

Cohort / File(s)	Summary
Documentation & Schema README.md, docs/docfx_project/articles/cli-tool.md, docs/docfx_project/articles/refitter-file-format.md, docs/json-schema.json, src/Refitter.MSBuild/README.md, src/Refitter.SourceGenerator/README.md, src/Refitter/README.md, .github/copilot-instructions.md	Add docs, examples, and JSON schema entries for the new integerType/IntegerType setting and the --integer-type CLI flag; document defaults (Int32/int) and allowed values (Int32/Int64 or int/long).
Configuration & CLI wiring src/Refitter.Core/Settings/CodeGeneratorSettings.cs, src/Refitter/Settings.cs, src/Refitter/GenerateCommand.cs	Add a strongly-typed IntegerType property (default Int32), bind it to the CLI option --integer-type, and propagate the setting into generator initialization.
Core implementation src/Refitter.Core/CSharpClientGeneratorFactory.cs, src/Refitter.Core/IntegerType.cs	Add IntegerType enum and generator-side logic (ApplyCustomIntegerType, ProcessSchemasForIntegerType, ProcessSchemaForIntegerType) to traverse and modify JsonSchema nodes so OpenAPI integer types without a format map to the configured .NET integer type.
Tests src/Refitter.Tests/Examples/IntegerFormatTests.cs	New test suite validating default and configured integer mapping, explicit int32/int64 handling, presence of expected int/long in generated code, and that generated code builds for both configurations.

Sequence Diagram(s)

sequenceDiagram
    participant User as CLI User
    participant Loader as Settings Loader
    participant Factory as CSharpClientGeneratorFactory
    participant Schema as OpenAPI JsonSchema

    User->>Loader: parse --integer-type (e.g. Int64)
    Loader->>Factory: CreateGenerator(settings.IntegerType)

    alt IntegerType != Int32
        rect rgb(230,245,230)
        Note over Factory,Schema: Apply custom integer-type transformation
        Factory->>Schema: Traverse schemas (properties, items, additionalProperties)
        Schema-->>Factory: Identify integer schemas with no format
        Factory->>Schema: Set format to int64 (map to Int64)
        end
    else IntegerType == Int32
        Factory->>Factory: No transformation — use default mapping
    end

    Factory-->>User: Emit generated C# code using selected integer mapping

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Suggested labels

.NET

Poem

🐇 I hopped through schemas, soft and keen,
I taught the ints to pick a scene.
Tiny Int32 or stalwart Int64,
I nudged the generator, then danced some more.
Happy builds and carrots galore!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "Add support for customizing the default Integer format" directly addresses the primary objective of the changeset: enabling users to customize how OpenAPI integer types without explicit format specifications map to C# integer types. The title is concise, specific, and avoids vague terms or noise. A teammate scanning the pull request history would immediately understand that this introduces a new customization capability for integer type mapping, which aligns with the core feature being implemented (the new --integer-type CLI flag and integerType configuration property).

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch integer-format

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull Request Overview

This PR adds support for customizing the .NET type used for OpenAPI integer types that don't have a format specifier, implementing feature request #167. By default, integers without a format are mapped to int, but users can now configure them to use long instead.

Key Changes:

• Added new IntegerType configuration option to CLI, settings files, and code generator
• Implemented schema processing logic to apply custom integer type formatting
• Added comprehensive test coverage for the new feature

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/Refitter/Settings.cs	Added CLI command option for integer type configuration
src/Refitter/GenerateCommand.cs	Wired up integer type setting to code generator
src/Refitter.Core/Settings/CodeGeneratorSettings.cs	Added IntegerType property with default value
src/Refitter.Core/CSharpClientGeneratorFactory.cs	Implemented schema processing logic to apply custom integer type
src/Refitter.Tests/Examples/IntegerFormatTests.cs	Added test coverage for integer type customization
src/Refitter/README.md	Updated CLI documentation with new option
src/Refitter.SourceGenerator/README.md	Updated source generator documentation
src/Refitter.MSBuild/README.md	Updated MSBuild task documentation
docs/json-schema.json	Added integerType to JSON schema
docs/docfx_project/articles/refitter-file-format.md	Updated file format documentation
docs/docfx_project/articles/cli-tool.md	Updated CLI tool documentation
README.md	Updated main README with new option

[codecov]

Codecov Report

❌ Patch coverage is 90.47619% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.32%. Comparing base (8439b69) to head (2b3eac5).
⚠️ Report is 27 commits behind head on main.

Files with missing lines	Patch %	Lines
src/Refitter.Core/CSharpClientGeneratorFactory.cs	90.24%	1 Missing and 3 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #792      +/-   ##
==========================================
- Coverage   92.36%   92.32%   -0.05%     
==========================================
  Files          24       24              
  Lines        1795     1837      +42     
  Branches      276      295      +19     
==========================================
+ Hits         1658     1696      +38     
- Misses        101      102       +1     
- Partials       36       39       +3     

Flag	Coverage Δ
unittests	92.32% <90.47%> (-0.05%)	⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cbcdbd8 and 5feb7c1.

📒 Files selected for processing (1)

• src/Refitter.Tests/Examples/IntegerFormatTests.cs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

src/**/*.cs

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

src/**/*.cs: Follow existing C# coding conventions defined in .editorconfig
Use PascalCase for public members
Use camelCase for parameters and local variables
Include XML documentation for public APIs
Use meaningful variable and method names

Files:

• src/Refitter.Tests/Examples/IntegerFormatTests.cs

src/Refitter.Tests/Examples/**/*.cs

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

All new code must include unit tests following the Refitter.Tests.Examples pattern

Files:

• src/Refitter.Tests/Examples/IntegerFormatTests.cs

🧠 Learnings (1)

📚 Learning: 2025-09-17T20:15:55.708Z

Learnt from: CR
PR: christianhelle/refitter#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-09-17T20:15:55.708Z
Learning: Applies to src/Refitter.Tests/Examples/**/*.cs : All new code must include unit tests following the Refitter.Tests.Examples pattern

Applied to files:

• src/Refitter.Tests/Examples/IntegerFormatTests.cs

🧬 Code graph analysis (1)

src/Refitter.Tests/Examples/IntegerFormatTests.cs (3)

src/Refitter/GenerateCommand.cs (5)

• Task (27-269)
• Task (319-379)
• Task (395-539)
• Task (662-769)
• RefitGeneratorSettings (271-318)

src/Refitter.Tests/Build/BuildHelper.cs (2)

• BuildHelper (6-53)
• BuildCSharp (8-45)

src/Refitter.Tests/TestUtilities/SwaggerFileHelper.cs (1)

• SwaggerFileHelper (9-25)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: 👌 Verify build
• GitHub Check: script
• GitHub Check: 👌 Verify build

🔇 Additional comments (3)

src/Refitter.Tests/Examples/IntegerFormatTests.cs (3)

1-10: LGTM!

The imports and namespace declaration are appropriate for a test class in the Refitter.Tests.Examples pattern.

---

116-162: Excellent test coverage!

The test suite comprehensively validates the integer format feature:

• Default and custom IntegerType settings
• Explicit format preservation (int32, int64)
• Build verification for both configurations

Test names are clear and follow good conventions.

---

164-192: LGTM!

The helper methods are well-structured and follow consistent patterns:

• Clear separation between default and custom configurations
• Proper use of SwaggerFileHelper and RefitGenerator
• Meaningful variable names following camelCase convention

[sonarqubecloud]

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (1)

src/Refitter.Tests/Examples/IntegerFormatTests.cs (1)

11-190: Past JSON syntax issue has been resolved.

The missing comma between RequestModel and ResponseModel (previously flagged around lines 93-94, now line 122) has been corrected. The JSON structure is now valid.

🧹 Nitpick comments (1)

src/Refitter.Tests/Examples/IntegerFormatTests.cs (1)

240-268: Consider reducing duplication between helper methods.

The two helper methods share significant logic, differing only in the CodeGeneratorSettings configuration. You could extract a common method that accepts an optional IntegerType parameter.

Example refactor:

-    private static async Task<string> GenerateCode()
+    private static async Task<string> GenerateCode(IntegerType? integerType = null)
     {
         var swaggerFile = await SwaggerFileHelper.CreateSwaggerFile(OpenApiSpec);
         var settings = new RefitGeneratorSettings
         {
             OpenApiPath = swaggerFile,
+            CodeGeneratorSettings = integerType.HasValue 
+                ? new CodeGeneratorSettings { IntegerType = integerType.Value }
+                : null
         };
 
         var sut = await RefitGenerator.CreateAsync(settings);
         var generatedCode = sut.Generate();
         return generatedCode;
     }
 
     private static async Task<string> GenerateCodeWithLongIntegers()
     {
-        var swaggerFile = await SwaggerFileHelper.CreateSwaggerFile(OpenApiSpec);
-        var settings = new RefitGeneratorSettings
-        {
-            OpenApiPath = swaggerFile,
-            CodeGeneratorSettings = new CodeGeneratorSettings
-            {
-                IntegerType = IntegerType.Int64
-            }
-        };
-
-        var sut = await RefitGenerator.CreateAsync(settings);
-        var generatedCode = sut.Generate();
-        return generatedCode;
+        return await GenerateCode(IntegerType.Int64);
     }

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5feb7c1 and 2b3eac5.

📒 Files selected for processing (1)

• src/Refitter.Tests/Examples/IntegerFormatTests.cs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

src/**/*.cs

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

src/**/*.cs: Follow existing C# coding conventions defined in .editorconfig
Use PascalCase for public members
Use camelCase for parameters and local variables
Include XML documentation for public APIs
Use meaningful variable and method names

Files:

• src/Refitter.Tests/Examples/IntegerFormatTests.cs

src/Refitter.Tests/Examples/**/*.cs

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

All new code must include unit tests following the Refitter.Tests.Examples pattern

Files:

• src/Refitter.Tests/Examples/IntegerFormatTests.cs

🧠 Learnings (1)

📚 Learning: 2025-09-17T20:15:55.708Z

Learnt from: CR
PR: christianhelle/refitter#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-09-17T20:15:55.708Z
Learning: Applies to src/Refitter.Tests/Examples/**/*.cs : All new code must include unit tests following the Refitter.Tests.Examples pattern

Applied to files:

• src/Refitter.Tests/Examples/IntegerFormatTests.cs

🧬 Code graph analysis (1)

src/Refitter.Tests/Examples/IntegerFormatTests.cs (4)

src/Refitter/GenerateCommand.cs (5)

• Task (27-269)
• Task (319-379)
• Task (395-539)
• Task (662-769)
• RefitGeneratorSettings (271-318)

src/Refitter.Tests/Build/BuildHelper.cs (2)

• BuildHelper (6-53)
• BuildCSharp (8-45)

src/Refitter.Tests/TestUtilities/SwaggerFileHelper.cs (1)

• SwaggerFileHelper (9-25)

src/Refitter.Core/RefitGenerator.cs (1)

• RefitGenerator (10-300)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: script
• GitHub Check: 👌 Verify build
• GitHub Check: 👌 Verify build
• GitHub Check: 👌 Verify build
• GitHub Check: Analyze (csharp)

🔇 Additional comments (1)

src/Refitter.Tests/Examples/IntegerFormatTests.cs (1)

192-238: Comprehensive test coverage for integer format customization.

The test suite effectively validates the core scenarios:

• Default int mapping for unformatted integers
• Configurable long mapping via IntegerType.Int64
• Explicit format preservation (int32 → int, int64 → long)
• Build verification for both configurations

The string-based assertions are adequate for code generation tests and are backed by build tests that catch compilation issues.