Skip to content

Add rule to (dis)allow empty lines between tags #93

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.

Sign up for GitHub

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

Jump to bottom
Closed
dietergeerts opened this issue Sep 24, 2018 · 1 comment · Fixed by #727
Closed

Add rule to (dis)allow empty lines between tags #93

dietergeerts opened this issue Sep 24, 2018 · 1 comment · Fixed by #727
Labels
enhancement released

Comments

@dietergeerts
Copy link

In our code base, there is no real consistency between having empty lines or not between the tags of docblocks. I want to have more consistency and want to disallow empty lines between then, while having the empty line after the description. So I would like to see this implemented. If I have time, I would like to try it myself, but I can't promise anything.
@golopot golopot mentioned this issue Sep 4, 2019
Closed
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Dec 2, 2019
@brettz9
INCOMPLETE: Need to get tests passing, apply to else-if branch, and t…
ef8cb46 
…hen create as utility so new rule preventing newlines between tags can reuse; to use smoother stringification fixing approach, will probably need to get comment-parser stringify to add back asterisks for multiline descriptions (ideally preserving this info during parse; may be other stringification issues); gajus#93
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Dec 4, 2019
@brettz9
INCOMPLETE: Need to get tests passing, apply to else-if branch, and t…
d88db5e 
…hen create as utility so new rule preventing newlines between tags can reuse; to use smoother stringification fixing approach, will probably need to get comment-parser stringify to add back asterisks for multiline descriptions (ideally preserving this info during parse; may be other stringification issues); gajus#93
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Dec 4, 2019
@brettz9
INCOMPLETE: Need to get tests passing, apply to else-if branch, and t…
e18dfee 
…hen create as utility so new rule preventing newlines between tags can reuse; to use smoother stringification fixing approach, will probably need to get comment-parser stringify to add back asterisks for multiline descriptions (ideally preserving this info during parse; may be other stringification issues); gajus#93
@brettz9 brettz9 mentioned this issue May 27, 2020
Closed
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 11, 2021
@brettz9
feat: new rule tag-line; fixes gajus#93
2a4c1ce
@brettz9 brettz9 mentioned this issue May 11, 2021
Merged
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 12, 2021
@brettz9
feat: new rule tag-line; fixes gajus#93
170b1a0
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 12, 2021
@brettz9
feat: new rule tag-line; fixes gajus#93
19829a3
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 12, 2021
@brettz9
feat: new rule tag-line; fixes gajus#93
46e0112
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 12, 2021
@brettz9
feat: new rule tag-line; fixes gajus#93
630421d
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 13, 2021
@brettz9
feat: new rule tag-line; fixes gajus#93
2f6897d
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 15, 2021
@brettz9
feat: new rule tag-line; fixes gajus#93
3a3907d
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue May 15, 2021
@brettz9
Merge branch 'tag-lines' into multiline-blocks
38544ce 
* tag-lines:
  Since the fixer may add asterisks as well as newlines, set `fixable` to `code` rather than `whitespace`
  docs: Indicate option is actually recommended
  - docs: minor clarification
  - Rename `noEndLine` to `noEndLines` since may normally be multiple lines after tags
  - Docs: Clarify `noEndLine`
  feat: new rule `tag-line`; fixes gajus#93
  chore(`generateRule`): add `line` by default in test errors
  chore: allow rule generation to put backticks on separate lines (to avoid default linting errors)
  fix(`check-param-names`): adjusts line numbers to be nearer problematic item
  fix(`no-missing-syntax`): pass in missing `comment`
  fix(`require-description`, `require-example`): for missing description, use tag line number
  docs(`no-bad-blocks`): add clarifying comment to valid example
  feat(`no-bad-blocks`): add `preventAllMultiasteriskBlocks` boolean option to allow reporting of any multi-asterisked multiline comments
  feat(`check-line-alignment`): add `preserveMainDescriptionPostDelimiter` option to preserve left-hand side spacings in the main description when using the `always` option.
  Revert "Add preserveMainDescriptionPostDelimiter option (gajus#731)"
  docs(`check-line-alignment`): make mention of at least a single space being added by either the "always" or "never" option
  chore: update devDeps.
  docs: update README
  Add preserveMainDescriptionPostDelimiter option (gajus#731)

# Conflicts:
#	README.md
#	src/iterateJsdoc.js
brettz9 added a commit that referenced this issue May 15, 2021
@brettz9
feat: new rule tag-line; fixes #93
851e3fe
@gajus
Copy link
Owner

gajus commented May 15, 2021

🎉 This issue has been resolved in version 34.4.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label May 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement released
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: new rule tag-line; fixes #93 brettz9/eslint-plugin-jsdoc
3 participants
@brettz9 @gajus @dietergeerts