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

chore: upgrade eslint-plugin-jsdoc v46 #17245

Merged
merged 1 commit into from Jun 21, 2023
Merged

chore: upgrade eslint-plugin-jsdoc v46 #17245

merged 1 commit into from Jun 21, 2023

Conversation

aladdin-add
Copy link
Member

@aladdin-add aladdin-add commented Jun 7, 2023 •
edited

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ x] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Removes jsdoc/newline-after-description rule in favor of jsdoc/tag-lines with option startLines: 0 for "never" and startLines: 1 for "always".

Refs: https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v42.0.0

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

@aladdin-add aladdin-add requested a review from a team as a code owner June 7, 2023 06:05
@eslint-github-bot eslint-github-bot bot added the chore This change is not user-facing label Jun 7, 2023
@aladdin-add aladdin-add marked this pull request as draft June 7, 2023 06:15
@mdjermanovic
Copy link
Member

I'll close-reopen this to run CI on Node 12 again, tests should pass now since we've merged #17204.

@mdjermanovic mdjermanovic reopened this Jun 7, 2023
@aladdin-add
Copy link
Member Author

great, I'll rebase the main branch and retry.

aladdin-add
aladdin-add commented Jun 8, 2023
View reviewed changes
lib/linter/linter.js Outdated Show resolved Hide resolved
@github-actions
Copy link

Hi everyone, it looks like we lost track of this pull request. Please review and see what the next steps are. This pull request will auto-close in 7 days without an update.

@github-actions github-actions bot added the Stale label Jun 18, 2023
@Rec0iL99 Rec0iL99 removed the Stale label Jun 18, 2023
@Rec0iL99
Copy link
Member

Work in progress. Not stale.

@aladdin-add aladdin-add marked this pull request as ready for review June 19, 2023 01:59
@aladdin-add
Copy link
Member Author

@Rec0iL99 thanks, it's ready for review now.

@aladdin-add aladdin-add self-assigned this Jun 19, 2023
@aladdin-add aladdin-add mentioned this pull request Jun 19, 2023
Merged
1 task
nzakas
nzakas requested changes Jun 19, 2023
View reviewed changes
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

Thanks for doing this. I have two concerns:

  1. It's ruining the formatting we've been using for JSDoc indents. I'd like to find a way to preserve that.
  2. It's removing all of the default values we have set in the JSDoc. These are important and should not be removed. I don't know if we need a different configuration, if this is a bug with the plugin, or if we need to request an option to keep default values. Can you please investigate?

lib/cli-engine/cli-engine.js Outdated Show resolved Hide resolved
lib/cli.js Outdated Show resolved Hide resolved
lib/eslint/flat-eslint.js Outdated Show resolved Hide resolved
lib/linter/linter.js Outdated Show resolved Hide resolved
lib/linter/linter.js Outdated Show resolved Hide resolved
tests/lib/source-code/source-code.js Outdated Show resolved Hide resolved
tools/eslint-fuzzer.js Outdated Show resolved Hide resolved
tools/eslint-fuzzer.js Outdated Show resolved Hide resolved
tools/fuzzer-runner.js Outdated Show resolved Hide resolved
tools/fuzzer-runner.js Outdated Show resolved Hide resolved
@aladdin-add aladdin-add marked this pull request as draft June 19, 2023 16:39
@aladdin-add aladdin-add force-pushed the chore/jsdoc-v42 branch 2 times, most recently from e5ac766 to 5950bae Compare June 20, 2023 05:06
@aladdin-add
Copy link
Member Author

  1. disabled rule jsdoc/no-defaults: it's a new added rule in its recommended config that eslint does not follow.
  2. disabled rule jsdoc/check-line-alignment: I've tried its option "never"|"always"|"any" - none of them fully meet our needs.

Refs:

@nzakas wdyt?

@nzakas
Copy link
Member

nzakas commented Jun 20, 2023

Makes sense to me. 👍

@aladdin-add
chore: update eslint-plugin-jsdoc to 46.2.5
5a63ff4 
1. Removes `jsdoc/newline-after-description` rule in favor of `jsdoc/tag-lines`
with option `startLines: 0` for "never" and `startLines: 1` for "always".
Refs: https://github.com/gajus/eslint-plugin-jsdoc/releases/tag/v42.0.0

2. disabled rule jsdoc/no-defaults: it's a new added rule in its recommended config
 that eslint does not follow.

3. disabled rule jsdoc/check-line-alignment: I've tried its option "never"|"always"|"any"
- none of them fully meet our needs.
@aladdin-add aladdin-add marked this pull request as ready for review June 21, 2023 02:20
@aladdin-add aladdin-add requested a review from nzakas June 21, 2023 02:20
nzakas
nzakas approved these changes Jun 21, 2023
View reviewed changes
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@nzakas nzakas merged commit da81e66 into eslint:main Jun 21, 2023
17 checks passed
json-derulo added a commit to json-derulo/angular-ecmascript-intl that referenced this pull request Jul 4, 2023
@json-derulo @renovate-bot
chore(deps): update dependency eslint to v8.44.0 (#78)
83c3cd4 
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org)
([source](https://togithub.com/eslint/eslint)) | devDependencies | minor
| [`8.43.0` ->
`8.44.0`](https://renovatebot.com/diffs/npm/eslint/8.43.0/8.44.0) |

---

### Release Notes

<details>
<summary>eslint/eslint (eslint)</summary>

### [`v8.44.0`](https://togithub.com/eslint/eslint/releases/tag/v8.44.0)

[Compare
Source](https://togithub.com/eslint/eslint/compare/v8.43.0...v8.44.0)

#### Features

-
[`1766771`](https://togithub.com/eslint/eslint/commit/176677180a4a1209fc192771521c9192e1f67578)
feat: add `es2023` and `es2024` environments
(#&#8203;1[eslint/eslint#17328))
(Milos Djermanovic)
-
[`4c50400`](https://togithub.com/eslint/eslint/commit/4c5040022639ae804c15b366afc6e64982bd8ae3)
feat: add `ecmaVersion: 2024`, regexp `v` flag parsing
(#&#8203;1[eslint/eslint#17324))
(Milos Djermanovic)
-
[`4d411e4`](https://togithub.com/eslint/eslint/commit/4d411e4c7063274d6d346f1b7ee46f7575d0bbd2)
feat: add ternaryOperandBinaryExpressions option to no-extra-parens rule
(#&#8203;1[eslint/eslint#17270))
(Percy Ma)
-
[`c8b1f4d`](https://togithub.com/eslint/eslint/commit/c8b1f4d61a256727755d561bf53f889b6cd712e0)
feat: Move `parserServices` to `SourceCode`
(#&#8203;1[eslint/eslint#17311))
(Milos Djermanovic)
-
[`ef6e24e`](https://togithub.com/eslint/eslint/commit/ef6e24e42670f321d996948623846d9caaedac99)
feat: treat unknown nodes as having the lowest precedence
(#&#8203;1[eslint/eslint#17302))
(Brad Zacher)
-
[`1866e1d`](https://togithub.com/eslint/eslint/commit/1866e1df6175e4ba0ae4a0d88dc3c956bb310035)
feat: allow flat config files to export a Promise
(#&#8203;1[eslint/eslint#17301))
(Milos Djermanovic)

#### Bug Fixes

-
[`a36bcb6`](https://togithub.com/eslint/eslint/commit/a36bcb67f26be42c794797d0cc9948b9cfd4ff71)
fix: no-unused-vars false positive with logical assignment operators
(#&#8203;1[eslint/eslint#17320))
(Gweesin Chan)
-
[`7620b89`](https://togithub.com/eslint/eslint/commit/7620b891e81c234f30f9dbcceb64a05fd0dde65e)
fix: Remove `no-unused-labels` autofix before potential directives
(#&#8203;1[eslint/eslint#17314))
(Francesco Trotta)
-
[`391ed38`](https://togithub.com/eslint/eslint/commit/391ed38b09bd1a3abe85db65b8fcda980ab3d6f4)
fix: Remove `no-extra-semi` autofix before potential directives
(#&#8203;1[eslint/eslint#17297))
(Francesco Trotta)

#### Documentation

-
[`526e911`](https://togithub.com/eslint/eslint/commit/526e91106e6fe101578e9478a9d7f4844d4f72ac)
docs: resubmit pr 17115 doc changes
(#&#8203;1[eslint/eslint#17291))
(唯然)
-
[`e1314bf`](https://togithub.com/eslint/eslint/commit/e1314bf85a52bb0d05b1c9ca3b4c1732bae22172)
docs: Integration section and tutorial
(#&#8203;1[eslint/eslint#17132))
(Ben Perlmutter)
-
[`19a8c5d`](https://togithub.com/eslint/eslint/commit/19a8c5d84596a9f7f2aa428c1696ba86daf854e6)
docs: Update README (GitHub Actions Bot)

#### Chores

-
[`49e46ed`](https://togithub.com/eslint/eslint/commit/49e46edf3c8dc71d691a97fc33b63ed80ae0db0c)
chore: upgrade
[@&#8203;eslint/js](https://togithub.com/eslint/js)[@&#8203;8](https://togithub.com/8).44.0
(#&#8203;1[eslint/eslint#17329))
(Milos Djermanovic)
-
[`a1cb642`](https://togithub.com/eslint/eslint/commit/a1cb6421f9d185901cd99e5f696e912226ef6632)
chore: package.json update for
[@&#8203;eslint/js](https://togithub.com/eslint/js) release (ESLint
Jenkins)
-
[`840a264`](https://togithub.com/eslint/eslint/commit/840a26462bbf6c27c52c01b85ee2018062157951)
test: More test cases for no-case-declarations
(#&#8203;1[eslint/eslint#17315))
(Elian Cordoba)
-
[`e6e74f9`](https://togithub.com/eslint/eslint/commit/e6e74f9eef0448129dd4775628aba554a2d8c8c9)
chore: package.json update for eslint-config-eslint release (ESLint
Jenkins)
-
[`eb3d794`](https://togithub.com/eslint/eslint/commit/eb3d7946e1e9f70254008744dba2397aaa730114)
chore: upgrade semver@7.5.3
(#&#8203;1[eslint/eslint#17323))
(Ziyad El Abid)
-
[`cf88439`](https://togithub.com/eslint/eslint/commit/cf884390ad8071d88eae05df9321100f1770363d)
chore: upgrade optionator@0.9.3
(#&#8203;1[eslint/eslint#17319))
(Milos Djermanovic)
-
[`9718a97`](https://togithub.com/eslint/eslint/commit/9718a9781d69d2c40b68c631aed97700b32c0082)
refactor: remove unnecessary code in `flat-eslint.js`
(#&#8203;1[eslint/eslint#17308))
(Milos Djermanovic)
-
[`f82e56e`](https://togithub.com/eslint/eslint/commit/f82e56e9acfb9562ece76441472d5657d7d5e296)
perf: various performance improvements
(#&#8203;1[eslint/eslint#17135))
(moonlightaria)
-
[`da81e66`](https://togithub.com/eslint/eslint/commit/da81e66e22b4f3d3fe292cf70c388753304deaad)
chore: update eslint-plugin-jsdoc to 46.2.5
(#&#8203;1[eslint/eslint#17245))
(唯然)
-
[`b991640`](https://togithub.com/eslint/eslint/commit/b991640176d5dce4750f7cc71c56cd6f284c882f)
chore: switch eslint-config-eslint to the flat format
(#&#8203;1[eslint/eslint#17247))
(唯然)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xNTUuMCIsInVwZGF0ZWRJblZlciI6IjM1LjE1OS4zIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: Renovate Bot <bot@renovateapp.com>
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 19, 2023
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Dec 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@nzakas nzakas nzakas approved these changes

Assignees

@aladdin-add aladdin-add

Labels
archived due to age This issue has been archived; please open a new issue for any further discussion chore This change is not user-facing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@aladdin-add @mdjermanovic @Rec0iL99 @nzakas