feat(@schematics/angular): add no-redundant-jsdoc tslint rule
#11286
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
alan-agius4
changed the title
no-redundant-jsdoc tslint ruleno-redundant-jsdoc tslint rule
When building a library, `tsickle` is used as the `annotateForClosureCompiler` option is `true`. `tsickle` warns when redundant jsdocs are used. https://github.com/angular/tsickle/blob/d24b139b71a3f86bf25d6eecf4d4dcdad3b379e4/src/jsdoc.ts#L170-L178 These diagnostics are later passed to Angular Compiler and are treated as errors. Seeing this: angular/angular#19969 (comment) it looks like it is expected that warnings will fail the build. Closes: #11282
|
//cc @clydin |
|
Looks good. Features are blocked until the 6.2 window is open. |
|
@clydin I think we can merge this one now. |
|
@clydin can you tell if this PR is gonna be merged? |
clydin
approved these changes
Aug 8, 2018
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
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.
When building a library,
tsickleis used as theannotateForClosureCompileroption istrue. tsickle warns when redundant jsdocs are used.https://github.com/angular/tsickle/blob/d24b139b71a3f86bf25d6eecf4d4dcdad3b379e4/src/jsdoc.ts#L170-L178
These diagnostics are later passed to Angular Compiler and are treated as errors.
Seeing this: angular/angular#19969 (comment) it looks like it is expected that warnings will fail the build.
Closes: #11282