Update --operation-name-template implementation to replace all {operationName} instances with Execute

[christianhelle]

This fixes #757

This pull request clarifies and improves the behavior and documentation for the operationNameTemplate setting when generating multiple interfaces by endpoint. It ensures that when using ByEndpoint, all instances of {operationName} in the template are replaced with Execute. The changes update documentation, code comments, schema descriptions, and the generator logic itself. Additionally, new tests have been added to verify the correct naming and code generation behavior.

Improvements to operationNameTemplate handling and documentation:

• Updated the logic in RefitMultipleInterfaceGenerator.cs to replace all instances of {operationName} with Execute when generating method names for ByEndpoint interfaces.
• Clarified the description and usage of operationNameTemplate in documentation files (README.md, cli-tool.md, .refitter examples, and json-schema.json) to explain that, for ByEndpoint, {operationName} is replaced with Execute in the generated interface method names. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

Code and test enhancements:

• Added new test class MultipleInterfacesByEndpointWithOperationNameTests to verify that interfaces and method names are generated as expected when using the operationNameTemplate with ByEndpoint, including checks for dynamic query string parameters and code buildability.
• Improved XML comments and enum descriptions in MultipleInterfaces.cs to match the clarified operationNameTemplate behavior.

Workflow configuration update:

• Adjusted the smoke-tests.yml GitHub Actions workflow to only run on pushes to the main branch, aligning with best practices for CI configuration. [1] [2]

Minor test file formatting:

• Minor formatting fix in OpenApiUrlTests.cs for consistent code structure.

Summary by CodeRabbit

• New Features

  • Method-name resolution now falls back to "Execute" when an operation-name template is empty or whitespace.

• Documentation

  • Clarified across READMEs, CLI help, schema, and docs that {operationName} is replaced with "Execute" when using ByEndpoint.

• Tests

  • Added tests to validate ByEndpoint generation, operation-name mapping, dynamic querystring behavior, and buildability.

• Chores

  • Updated CI triggers for push and pull_request events.

[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

Clarified OperationNameTemplate behavior in docs and schema; generator now treats non-empty templates by replacing "{operationName}" with "Execute" for ByEndpoint multiple-interfaces and falls back to "Execute" for empty/whitespace templates; added tests for ByEndpoint generation and dynamic querystrings; adjusted CI triggers.

Changes

Cohort / File(s)	Summary
CI workflow triggers \.github/workflows/smoke-tests.yml	Removed branch filter for push event; restricted pull_request trigger to the main branch.
Generator naming logic src/Refitter.Core/RefitMultipleInterfaceGenerator.cs	Method-name resolution tightened: whitespace-only OperationNameTemplate treated as empty; when non-empty, "{operationName}" is replaced with "Execute" for method names; otherwise falls back to "Execute".
Settings & attributes src/Refitter.Core/Settings/MultipleInterfaces.cs, src/Refitter/Settings.cs	Updated documentation/Description attributes to state that when ByEndpoint is used all occurrences of '{operationName}' are replaced with 'Execute' in generated interface method names.
Tests src/Refitter.Tests/Examples/MultipleInterfacesByEndpointWithOperationNameTests.cs, src/Refitter.Tests/Examples/OpenApiUrlTests.cs	Added new tests validating multiple-interfaces-by-endpoint generation, operation-name template replacement, dynamic querystring parameter behavior, and buildability; moved an #endif in OpenApiUrlTests.
Documentation & schema README.md, docs/docfx_project/articles/*, docs/json-schema.json, src/Refitter.MSBuild/README.md, src/Refitter.SourceGenerator/README.md, src/Refitter/README.md	Text updates: require {operationName} in templates and explicitly document that for ByEndpoint all occurrences of {operationName} are replaced with 'Execute'; wording/typo fixes and examples adjusted accordingly.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant U as User Config
  participant G as Refit Generator
  participant N as Naming Logic
  participant O as Generated Code

  U->>G: Provide settings (multipleInterfaces=ByEndpoint, operationNameTemplate)
  G->>N: Request method name resolution
  alt non-empty, non-whitespace template
    N->>N: Replace "{operationName}" with "Execute"
    N-->>G: Return derived name (template with Execute)
  else empty or whitespace template
    N-->>G: Return "Execute"
  end
  G->>O: Emit interfaces and methods using resolved names
  note right of O: Methods generated as Execute / ExecuteAsync per endpoint

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

I thump the keys with twitchy delight,
{operationName} hops and lands on Execute tonight.
Interfaces sprout, tests nibble green,
CI trims branches, tidy and clean.
A carrot build — a rabbit's small triumph 🥕🐇

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 title concisely and accurately describes the primary change: modifying the --operation-name-template implementation so that all {operationName} occurrences are replaced with Execute; this matches the PR objectives, code changes, docs, and tests. It is specific, actionable, and clear for a reviewer scanning the repository history.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-multiple-interfaces-by-endpoint

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 19abb4a and 2b595fd.

📒 Files selected for processing (1)

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

🚧 Files skipped from review as they are similar to previous changes (1)

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

⏰ 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: 👌 Verify build
• GitHub Check: script

---

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 pull request implements issue #757 by clarifying and updating the operationNameTemplate setting behavior when using ByEndpoint multiple interface generation. The main purpose is to ensure that all instances of {operationName} in the template are replaced with "Execute" when generating method names for ByEndpoint interfaces.

• Updates documentation across multiple files to clarify that {operationName} is replaced with "Execute" for ByEndpoint interfaces
• Modifies the core generator logic to properly replace all template instances
• Adds comprehensive test coverage for the new behavior

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/Refitter/Settings.cs	Updates CLI option description to clarify template replacement behavior
src/Refitter/README.md	Updates documentation comments explaining the template behavior
src/Refitter.Tests/Examples/OpenApiUrlTests.cs	Minor formatting fix moving #endif directive
src/Refitter.Tests/Examples/MultipleInterfacesByEndpointWithOperationNameTests.cs	New comprehensive test class for verifying template behavior
src/Refitter.SourceGenerator/README.md	Updates documentation for source generator usage
src/Refitter.MSBuild/README.md	Updates MSBuild task documentation
src/Refitter.Core/Settings/MultipleInterfaces.cs	Updates XML comments and enum descriptions
src/Refitter.Core/RefitMultipleInterfaceGenerator.cs	Core implementation change to replace template placeholders
docs/json-schema.json	Updates JSON schema description
docs/docfx_project/articles/refitter-file-format.md	Updates documentation format file
docs/docfx_project/articles/cli-tool.md	Updates CLI tool documentation
README.md	Updates main project documentation
.github/workflows/smoke-tests.yml	Adjusts workflow trigger to only run on main branch pushes

[christianhelle]

@all-contributors please add @marcohern for ideas

[allcontributors]

@christianhelle

I've put up a pull request to add @marcohern! 🎉

[coderabbitai]

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

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

64-80: Bug: Interface is closed before writing optional-parameter overload — produces invalid code

code.AppendLine($"{Separator}}}"); closes the interface before the overload is emitted, so the second method lands outside the interface.

Apply this fix to close the interface after the optional overload block:

-                code.AppendLine($"{Separator}{Separator}[{verb}(\"{kv.Key}\")]")
-                    .AppendLine($"{Separator}{Separator}{returnType} {methodName}({parametersString});")
-                    .AppendLine($"{Separator}}}");
+                code.AppendLine($"{Separator}{Separator}[{verb}(\"{kv.Key}\")]")
+                    .AppendLine($"{Separator}{Separator}{returnType} {methodName}({parametersString});")
+                    .AppendLine();
@@
-                if (parametersString.Contains("?") && settings is { OptionalParameters: true, ApizrSettings: not null })
+                if (parametersString.Contains("?") && settings is { OptionalParameters: true, ApizrSettings: not null })
                 {
                     this.docGenerator.AppendMethodDocumentation(operationModel, IsApiResponseType(returnType), false, hasApizrRequestOptionsParameter, code);
                     GenerateObsoleteAttribute(operation, code);
                     GenerateForMultipartFormData(operationModel, code);
                     GenerateHeaders(operations, operation, operationModel, code);
 
                     parametersString = string.Join(", ", parameters.Where(parameter => !parameter.Contains("?")));
 
                     code.AppendLine($"{Separator}{Separator}[{verb}(\"{kv.Key}\")]")
                         .AppendLine($"{Separator}{Separator}{returnType} {methodName}({parametersString});")
-                        .AppendLine();
+                        .AppendLine();
                 }
+                code.AppendLine($"{Separator}}}");

🧹 Nitpick comments (20)

README.md (1)

101-101: Clarify and fix grammar for operation-name-template text

Current phrasing has agreement issues (“is replaced”) and can be tighter/consistent across docs.

Apply this diff to all three spots:

-        --operation-name-template                                Generate operation names using pattern. When using --multiple-interfaces ByEndpoint, this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+        --operation-name-template                                Generate operation names using a pattern. When using --multiple-interfaces ByEndpoint, this becomes the name of the Execute() method in the interface; all occurrences of '{operationName}' are replaced with 'Execute'.

-  "operationNameTemplate": "{operationName}Async", // Optional. Must contain {operationName}. When multipleInterfaces == "ByEndpoint", this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+  "operationNameTemplate": "{operationName}Async", // Optional. Must contain {operationName}. When multipleInterfaces == "ByEndpoint", this becomes the name of the Execute() method in the interface; all occurrences of '{operationName}' are replaced with 'Execute'.

-- `operationNameTemplate` - Generate operation names using pattern. This must contain the string {operationName}. An example usage of this could be `{operationName}Async` to suffix all method names with Async. When using multiple interfaces with `ByEndpoint`, this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+- `operationNameTemplate` - Generate operation names using a pattern. This must contain the string `{operationName}`. Example: `{operationName}Async`. When using multiple interfaces with `ByEndpoint`, this becomes the name of the Execute() method in the interface; all occurrences of `{operationName}` are replaced with `Execute`.

Also applies to: 226-226, 340-340

src/Refitter.MSBuild/README.md (1)

54-54: Keep wording consistent with README

Mirror the clarified phrasing and fix subject–verb agreement.

Apply:

-  "operationNameTemplate": "{operationName}Async", // Optional. Must contain {operationName}. When multipleInterfaces == "ByEndpoint", this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+  "operationNameTemplate": "{operationName}Async", // Optional. Must contain {operationName}. When multipleInterfaces == "ByEndpoint", this becomes the name of the Execute() method in the interface; all occurrences of '{operationName}' are replaced with 'Execute'.

-- `operationNameTemplate` - Generate operation names using pattern. This must contain the string {operationName}. An example usage of this could be `{operationName}Async` to suffix all method names with Async. When using multiple interfaces with `ByEndpoint`, this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+- `operationNameTemplate` - Generate operation names using a pattern. This must contain the string `{operationName}`. Example: `{operationName}Async`. When using multiple interfaces with `ByEndpoint`, this becomes the name of the Execute() method in the interface; all occurrences of `{operationName}` are replaced with `Execute`.

Also applies to: 151-151

docs/docfx_project/articles/cli-tool.md (1)

80-80: Polish help text wording

Align with main README phrasing and fix agreement.

-        --operation-name-template                                Generate operation names using pattern. When using --multiple-interfaces ByEndpoint, this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+        --operation-name-template                                Generate operation names using a pattern. When using --multiple-interfaces ByEndpoint, this becomes the name of the Execute() method in the interface; all occurrences of '{operationName}' are replaced with 'Execute'.

src/Refitter/Settings.cs (1)

146-149: Fix grammar and consider guarding empty templates at parse-time

• Text nit: agreement and clarity.
• Optional: add validation to reject empty/whitespace templates to avoid generating invalid method identifiers.

-    [Description("Generate operation names using pattern. When using --multiple-interfaces ByEndpoint, this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'.")]
+    [Description("Generate operation names using a pattern. When using --multiple-interfaces ByEndpoint, this becomes the name of the Execute() method in the interface; all occurrences of '{operationName}' are replaced with 'Execute'.")]

If you want, I can propose a Validate() override to enforce non-empty templates and presence of {operationName}.

src/Refitter.Core/Settings/MultipleInterfaces.cs (1)

19-25: Docstring grammar and consistency

Tighten wording; match README phrasing.

-    /// The method name can be customized using <see cref="RefitGeneratorSettings.OperationNameTemplate"/>, where this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'.
+    /// The method name can be customized using <see cref="RefitGeneratorSettings.OperationNameTemplate"/>. In ByEndpoint mode, this becomes the name of the Execute() method; all occurrences of '{operationName}' are replaced with 'Execute'.

-            The method name can be customized using OperationNameTemplate, where this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'.
+            The method name can be customized using OperationNameTemplate. In ByEndpoint mode, this becomes the name of the Execute() method; all occurrences of '{operationName}' are replaced with 'Execute'.

src/Refitter.Core/RefitMultipleInterfaceGenerator.cs (2)

47-47: Avoid removing all ‘I’ characters; only strip a leading interface ‘I’ and the ‘Endpoint’ suffix

The current double Replace can mangle names containing ‘I’. Derive the base name more safely.

-                var dynamicQuerystringParameterType = interfaceName.Replace("I", string.Empty).Replace("Endpoint", "QueryParams");
+                var baseName = interfaceName.StartsWith("I", StringComparison.Ordinal) && interfaceName.Length > 1 && char.IsUpper(interfaceName[1])
+                    ? interfaceName.Substring(1)
+                    : interfaceName;
+                var dynamicQuerystringParameterType = baseName.EndsWith("Endpoint", StringComparison.Ordinal)
+                    ? baseName.Substring(0, baseName.Length - "Endpoint".Length) + "QueryParams"
+                    : baseName + "QueryParams";

---

32-35: Template replacement scope — confirm tests cover multiple placeholders

You’re replacing all instances of {operationName} (good). Ensure tests cover templates like "Do{operationName}{operationName}Async" to verify global replacement.

Would you like me to add a test case to MultipleInterfacesByEndpointWithOperationNameTests for multiple placeholders?

docs/json-schema.json (1)

387-389: Tighten wording and enforce placeholder via JSON Schema pattern

• Grammar: “is replaced” → “are replaced”.
• Add a schema pattern to require the {operationName} placeholder (docs say “must contain”).

 "operationNameTemplate": {
-  "description": "Generate operation names using pattern. When using multiple interfaces ByEndpoint,\r\nthis is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'.",
-  "type": "string"
+  "description": "Generate operation names using a pattern. When using multiple interfaces 'ByEndpoint', this is the name of the Execute() method in the interface; all occurrences of '{operationName}' in the template are replaced with 'Execute' (e.g., '{operationName}Async' -> 'ExecuteAsync').",
+  "type": "string",
+  "pattern": ".*\\{operationName\\}.*"
 },

src/Refitter.SourceGenerator/README.md (2)

51-51: Clarify replacement rule; fix grammar

Make the rule explicit and add an example.

-  "operationNameTemplate": "{operationName}Async", // Optional. Must contain {operationName}. When multipleInterfaces == "ByEndpoint", this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+  "operationNameTemplate": "{operationName}Async", // Optional. Must contain {operationName}. When multipleInterfaces == "ByEndpoint", this is the name of the Execute() method in the interface; all occurrences of '{operationName}' are replaced with 'Execute' (e.g., '{operationName}Async' -> 'ExecuteAsync')

---

150-150: Mirror the same clarification in Descriptions section

Keep docs consistent and add example.

-- `operationNameTemplate` - Generate operation names using pattern. This must contain the string {operationName}. An example usage of this could be `{operationName}Async` to suffix all method names with Async. When using multiple interfaces with `ByEndpoint`, this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+- `operationNameTemplate` - Generate operation names using a pattern. Must contain `{operationName}`. Example: `{operationName}Async` → `ExecuteAsync` when `multipleInterfaces` is `ByEndpoint`, because all `{operationName}` occurrences are replaced with `Execute`.

docs/docfx_project/articles/refitter-file-format.md (2)

32-32: Use valid OAS phrasing and clearer example for template behavior

Small grammar fix + example.

-  "operationNameTemplate": "{operationName}Async", // Optional. Must contain {operationName}. When multipleInterfaces == "ByEndpoint", this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+  "operationNameTemplate": "{operationName}Async", // Optional. Must contain {operationName}. When multipleInterfaces == "ByEndpoint", this is the name of the Execute() method in the interface; all '{operationName}' occurrences are replaced with 'Execute' (e.g., '{operationName}Async' -> 'ExecuteAsync')

---

153-153: Duplicate clarification: align with above wording

Keep consistent phrasing across sections.

-- `operationNameTemplate` - Generate operation names using pattern. This must contain the string {operationName}. An example usage of this could be `{operationName}Async` to suffix all method names with Async. When using multiple interfaces with `ByEndpoint`, this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+- `operationNameTemplate` - Generate operation names using a pattern. Must contain `{operationName}`. Example: `{operationName}Async` becomes `ExecuteAsync` when `multipleInterfaces` is `ByEndpoint` (all `{operationName}` occurrences are replaced with `Execute`).

src/Refitter/README.md (2)

150-150: Polish wording and add example

Improve clarity; same rule as other docs.

-  "operationNameTemplate": "{operationName}Async", // Optional. Must contain {operationName}. When multipleInterfaces == "ByEndpoint", this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+  "operationNameTemplate": "{operationName}Async", // Optional. Must contain {operationName}. When multipleInterfaces == "ByEndpoint", this is the name of the Execute() method in the interface; all '{operationName}' occurrences are replaced with 'Execute' (e.g., '{operationName}Async' -> 'ExecuteAsync')

---

82-83: CLI help text: mirror the same clarification

Keep CLI help consistent with docs; add the “must contain” note.

-        --operation-name-template                                Generate operation names using pattern. When using --multiple-interfaces ByEndpoint, this is name of the Execute() method in the interface where all instances of the string '{operationName}' is replaced with 'Execute'
+        --operation-name-template                                Generate operation names using a pattern. Must contain '{operationName}'. With --multiple-interfaces ByEndpoint, all '{operationName}' occurrences are replaced with 'Execute' (e.g., '{operationName}Async' -> 'ExecuteAsync').

src/Refitter.Tests/Examples/MultipleInterfacesByEndpointWithOperationNameTests.cs (6)

11-105: Make the OpenAPI sample valid OAS and encode required/optional correctly

• optional: true is not an OpenAPI 3.0 keyword.
• If contact should be required, set required: true.
• Prefer standard required: false (or simply omit required) for optional params.

-        - in: 'query'
-          name: 'Description'
-          description: 'Job description'
-          optional: true
+        - in: 'query'
+          name: 'Description'
+          description: 'Job description'
+          required: false
           schema:
             type: 'string'
-        - in: 'query'
-          name: 'Contact'
-          description: 'Contact Person'
+        - in: 'query'
+          name: 'Contact'
+          description: 'Contact Person'
+          required: true
           schema:
             type: 'string'
@@
-        - in: 'query'
-          name: 'Description'
-          description: 'Bar description'
-          optional: true
+        - in: 'query'
+          name: 'Description'
+          description: 'Bar description'
+          required: false
           schema:
             type: 'string'
-        - in: 'query'
-          name: 'Contact'
-          description: 'Contact Person'
+        - in: 'query'
+          name: 'Contact'
+          description: 'Contact Person'
+          required: true
           schema:
             type: 'string'

---

115-133: Rename test methods to match asserted identifiers

Avoid confusion: pluralize test names.

-    public async Task Generates_IGetAllFooEndpoint()
+    public async Task Generates_IGetAllFoosEndpoint()
@@
-    public async Task Generates_IGetAllBarEndpoint()
+    public async Task Generates_IGetAllBarsEndpoint()

---

143-149: Broaden dynamic querystring assertions

Also assert that “details” endpoints use the wrapped params while list endpoints don’t include any QueryParams type beyond the expected ones.

Consider adding:

         generatedCode.Should().Contain("GetFooDetailsQueryParams");
         generatedCode.Should().NotContain("GetAllFoosQueryParams");
         generatedCode.Should().Contain("GetBarDetailsQueryParams");
+        generatedCode.Should().NotContain("GetAllBarsQueryParams");

---

152-159: Add a test for “replace all occurrences”

Current test covers a single occurrence. Add a case like X_{operationName}_Y_{operationName}_Async → X_Execute_Y_Execute_Async.

+    [Fact]
+    public async Task Methods_Name_Replaces_All_Placeholders()
+    {
+        var swaggerFile = await SwaggerFileHelper.CreateSwaggerFile(OpenApiSpec);
+        var settings = new RefitGeneratorSettings
+        {
+            OpenApiPath = swaggerFile,
+            MultipleInterfaces = MultipleInterfaces.ByEndpoint,
+            OperationNameTemplate = "X_{operationName}_Y_{operationName}_Async"
+        };
+        var sut = await RefitGenerator.CreateAsync(settings);
+        var generated = sut.Generate();
+        generated.Should().Contain("X_Execute_Y_Execute_Async(");
+    }

---

171-186: Clean up temp artifacts in tests

Delete the temp folder created for the Swagger file to avoid cluttering %TMP%.

-        var swaggerFile = await SwaggerFileHelper.CreateSwaggerFile(OpenApiSpec);
+        var swaggerFile = await SwaggerFileHelper.CreateSwaggerFile(OpenApiSpec);
+        try
+        {
             var settings = new RefitGeneratorSettings
             {
                 OpenApiPath = swaggerFile,
                 MultipleInterfaces = MultipleInterfaces.ByEndpoint,
                 UseDynamicQuerystringParameters = useDynamicQuerystringParameters,
                 OperationNameTemplate = "{operationName}Async",
                 ImmutableRecords = true
             };
 
             var sut = await RefitGenerator.CreateAsync(settings);
             var generatedCode = sut.Generate();
-        return generatedCode;
+            return generatedCode;
+        }
+        finally
+        {
+            var dir = Path.GetDirectoryName(swaggerFile);
+            if (!string.IsNullOrEmpty(dir) && Directory.Exists(dir))
+                Directory.Delete(dir, recursive: true);
+        }

---

152-159: Be cautious with brittle string assertions

Hard-coding return types and full signatures is fragile. Consider regex-based checks focusing on method name ExecuteAsync and parameter presence, or use Roslyn to assert signatures.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 83e4f2b and 41cedd6.

📒 Files selected for processing (13)

• .github/workflows/smoke-tests.yml (1 hunks)
• README.md (3 hunks)
• docs/docfx_project/articles/cli-tool.md (1 hunks)
• docs/docfx_project/articles/refitter-file-format.md (2 hunks)
• docs/json-schema.json (1 hunks)
• src/Refitter.Core/RefitMultipleInterfaceGenerator.cs (1 hunks)
• src/Refitter.Core/Settings/MultipleInterfaces.cs (1 hunks)
• src/Refitter.MSBuild/README.md (2 hunks)
• src/Refitter.SourceGenerator/README.md (2 hunks)
• src/Refitter.Tests/Examples/MultipleInterfacesByEndpointWithOperationNameTests.cs (1 hunks)
• src/Refitter.Tests/Examples/OpenApiUrlTests.cs (1 hunks)
• src/Refitter/README.md (3 hunks)
• src/Refitter/Settings.cs (1 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

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.Core/RefitMultipleInterfaceGenerator.cs
• src/Refitter.Tests/Examples/OpenApiUrlTests.cs
• src/Refitter.Tests/Examples/MultipleInterfacesByEndpointWithOperationNameTests.cs
• src/Refitter/Settings.cs
• src/Refitter.Core/Settings/MultipleInterfaces.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/OpenApiUrlTests.cs
• src/Refitter.Tests/Examples/MultipleInterfacesByEndpointWithOperationNameTests.cs

src/Refitter/Settings.cs

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

When adding a new CLI option, add a new property in src/Refitter/Settings.cs with [CommandOption("--option-name")]

Files:

• src/Refitter/Settings.cs

README.md

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

Update README.md documentation for any new CLI option or feature

Files:

• README.md

🧠 Learnings (4)

📚 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.Core/RefitInterfaceGenerator.cs : Implement generation logic for new options in src/Refitter.Core/RefitInterfaceGenerator.cs (or related generator classes)

Applied to files:

• src/Refitter.Core/RefitMultipleInterfaceGenerator.cs
• src/Refitter.MSBuild/README.md
• src/Refitter/README.md
• src/Refitter.SourceGenerator/README.md
• README.md
• docs/docfx_project/articles/refitter-file-format.md

📚 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.Core/Settings/RefitGeneratorSettings.cs : Add corresponding property to src/Refitter.Core/Settings/RefitGeneratorSettings.cs for new CLI options

Applied to files:

• src/Refitter.MSBuild/README.md
• src/Refitter/README.md
• src/Refitter.SourceGenerator/README.md
• README.md
• docs/docfx_project/articles/refitter-file-format.md

📚 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/OpenApiUrlTests.cs
• src/Refitter.Tests/Examples/MultipleInterfacesByEndpointWithOperationNameTests.cs

📚 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/Resources/{V2,V3}/**/*.{json,yaml,yml} : Place OpenAPI test resources under src/Refitter.Tests/Resources/V2/ and V3/

Applied to files:

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

🧬 Code graph analysis (1)

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

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-309)

⏰ 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). (1)

• GitHub Check: script

🔇 Additional comments (2)

.github/workflows/smoke-tests.yml (1)

33-33: Limit PR trigger to main — good hardening

Restricting pull_request to main reduces CI noise from feature branches.

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

49-49: Preprocessor placement looks correct

Moving #endif after the class keeps the conditional scoped to the whole file as intended.

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.40%. Comparing base (756c3a3) to head (2b595fd).
⚠️ Report is 17 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #759      +/-   ##
==========================================
+ Coverage   95.09%   98.40%   +3.30%     
==========================================
  Files          61       62       +1     
  Lines        2755     2689      -66     
==========================================
+ Hits         2620     2646      +26     
+ Misses        102        4      -98     
- Partials       33       39       +6     

Flag	Coverage Δ
unittests	98.40% <100.00%> (+3.30%)	⬆️

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.