Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

jsdoc-format: check first line of multiline comment #3181

Merged
merged 5 commits into from Sep 18, 2017
Merged

jsdoc-format: check first line of multiline comment #3181

merged 5 commits into from Sep 18, 2017

Conversation

ajafff
Copy link
Contributor

@ajafff ajafff commented Aug 29, 2017

PR checklist

Overview of change:

Adds a check to jsdoc-format to disallow text in the first line of multiline JSDoc comments.
Fixes: #1052

Is there anything you'd like reviewers to focus on?

CHANGELOG.md entry:

[new-rule-option] jsdoc-format adds option "check-multiline-start" to enforce the first line of a multiline JSDoc comment to be empty.

Copy link
Contributor

@adidahiya adidahiya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's not make this a breaking change right now.

The rule should ignore the first line by default and a new option (maybe "check-first-line-of-multiline"?). We can enable this new option in tslint:latest and track an issue to make it the default in 6.0.

@ajafff
Copy link
Contributor Author

ajafff commented Sep 15, 2017

I added an option "check-multiline-start", updated the docs and tslint:all and tslint:latest

@adidahiya adidahiya merged commit c434183 into palantir:master Sep 18, 2017
HyphnKnight pushed a commit to HyphnKnight/tslint that referenced this pull request Apr 9, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

jsdoc-format enhancement
2 participants