Emit new() type constraints on generic type parameters; emit params keyword for method parameters #65
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
This addresses codecentric#64, where type parameters weren't having the `new()` constraint applied. Also updated some tests that were failing due to changes in the `inheritdoc` annotations and re-ran csharpier.
simonmckenzie
commented
Dec 3, 2024
| && x.AttributeClass | ||
| .Name | ||
| .Contains(AutomaticInterfaceGenerator.DefaultAttributeName) | ||
| .FirstOrDefault(x => |
There was a problem hiding this comment.
Csharpier reformat - this was failing on master.
simonmckenzie
commented
Dec 3, 2024
| @@ -1820,10 +1821,10 @@ namespace AutomaticInterfaceExample | |||
| [global::System.CodeDom.Compiler.GeneratedCode("AutomaticInterface", "")] | |||
| public partial interface IDemoClass | |||
| { | |||
| /// <inheritdoc /> | |||
| /// <inheritdoc cref="AutomaticInterfaceExample.DemoClass.AMethod(Func{Task{int}})" /> | |||
There was a problem hiding this comment.
These tests were failing on master. Updated.
simonmckenzie
force-pushed
the
fix/add-new-type-constraint-to-generated-interface-methods
branch
from
5990dd0 to
3b91fd9
Compare
simonmckenzie
changed the title
Small fix - the existing code wasn't emitting the "params" keyword
simonmckenzie
force-pushed
the
fix/add-new-type-constraint-to-generated-interface-methods
branch
from
3b91fd9 to
b978bae
Compare
|
I hope it's OK that I have fixed two things in one PR here @ChristianSauer - it just felt it'd be easier since the master pipeline was already failing, and both would have needed the same set of base fixes (linting and rehabilitation of broken tests). |
…tring(FullyQualifiedDisplayFormat)` This removes a fair bit of code and ensures we're formatting our parameters consistently.
simonmckenzie
commented
Dec 4, 2024
| @@ -105,7 +105,10 @@ private static void AddMethod(InterfaceBuilder codeGenerator, IMethodSymbol meth | |||
| ActivateNullableIfNeeded(codeGenerator, method); | |||
|
|
|||
| var paramResult = new HashSet<string>(); | |||
| method.Parameters.Select(GetMethodSignature).ToList().ForEach(x => paramResult.Add(x)); | |||
| method | |||
| .Parameters.Select(x => x.ToDisplayString(FullyQualifiedDisplayFormat)) | |||
There was a problem hiding this comment.
The FullyQualifiedDisplayFormat can format the parameters for us, so we can now remove all the custom code for generating parameter signatures (see the deletions of the GetMethod... methods below)
simonmckenzie
commented
Dec 4, 2024
Comment on lines
+20
to
+22
| | SymbolDisplayParameterOptions.IncludeParamsRefOut | ||
| | SymbolDisplayParameterOptions.IncludeDefaultValue | ||
| | SymbolDisplayParameterOptions.IncludeName, |
There was a problem hiding this comment.
I've expanded the parameter formatting rules so we can use this formatter for parameter signature generation.
simonmckenzie
commented
Dec 4, 2024
| typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces, | ||
| globalNamespaceStyle: SymbolDisplayGlobalNamespaceStyle.Included, | ||
| miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes | ||
| | SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier | ||
| | SymbolDisplayMiscellaneousOptions.EscapeKeywordIdentifiers |
There was a problem hiding this comment.
This ensures that parameters that share names with keywords will be escaped.
This replicates the behaviour of the (now deleted) GetMethodSignature method.
(there's an existing test for this, WorksWithReservedNames).
simonmckenzie
added a commit
to simonmckenzie/net_automatic_interface
that referenced
this pull request
Jan 27, 2025
…ult values This addresses a bug where there's no cast when generating a definition for a parameter with a nonzero default enum parameter value. Previously, it would generate values like this: ```csharp void MethodWithDefaultParameter(MyEnum value = 1); ``` This would not compile, as there's no implicit conversion from nonzero integral types to enum values. ## Changes - Reinstated the default value generation logic that was removed in codecentric#65, as default values can't actually be reliably generated by Roslyn (e.g. enum default values) - Added special case for enum values (cast nonzero values to the enum type) - Added tests, and moved all parameter tests into the `.MethodParameters.cs` test file
simonmckenzie
added a commit
to simonmckenzie/net_automatic_interface
that referenced
this pull request
Jan 27, 2025
…ult values This addresses a bug where there's no cast when generating a definition for a parameter with a nonzero default enum parameter value. Previously, it would generate values like this: ```csharp void MethodWithDefaultParameter(MyEnum value = 1); ``` This would not compile, as there's no implicit conversion from nonzero integral types to enum values. - Reinstated the default value generation logic that was removed in codecentric#65, as default values generated by Roslyn aren't guaranteed to be valid code, and, in the case of enum default values, clearly aren't. - Added special case when generating default values for enum parameters (cast nonzero values to the enum type) - Added tests, and moved all parameter tests into the `.MethodParameters.cs` test file
simonmckenzie
added a commit
to simonmckenzie/net_automatic_interface
that referenced
this pull request
Jan 27, 2025
…ult values This addresses a bug where there's no cast when generating a definition for a parameter with a nonzero default enum parameter value. Previously, it would generate values like this: ```csharp void MethodWithDefaultParameter(MyEnum value = 1); ``` This would not compile, as there's no implicit conversion from nonzero integral types to enum values. - Reinstated the default value generation logic that was removed in codecentric#65, as default values generated by Roslyn aren't guaranteed to be valid code, and, in the case of enum default values, clearly aren't. - Added special case when generating default values for enum parameters (cast nonzero values to the enum type) - Added tests, and moved all parameter tests into the `.MethodParameters.cs` test file
simonmckenzie
added a commit
to simonmckenzie/net_automatic_interface
that referenced
this pull request
Jan 27, 2025
…ult values This addresses a bug where there's no cast when generating a definition for a parameter with a nonzero default enum parameter value. Previously, it would generate values like this: ```csharp void MethodWithDefaultParameter(MyEnum value = 1); ``` This would not compile, as there's no implicit conversion from nonzero integral types to enum values. - Reinstated the default value generation logic that was removed in codecentric#65, as default values generated by Roslyn aren't guaranteed to be valid code, and, in the case of enum default values, clearly aren't. - Added special case when generating default values for enum parameters (cast nonzero values to the enum type) - Added tests, and moved all parameter tests into the `.MethodParameters.cs` test file
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.
This addresses #64, where type parameters weren't having the
new()constraint applied.I have also addressed a comment by @ChaseFlorell regarding missing
paramskeywords.#62 (comment)
Finally, I have updated some tests that were failing due to changes in the
inheritdocannotations and re-ran csharpier, as some existing files were failing linting.