Codefix for implementing interfaces #11547
Conversation
| if (token.kind === SyntaxKind.Identifier && token.parent.parent.kind === SyntaxKind.HeritageClause) { | ||
| const children = (<HeritageClause>token.parent.parent).getChildren(); | ||
| ts.forEach(children, child => { | ||
| if (child.kind === SyntaxKind.ExtendsKeyword) { |
There was a problem hiding this comment.
this is not sufficient. what if the class already has an implements clause. you want to first look for implements clause, and if you found one, move the interface to the implements list otherwise rename the extends to implements. one option is to generate two edits, one that always removes the extends clause all together, and another one that adds the target to the right place.
There was a problem hiding this comment.
Fixed. The edit is to change extends -> implements, and if implements is already present, change implements -> ','
| @@ -0,0 +1,268 @@ | |||
| /* @internal */ | |||
| namespace ts.codefix { | |||
| registerCodeFix({ | |||
There was a problem hiding this comment.
please split these into different files. let's keep each code fix in its own file.
There was a problem hiding this comment.
you can still share the helpers between files if you need to.
There was a problem hiding this comment.
Split, and helpers moved to src/services/utilities.ts
|
|
||
| let textChanges: TextChange[] = []; | ||
|
|
||
| if (token.kind === SyntaxKind.Identifier && token.parent.kind === SyntaxKind.ClassDeclaration) { |
There was a problem hiding this comment.
what about classExpression? var x = class C implements I { }? use isClassLike instead
|
|
||
| let textChanges: TextChange[] = []; | ||
|
|
||
| if (token.kind === SyntaxKind.Identifier && token.parent.kind === SyntaxKind.ClassDeclaration) { |
| const token = getTokenAtPosition(sourceFile, start); | ||
| const checker = context.program.getTypeChecker(); | ||
|
|
||
| let textChanges: TextChange[] = []; |
There was a problem hiding this comment.
what is the point of this initialization, you can just override it below. consider just leaving this as undefined, and checking for undefined below.
| if (token.kind === SyntaxKind.Identifier && token.parent.kind === SyntaxKind.ClassDeclaration) { | ||
| const classDeclaration = <ClassDeclaration>token.parent; | ||
| const startPos = classDeclaration.members.pos; | ||
| const classMembers = getClassMembers(classDeclaration); |
There was a problem hiding this comment.
you just need the abstract ones.
| const classMembers = getClassMembers(classDeclaration); | ||
| const trackingAddedMembers: string[] = []; | ||
| const extendsClause = ts.getClassExtendsHeritageClauseElement(classDeclaration); | ||
| textChanges = textChanges.concat(getChanges(extendsClause, classMembers, startPos, checker, /*reference*/ false, trackingAddedMembers, context.newLineCharacter)); |
There was a problem hiding this comment.
This does not handle properties declared in the constructor as parameter property declarations, e.g. this should only add b and not a.
interface I {
a: number,
b:string;
}
class C implements I {
constructor(public a) {}
}Please add tests.
| if (interfaceMembers[j].name && existingMembers.indexOf(interfaceMembers[j].name.getText()) === -1) { | ||
| if (interfaceMembers[j].kind === SyntaxKind.PropertySignature) { | ||
| const interfaceProperty = <PropertySignature>interfaceMembers[j]; | ||
| if (trackingAddedMembers.indexOf(interfaceProperty.name.getText()) === -1) { |
There was a problem hiding this comment.
this does not handle computed properties correctly. e.g. [Symbol.Iterator]. please add tests.
| } | ||
|
|
||
| function getMembersAndStartPosFromReference(variableDeclaration: VariableDeclaration): { startPos: number, members: string[] } { | ||
| const children = variableDeclaration.getChildren(); |
There was a problem hiding this comment.
variableDeclaration.initializer ?
| /* @internal */ | ||
| namespace ts.codefix { | ||
| registerCodeFix({ | ||
| errorCodes: [Diagnostics.Type_0_is_not_assignable_to_type_1.code], |
There was a problem hiding this comment.
this code fix is not nearly close to being complete. please remove this from this patch and added by itself later on. i am not sure we should do this either. there are issues that are not fixable. and we are not detecting them and handling them correctly.
There was a problem hiding this comment.
Removed, and tests changed.
| } | ||
| `); | ||
| verify.not.codeFixAvailable(); | ||
| // verify.codeFixAtPosition(` |
Still need to add localization strings
| getReturnTypeOfSignature, | ||
| getNonNullableType, | ||
| getSymbolsInScope, | ||
| createSymbol, |
There was a problem hiding this comment.
i would say use new Symbol() here.
| getSignaturesOfType, | ||
| getIndexTypeOfType, | ||
| getBaseTypes, | ||
| getUnionType, | ||
| getIntersectionType, |
There was a problem hiding this comment.
if this is not used i would remove it for now.
| getSymbolAtLocation, | ||
| getShorthandAssignmentValueSymbol, | ||
| getExportSpecifierLocalTargetSymbol, | ||
| getTypeAtLocation: getTypeOfNode, | ||
| getPropertySymbolOfDestructuringAssignment, | ||
| signatureToString, |
There was a problem hiding this comment.
consider inlining these two using checker.getSymbolDisplayBuilder().
There was a problem hiding this comment.
signatureToString is needed independently in the checker anyways, so I'd prefer to avoid copying the code if it can be avoided.
indexSignatureToString: Only used in one place in the current PR, but we may find it useful in a future codefix for adding index signatures. Will inline for now, but may have to re-declare it in the future.
| const classDecl = <ClassDeclaration>token.parent; | ||
| const startPos = classDecl.members.pos; | ||
|
|
||
| const InstantiatedExtendsType = checker.getTypeFromTypeReference(getClassExtendsHeritageClauseElement(classDecl)) as InterfaceType; |
There was a problem hiding this comment.
please add a test for expression with type arguments case:
function foo<T>(a: T) {
abstract class C<U> {
a: T;
b: U;
abstract method2();
}
return C;
}
class B extends foo("s")<number> {
method() {
}
}| const decls = symbol.getDeclarations(); | ||
| Debug.assert(!!(decls && decls.length > 0)); | ||
| const flags = getModifierFlags(decls[0]); | ||
| return !(flags & ModifierFlags.Private) && !!(flags & ModifierFlags.Abstract); |
There was a problem hiding this comment.
i would ignore private here.
There was a problem hiding this comment.
return symbol.valueDeclaration.flags & ModifierFlags.PrivateThere was a problem hiding this comment.
Needed to suppress fix when the user creates a class with a private abstract property/member. Is there a better way to detect general errors on a declaration/node? This would be useful to suppress codefixes in many situations.
| } | ||
|
|
||
| function symbolRefersToNonPrivateMember(symbol: Symbol): boolean { | ||
| const decls = symbol.getDeclarations(); |
There was a problem hiding this comment.
just:
return symbol.valueDecaration.flags & ModifierFlags.PrivateThere was a problem hiding this comment.
EDIT: moved response to the right place.
Made the change here.
|
|
||
| function createParameterDeclaration(index: number, minArgCount: number, typeNode: TypeNode, enclosingSignatureDeclaration: SignatureDeclaration): ParameterDeclaration { | ||
| const newParameter = createNode(SyntaxKind.Parameter) as ParameterDeclaration; | ||
| newParameter.symbol = checker.createSymbol(SymbolFlags.FunctionScopedVariable, "arg" + index); |
There was a problem hiding this comment.
i would rather we use a name form one of hte signatures.
| } | ||
|
|
||
| if (hasRestParameter) { | ||
| const anyArrayTypeNode = createNode(SyntaxKind.ArrayType) as ArrayTypeNode; |
There was a problem hiding this comment.
consider making these implicitAny's instead by not setting a type, and handling this in the writer instead.
And fixing
extendsvs.implements