Stricter lint config #840
Merged
Stricter lint config #840
Conversation
This file contains hidden or 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
Also turns on strictFunctionTypes, which required an update to the `ComponentClass` interface.
aciccarello
reviewed
Aug 17, 2018
Collaborator
aciccarello
left a comment
aciccarello
left a comment
There was a problem hiding this comment.
Looks good, just curious about one type definition
|
|
||
| export interface ComponentClass<T extends Component> extends Function { | ||
| new(owner: ComponentHost): T; | ||
| export interface ComponentClass<T extends Component, O extends ComponentHost = ComponentHost> extends Function { |
Collaborator
There was a problem hiding this comment.
Why can't this type stay CompilerHost?
Collaborator
Author
There was a problem hiding this comment.
Turning on strictFunctionTypes requires a stronger type for the addComponent method. In particular, the application component in application.ts adds several components which expect their owner to be of type Application. This change makes it possible to specify the owner type in component.ts and thus resolves the type incompatibility.
mrkurt
pushed a commit
to mrkurt/typedoc
that referenced
this pull request
Sep 19, 2018
* Enable no-unnecessary-type-assertion Also turns on strictFunctionTypes, which required an update to the `ComponentClass` interface.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Also turns on strictFunctionTypes, which required an update to the
ComponentClassinterface.This change makes typedoc less likely to break if types change in the future since it removes type assertions which aren't currently needed.
Running
grunt build_and_testwill not lint files with the newno-unnecessary-type-assertionrule as it appears the plugin does not support that option. Once #836 is resolved, this should no longer be an issue. It is also important to be aware that some editor plugins (notably tslint for vscode) do not show rules which require type information.I have added a
npm run linttask which will run tslint directly and show lint errors from tslint rules which require type information and configured Travis to run this task when building.