feat!: Remove valid-jsdoc and require-jsdoc #17694

nzakas · 2023-10-30T15:47:02Z

Prerequisites checklist

I have read the contributing guidelines.

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
[ ] Add something to the core
[ ] Other, please explain:

Remove rule

What changes did you make? (Give an overview)

Removed valid-jsdoc rule, tests, and docs
Updated rule deprecation policy

TODO: Determine if we want to remove require-jsdoc too.

Fixes #15820

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

netlify · 2023-10-30T15:47:09Z

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	`282050e`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/65847e1e2298f5000878a782

mdjermanovic · 2023-10-31T15:28:10Z

@nzakas you probably intended to push 3deb185 to the branch of #17696 instead of here.

nzakas · 2023-10-31T15:29:19Z

Yep, just fixed it.

mdjermanovic · 2023-11-03T19:22:13Z

conf/rule-type-list.json

@@ -23,6 +23,7 @@
        { "removed": "space-in-brackets", "replacedBy": ["object-curly-spacing", "array-bracket-spacing"] },
        { "removed": "space-return-throw-case", "replacedBy": ["keyword-spacing"] },
        { "removed": "space-unary-word-ops", "replacedBy": ["space-unary-ops"] },
-        { "removed": "spaced-line-comment", "replacedBy": ["spaced-comment"] }
+        { "removed": "spaced-line-comment", "replacedBy": ["spaced-comment"] },
+        { "removed": "valid-jsdoc", "replacedBy": [] }


We should also add require-jsdoc to this list.

mdjermanovic · 2023-11-03T19:26:14Z

docs/src/rules/require-jsdoc.md

We're not removing docs for removed rules. We're just updating it with the info that the rule has been removed.

For example:

https://eslint.org/docs/latest/rules/generator-star

Ah! Pretty sure we had a stronger visual treatment than that, though. I'll check on that too.

Yeah, it seems that on the old site that (removed) was converted to an X.

https://archive.eslint.org/docs/rules/generator-star

github-actions · 2023-11-18T22:31:16Z

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.

mdjermanovic · 2023-11-20T09:30:34Z

docs/src/use/rule-deprecation.md

@@ -7,10 +7,12 @@ Balancing the trade-offs of improving a tool and the frustration these changes c

 The ESLint team is committed to making upgrading as easy and painless as possible. To that end, the team has agreed upon the following set of guidelines for deprecating rules in the future. The goal of these guidelines is to allow for improvements and changes to be made without breaking existing configurations.

-* Rules will never be removed from ESLint.
+* Rules will never be removed from ESLint unless one of the following is true:
+    * The rule has been replaced by another core rule


Suggested change

* The rule has been replaced by another core rule

* The rule has been replaced by another core rule.

mdjermanovic · 2023-11-20T09:51:37Z

tests/lib/cli-engine/cli-engine.js

@@ -1774,7 +1772,7 @@ describe("CLIEngine", () => {
            engine = new CLIEngine({
                cwd: originalDir,
                useEslintrc: false,
-                rules: { indent: 1, "valid-jsdoc": 0, "require-jsdoc": 0 }
+                rules: { indent: 1, "callback-return": 0 }


This line is causing merge conflicts. The fixed line should be rules: { eqeqeq: 1, "callback-return": 0 } (indent was replaced here with eqeqeq in #17696).

mdjermanovic · 2023-11-20T09:57:54Z

tests/lib/eslint/eslint.js

@@ -1762,7 +1760,7 @@ describe("ESLint", () => {
                cwd: originalDir,
                useEslintrc: false,
                overrideConfig: {
-                    rules: { indent: 1, "valid-jsdoc": 0, "require-jsdoc": 0 }
+                    rules: { indent: 1, "callback-return": 0 }


Same as #17694 (comment)

mdjermanovic · 2023-11-20T09:58:33Z

tests/lib/eslint/flat-eslint.js

@@ -1956,7 +1954,7 @@ describe("FlatESLint", () => {
                    cwd: originalDir,
                    overrideConfigFile: true,
                    overrideConfig: {
-                        rules: { indent: 1, "valid-jsdoc": 0, "require-jsdoc": 0 }
+                        rules: { indent: 1, "callback-return": 0 }


Same as #17694 (comment)

mdjermanovic · 2023-11-20T10:00:15Z

There are also merge conflicts in docs/src/_data/rules.json. I think it would be better to undo changes in autogenerated files to reduce possible merge conflicts.

tests/lib/eslint/flat-eslint.js

mdjermanovic

LGTM, thanks!

mdjermanovic · 2023-12-20T15:41:50Z

There are merge conflicts because the two removed test files have changed in the meantime.

Fixes #15820

mdjermanovic

Looks like 7a79445 was lost in rebase.

tests/lib/eslint/flat-eslint.js

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

nzakas · 2023-12-21T18:04:30Z

Thanks for that. These conflicts were getting messy.

mdjermanovic

LGTM, thanks!

* main: chore: use jsdoc/no-multi-asterisks with allowWhitespace: true (eslint#17900) chore: fix getting scope in tests (eslint#17899) fix!: Parsing 'exported' comment using parseListConfig (eslint#17675) docs: updated examples of `max-lines` rule (eslint#17898) feat!: Remove valid-jsdoc and require-jsdoc (eslint#17694)

eslint-github-bot bot added breaking This change is backwards-incompatible feature This change adds a new feature to ESLint labels Oct 30, 2023

nzakas force-pushed the issue15820 branch from 3deb185 to fc4e057 Compare October 31, 2023 15:28

mdjermanovic reviewed Nov 3, 2023

View reviewed changes

nzakas changed the title ~~feat!: Remove valid-jsdoc~~ feat!: Remove valid-jsdoc and require-jsdoc Nov 3, 2023

github-actions bot added the Stale label Nov 18, 2023

kecrily removed the Stale label Nov 19, 2023

mdjermanovic added the accepted There is consensus among the team that this change meets the criteria for inclusion label Nov 20, 2023

mdjermanovic reviewed Nov 20, 2023

View reviewed changes

mdjermanovic mentioned this pull request Nov 20, 2023

chore: remove unused config-extends fixtures #17781

Merged

1 task

nzakas force-pushed the issue15820 branch from fb8d0ea to c1252c6 Compare November 20, 2023 16:12

mdjermanovic reviewed Nov 20, 2023

View reviewed changes

tests/lib/eslint/flat-eslint.js Outdated Show resolved Hide resolved

mdjermanovic approved these changes Nov 22, 2023

View reviewed changes

mdjermanovic assigned nzakas Nov 22, 2023

nzakas added 9 commits December 20, 2023 13:32

feat!: Remove valid-jsdoc

cfb2e1a

Fixes #15820

Update rule index page

61e8d7a

Remove references to valid-jsdoc

9c30ca7

Remove reference to valid-jsdoc

1205075

Remove reference to plugin rules

6dd5f23

Remove require-jsdoc

51fee94

Add require-jsdoc to the removed list

1fce9ab

Add back docs and add note about removal

f63a300

Add period

79ebdc4

nzakas force-pushed the issue15820 branch from 7a79445 to 79ebdc4 Compare December 20, 2023 18:33

Remove test files

324e2a4

nzakas marked this pull request as ready for review December 20, 2023 18:35

nzakas requested a review from a team as a code owner December 20, 2023 18:35

mdjermanovic reviewed Dec 21, 2023

View reviewed changes

tests/lib/eslint/flat-eslint.js Outdated Show resolved Hide resolved

Update tests/lib/eslint/flat-eslint.js

282050e

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

mdjermanovic approved these changes Dec 21, 2023

View reviewed changes

mdjermanovic merged commit bdd6ba1 into main Dec 21, 2023
17 checks passed

mdjermanovic deleted the issue15820 branch December 21, 2023 18:47

tdulcet mentioned this pull request Dec 30, 2023

ESLint JSDoc rules removed TinyWebEx/AddonTemplate#5

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: Remove valid-jsdoc and require-jsdoc #17694

feat!: Remove valid-jsdoc and require-jsdoc #17694

nzakas commented Oct 30, 2023

netlify bot commented Oct 30, 2023 •

edited

mdjermanovic commented Oct 31, 2023

nzakas commented Oct 31, 2023

mdjermanovic Nov 3, 2023

mdjermanovic Nov 3, 2023

nzakas Nov 3, 2023

mdjermanovic Nov 4, 2023

github-actions bot commented Nov 18, 2023

mdjermanovic Nov 20, 2023

mdjermanovic Nov 20, 2023

mdjermanovic Nov 20, 2023

mdjermanovic Nov 20, 2023

mdjermanovic commented Nov 20, 2023

mdjermanovic left a comment

mdjermanovic commented Dec 20, 2023

mdjermanovic left a comment

nzakas commented Dec 21, 2023

mdjermanovic left a comment

	* The rule has been replaced by another core rule
	* The rule has been replaced by another core rule.

feat!: Remove valid-jsdoc and require-jsdoc #17694

feat!: Remove valid-jsdoc and require-jsdoc #17694

Conversation

nzakas commented Oct 30, 2023

Prerequisites checklist

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

What changes did you make? (Give an overview)

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

netlify bot commented Oct 30, 2023 • edited

✅ Deploy Preview for docs-eslint canceled.

mdjermanovic commented Oct 31, 2023

nzakas commented Oct 31, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mdjermanovic commented Nov 20, 2023

mdjermanovic left a comment

Choose a reason for hiding this comment

mdjermanovic commented Dec 20, 2023

mdjermanovic left a comment

Choose a reason for hiding this comment

nzakas commented Dec 21, 2023

mdjermanovic left a comment

Choose a reason for hiding this comment

netlify bot commented Oct 30, 2023 •

edited