chore(eslint-plugin): remove redundant recommended property

microsoft · Oct 18, 2024 · 23df010 · 23df010
1 parent 66a2683
commit 23df010
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 29 deletions.
diff --git a/packages/eslint-plugin/src/rules/ban-context-export/index.js b/packages/eslint-plugin/src/rules/ban-context-export/index.js
@@ -7,8 +7,6 @@ const { getTypeServices } = require('../../utils/type-services');
 
 /** @typedef { import('@typescript-eslint/utils').TSESTree.VariableDeclarator } VariableDeclarator*/
 /** @typedef { import('@typescript-eslint/utils').TSESTree.ExportSpecifier} ExportSpecifier */
-/** @typedef { import('@typescript-eslint/utils').TSESLint.RuleMetaDataDocs} RuleMetaDataDocs*/
-/** @typedef { import('@typescript-eslint/utils').TSESLint.RuleRecommendation} RuleRecommendation */
 /**
  * @typedef {{
  *  exclude?: string[];
@@ -35,10 +33,9 @@ module.exports = createRule({
       },
     ],
     type: 'problem',
-    docs: /** @type {RuleMetaDataDocs & { recommended: RuleRecommendation }} */ ({
+    docs: {
       description: 'Ban export of React context or context selector objects',
-      recommended: 'recommended',
-    }),
+    },
     messages: {
       nativeContext: '{{exportName}} should not be exported directly',
       contextSelector: '{{exportName}} should not be exported directly',

diff --git a/packages/eslint-plugin/src/rules/ban-instanceof-html-element/index.js b/packages/eslint-plugin/src/rules/ban-instanceof-html-element/index.js
@@ -4,18 +4,15 @@ const createRule = require('../../utils/createRule');
 
 /**
  * @typedef {import('./types').HTMLElementConstructorName} HTMLElementConstructorName
- * @typedef { import('@typescript-eslint/utils').TSESLint.RuleMetaDataDocs} RuleMetaDataDocs
- * @typedef { import('@typescript-eslint/utils').TSESLint.RuleRecommendation} RuleRecommendation
  */
 
 module.exports = createRule({
   name: 'ban-instanceof-html-element',
   meta: {
     type: 'problem',
-    docs: /** @type {RuleMetaDataDocs & { recommended: RuleRecommendation }} */ ({
+    docs: {
       description: 'Ban usage of instanceof HTMLElement comparison',
-      recommended: 'recommended',
-    }),
+    },
     messages: {
       invalidBinaryExpression: 'instanceof {{right}} should be avoided, use isHTMLElement instead.',
     },

diff --git a/packages/eslint-plugin/src/rules/deprecated-keyboard-event-props.js b/packages/eslint-plugin/src/rules/deprecated-keyboard-event-props.js
@@ -4,16 +4,14 @@ const { ESLintUtils } = require('@typescript-eslint/utils');
 
 /**
  * @typedef { import('@typescript-eslint/utils').TSESLint.RuleMetaDataDocs} RuleMetaDataDocs
- * @typedef { import('@typescript-eslint/utils').TSESLint.RuleRecommendation} RuleRecommendation
  */
 
 module.exports = createRule({
   name: 'deprecated-keyboard-event-props',
   meta: {
     type: 'problem',
-    docs: /** @type {RuleMetaDataDocs & { recommended: RuleRecommendation }} */ ({
+    docs: /** @type {RuleMetaDataDocs} */ ({
       description: 'Forbid use of deprecated KeyboardEvent props "which" and "keyCode".',
-      recommended: 'recommended',
       requiresTypeChecking: true,
     }),
     messages: {

diff --git a/packages/eslint-plugin/src/rules/no-global-react.js b/packages/eslint-plugin/src/rules/no-global-react.js
@@ -2,19 +2,13 @@
 const { AST_NODE_TYPES } = require('@typescript-eslint/utils');
 const createRule = require('../utils/createRule');
 
-/**
- * @typedef { import('@typescript-eslint/utils').TSESLint.RuleMetaDataDocs} RuleMetaDataDocs
- * @typedef { import('@typescript-eslint/utils').TSESLint.RuleRecommendation} RuleRecommendation
- */
-
 module.exports = createRule({
   name: 'no-global-react',
   meta: {
     type: 'problem',
-    docs: /** @type {RuleMetaDataDocs & { recommended: RuleRecommendation }} */ ({
+    docs: {
       description: 'Prevent accidental references to the global React namespace',
-      recommended: 'recommended',
-    }),
+    },
     messages: {
       missingImport: 'You must explicitly import React to reference it',
     },

diff --git a/packages/eslint-plugin/src/rules/no-tslint-comments.js b/packages/eslint-plugin/src/rules/no-tslint-comments.js
@@ -1,19 +1,13 @@
 // @ts-check
 const createRule = require('../utils/createRule');
 
-/**
- * @typedef { import('@typescript-eslint/utils').TSESLint.RuleMetaDataDocs} RuleMetaDataDocs
- * @typedef { import('@typescript-eslint/utils').TSESLint.RuleRecommendation} RuleRecommendation
- */
-
 module.exports = createRule({
   name: 'no-tslint-comments',
   meta: {
     type: 'problem',
-    docs: /** @type {RuleMetaDataDocs & { recommended: RuleRecommendation }} */ ({
+    docs: {
       description: 'Forbid tslint:disable/tslint:enable comments after ESLint migration.',
-      recommended: 'recommended',
-    }),
+    },
     messages: {
       tslint: 'tslint:{{verb}} comments are unnecessary with ESLint',
     },