Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New rule: newline-between-tags #552

Closed
0xCLARITY opened this issue May 27, 2020 · 2 comments
Closed

New rule: newline-between-tags #552

0xCLARITY opened this issue May 27, 2020 · 2 comments

Comments

@0xCLARITY
Copy link
Contributor

Motivation

In all of our repos, there is an inconsistency between different functions and how they handle whitespace, especially between @param and @returns. For example:

/**
 * ...
 *
 * @param var - ...
 * @returns ...
 */

vs

/**
 * ...
 *
 * @param var - ...
 *
 * @returns ...
 */

Ideally I would like to be able to enforce consistency here.

Current behavior

No opinion about lines between JSDoc members.

Desired behavior

Enforce an opinion about lines between JSDoc members.

Alternatives considered

Not aware of any alternatives except a new rule.

@brettz9
Copy link
Collaborator

brettz9 commented May 27, 2020

We have newline-after-description for the newline between the main description and other tags, and the other aspects sounds like a dupe of #93.

@0xCLARITY
Copy link
Contributor Author

@brettz9 , sorry for not noticing the existing issue. I'll close this in favor of #93

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants