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.

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

feat: plugin jsdoc v43 #313

Merged
merged 2 commits into from
Apr 26, 2023
Merged

feat: plugin jsdoc v43 #313

merged 2 commits into from
Apr 26, 2023

Conversation

sbellone
Copy link
Contributor

@sbellone sbellone commented Apr 25, 2023 •
edited by Haroenv
Loading

jsdoc/newline-after-description was removed in eslint-plugin-jsdoc v42: gajus/eslint-plugin-jsdoc@v41.1.2...v42.0.0

It's replaced by jsdoc/tag-lines

To match the old behaviour, it needs to be configured with:

  • 'any' to say that we don't enforce anything regarding if there are blank lines between tags or not
  • startLines: 1 to enforce having a blank line between the description and the tags (this is what was enforced by jsdoc/newline-after-description)
  • endLines: null to not enforce anything after the tags

(spotted because it makes the linting fail in Renderscript: algolia/renderscript#797)

How to test

  • yarn install
  • cd packages/eslint-config-algolia
  • yarn lint

BREAKING CHANGE: package now depends on eslint-plugin-jsdoc@^43

@sbellone sbellone self-assigned this Apr 25, 2023
@sbellone sbellone requested a review from shortcuts April 25, 2023 18:06
shortcuts
shortcuts approved these changes Apr 26, 2023
View reviewed changes
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

looks great! do we want to release that as a major? just in case it breaks something unexpected?

@sbellone
Copy link
Contributor Author

Good point! I'll bump the version 👍

@sbellone sbellone changed the title fix: plugin jsdoc v43 feat: plugin jsdoc v43 Apr 26, 2023
@sbellone sbellone merged commit e0544c4 into master Apr 26, 2023
@sbellone sbellone deleted the fix/plugin-jsdoc-v43 branch April 26, 2023 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shortcuts shortcuts shortcuts approved these changes

@Haroenv Haroenv Haroenv approved these changes

Assignees

@sbellone sbellone

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sbellone @Haroenv @shortcuts