Emit new() type constraints on generic type parameters; emit params keyword for method parameters #65
Conversation
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.
| && x.AttributeClass | ||
| .Name | ||
| .Contains(AutomaticInterfaceGenerator.DefaultAttributeName) | ||
| .FirstOrDefault(x => |
There was a problem hiding this comment.
Csharpier reformat - this was failing on master.
| @@ -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.
| @@ -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)
| | 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.
| 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).
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.