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

Update eslint-plugin-jsdoc to v43 #67

Merged
merged 2 commits into from
Apr 25, 2023
Merged

Update eslint-plugin-jsdoc to v43 #67

merged 2 commits into from
Apr 25, 2023

Conversation

moqada
Copy link
Member

@moqada moqada commented Apr 24, 2023

- 現状最新版に更新
- v42 で `newline-after-description` が削除され, `tag-lines` に移行するため, eslint-plugin-jsdoc の peerDependencies は v42 以上に設定する
  - https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v42.0.0
- eslint-plugin-jsdoc は index.js に含まれていて全体に適用されるため, peerDependenciesMeta に optional のような条件は設定しない
- v42 で `newline-after-description` が削除された
  - https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v42.0.0
    - https://github.com/gajus/eslint-plugin-jsdoc/blob/v41.1.2/.README/rules/newline-after-description.md
    - https://github.com/gajus/eslint-plugin-jsdoc/blob/v43.0.7/.README/rules/tag-lines.md
  - ほぼ既存ルールを踏襲する形で tag-lines に置き換えた
    - タグ間の空行は現行ルールでは設定されていないため `any` に
    - description のあとは空行を挿入するようにしていたため, release notes に従い `startLines: 1` に
    - ただし最後のタグのあとの余分な空行を検知するようになり, それをエラーにするため, この変更をもって BREAKING CHANGE になる
@moqada moqada marked this pull request as ready for review April 24, 2023 12:59
@moqada moqada requested a review from yusato April 24, 2023 12:59
Base automatically changed from feature/goodbye-travis to master April 25, 2023 12:41
@moqada moqada merged commit ede796c into master Apr 25, 2023
1 check passed
@moqada moqada deleted the feature/update-jsdoc branch April 25, 2023 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants