Allow method name customization when generating multiple interfaces by endpoint #181
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…y value when --multiple-interfaces ByEndpoint is specified
Added the ability to dynamically assign method names in the interface generator of Refitter.Core following the settings.OperationNameTemplate. This enhancement boosts the flexibility of the code generator, letting the user set custom method names when the OperationNameTemplate setting is specified. Otherwise, it defaults to "Execute".
An additional test was added to the smoke-tests.ps1 script. This test involves generating and building MultipleInterfaces using the "--operation-name-template ExecuteAsync" argument. This change was made to provide validation for changes in operations with custom name formatting.
Detailed descriptions were added to the 'GenerateDeprecatedOperations' and 'OperationNameTemplate' properties in RefitGeneratorSettings.cs. Providing clear, concise comments will help other devs to understand the purpose of these properties, especially when setting 'generateDeprecatedOperations' and defining the operation name pattern.
Enhance the description for the `--operation-name-template` option in `Settings.cs`. The added explanation clarifies that when using the `--multiple-interfaces ByEndpoint` option, the operation name template will be used as the name for the `Execute()` method in the generated interface. Consequently, the same understanding is reflected in the README documentation for both the root level and Refitter library usage. This change was essential to provide users with a clearer understanding of how the `--operation-name-template` works with the `--multiple-interfaces ByEndpoint`.
|
Kudos, SonarCloud Quality Gate passed!
|
Codecov Report
@@ Coverage Diff @@
## main #181 +/- ##
=======================================
Coverage 98.70% 98.71%
=======================================
Files 47 47
Lines 1626 1633 +7
=======================================
+ Hits 1605 1612 +7
Misses 6 6
Partials 15 15
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The changes here piggy back on
--operation-name-templateCLI argument to customize theExecute()method name in the interfaces generated when--multiple-interfaces ByEndpointis setThis implements feature request #176 by @Noblix