feat: deprecate multiline-comment-style & line-comment-position

fixes eslint#17681
aladdin-add · May 9, 2024 · 96e3cbd · 96e3cbd
1 parent 04e7c6e
commit 96e3cbd
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 17 deletions.
diff --git a/docs/src/_data/rules.json b/docs/src/_data/rules.json
@@ -633,13 +633,6 @@
                 "fixable": false,
                 "hasSuggestions": false
             },
-            {
-                "name": "multiline-comment-style",
-                "description": "Enforce a particular style for multiline comments",
-                "recommended": false,
-                "fixable": true,
-                "hasSuggestions": false
-            },
             {
                 "name": "new-cap",
                 "description": "Require constructor names to begin with a capital letter",
@@ -1384,13 +1377,6 @@
             }
         ],
         "layout": [
-            {
-                "name": "line-comment-position",
-                "description": "Enforce position of line comments",
-                "recommended": false,
-                "fixable": false,
-                "hasSuggestions": false
-            },
             {
                 "name": "unicode-bom",
                 "description": "Require or disallow Unicode byte order mark (BOM)",
@@ -1567,6 +1553,12 @@
             "fixable": true,
             "hasSuggestions": false
         },
+        {
+            "name": "line-comment-position",
+            "replacedBy": [],
+            "fixable": false,
+            "hasSuggestions": false
+        },
         {
             "name": "linebreak-style",
             "replacedBy": [],
@@ -1605,6 +1597,12 @@
             "fixable": false,
             "hasSuggestions": false
         },
+        {
+            "name": "multiline-comment-style",
+            "replacedBy": [],
+            "fixable": true,
+            "hasSuggestions": false
+        },
         {
             "name": "multiline-ternary",
             "replacedBy": [],

diff --git a/docs/src/_data/rules_meta.json b/docs/src/_data/rules_meta.json
@@ -529,6 +529,8 @@
         "fixable": "whitespace"
     },
     "line-comment-position": {
+        "deprecated": true,
+        "replacedBy": [],
         "type": "layout",
         "docs": {
             "description": "Enforce position of line comments",
@@ -669,6 +671,8 @@
         }
     },
     "multiline-comment-style": {
+        "deprecated": true,
+        "replacedBy": [],
         "type": "suggestion",
         "docs": {
             "description": "Enforce a particular style for multiline comments",

diff --git a/lib/rules/line-comment-position.js b/lib/rules/line-comment-position.js
@@ -13,6 +13,8 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "layout",
 
         docs: {

diff --git a/lib/rules/multiline-comment-style.js b/lib/rules/multiline-comment-style.js
@@ -13,8 +13,9 @@ const astUtils = require("./utils/ast-utils");
 /** @type {import('../shared/types').Rule} */
 module.exports = {
     meta: {
+        deprecated: true,
+        replacedBy: [],
         type: "suggestion",
-
         docs: {
             description: "Enforce a particular style for multiline comments",
             recommended: false,

diff --git a/packages/js/src/configs/eslint-all.js b/packages/js/src/configs/eslint-all.js
@@ -44,7 +44,6 @@ module.exports = Object.freeze({
         "id-length": "error",
         "id-match": "error",
         "init-declarations": "error",
-        "line-comment-position": "error",
         "logical-assignment-operators": "error",
         "max-classes-per-file": "error",
         "max-depth": "error",
@@ -53,7 +52,6 @@ module.exports = Object.freeze({
         "max-nested-callbacks": "error",
         "max-params": "error",
         "max-statements": "error",
-        "multiline-comment-style": "error",
         "new-cap": "error",
         "no-alert": "error",
         "no-array-constructor": "error",