This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
Add unified-signatures rule
#1944
Merged
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
ghost
mentioned this pull request
ghost
mentioned this pull request
nchen63
suggested changes
Jan 1, 2017
| @@ -0,0 +1,296 @@ | |||
| /** | |||
| * @license | |||
| * Copyright 2013 Palantir Technologies, Inc. | |||
| super.visitModuleDeclaration(node); | ||
| } | ||
|
|
||
| public visitInterfaceDeclaration(node: ts.InterfaceDeclaration): void { |
|
|
||
| import * as Lint from "../index"; | ||
|
|
||
| import { getOverloadKey } from "./adjacentOverloadSignaturesRule"; |
There was a problem hiding this comment.
having a dependency on a different rule is iffy, but I can see why you did it. I think this is ok
| this.checkOverloads(members, getOverloadName, typeParameters); | ||
| function getOverloadName(member: ts.TypeElement | ts.ClassElement) { | ||
| const key = getOverloadKey(member); | ||
| return key === undefined ? undefined : { signature: member as any as ts.SignatureDeclaration, key }; |
There was a problem hiding this comment.
If a non-undefined value means member is a SignatureDeclaration, it would be more clear if a function isSignatureDeclaration was factored out of getOverloadKey
nchen63
approved these changes
Jan 3, 2017
|
@andy-ms thanks! |
ghost
deleted the
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR checklist
What changes did you make?
Added the
unified-signaturesrule. This encourages users to combine overloads where possible.Is there anything you'd like reviewers to focus on?
There may be some test cases I missed. This was originally for declaration files only, but should work outside of them.
Re: #1844 (comment) ("How would this work for more complex signatures"), I added a test labelled
// No error if they differ by 2 or more parameters..This is a rewrite of the one on types-publisher and not just a direct copy, because it needed to handle more cases, and could re-use code from
adjacent-overload-signatures.