feat: remove meta.docs.category from rules (#3800)

typescript-eslint · Oct 11, 2021 · 71c9370 · 71c9370
1 parent cf4724b
commit 71c9370
Show file tree

Hide file tree

Showing 127 changed files with 9 additions and 144 deletions.
diff --git a/packages/eslint-plugin-internal/src/rules/no-poorly-typed-ts-props.ts b/packages/eslint-plugin-internal/src/rules/no-poorly-typed-ts-props.ts
@@ -38,7 +38,6 @@ export default createRule({
     docs: {
       description:
         "Enforces rules don't use TS API properties with known bad type definitions",
-      category: 'Possible Errors',
       recommended: 'error',
       suggestion: true,
       requiresTypeChecking: true,

diff --git a/packages/eslint-plugin-internal/src/rules/no-typescript-default-import.ts b/packages/eslint-plugin-internal/src/rules/no-typescript-default-import.ts
@@ -22,7 +22,6 @@ export default createRule({
     docs: {
       description:
         "Enforces that packages rules don't do `import ts from 'typescript';`",
-      category: 'Possible Errors',
       recommended: 'error',
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin-internal/src/rules/no-typescript-estree-import.ts b/packages/eslint-plugin-internal/src/rules/no-typescript-estree-import.ts
@@ -16,7 +16,6 @@ export default createRule({
     type: 'problem',
     docs: {
       description: `Enforces that eslint-plugin rules don't require anything from ${TSESTREE_NAME} or ${TYPES_NAME}`,
-      category: 'Possible Errors',
       recommended: 'error',
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts b/packages/eslint-plugin-internal/src/rules/plugin-test-formatting.ts
@@ -108,7 +108,6 @@ export default createRule<Options, MessageIds>({
     type: 'problem',
     docs: {
       description: `Enforces that eslint-plugin test snippets are correctly formatted`,
-      category: 'Stylistic Issues',
       recommended: 'error',
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin-internal/src/rules/prefer-ast-types-enum.ts b/packages/eslint-plugin-internal/src/rules/prefer-ast-types-enum.ts
@@ -15,7 +15,6 @@ export default createRule({
   meta: {
     type: 'problem',
     docs: {
-      category: 'Best Practices',
       recommended: 'error',
       description:
         'Ensures consistent usage of `AST_NODE_TYPES`, `AST_TOKEN_TYPES` and `DefinitionType` enums.',

diff --git a/packages/eslint-plugin-tslint/src/rules/config.ts b/packages/eslint-plugin-tslint/src/rules/config.ts
@@ -63,8 +63,6 @@ export default createRule<Options, MessageIds>({
     docs: {
       description:
         'Wraps a TSLint configuration and lints the whole source using TSLint',
-      // @ts-expect-error - We know this is a one off special category for this plugin
-      category: 'TSLint',
       recommended: false,
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin/src/rules/adjacent-overload-signatures.ts b/packages/eslint-plugin/src/rules/adjacent-overload-signatures.ts
@@ -21,7 +21,6 @@ export default util.createRule({
     type: 'suggestion',
     docs: {
       description: 'Require that member overloads be consecutive',
-      category: 'Best Practices',
       recommended: 'error',
     },
     schema: [],

diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -92,7 +92,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Requires using either `T[]` or `Array<T>` for arrays',
-      category: 'Stylistic Issues',
       // too opinionated to be recommended
       recommended: false,
     },

diff --git a/packages/eslint-plugin/src/rules/await-thenable.ts b/packages/eslint-plugin/src/rules/await-thenable.ts
@@ -7,7 +7,6 @@ export default util.createRule({
   meta: {
     docs: {
       description: 'Disallows awaiting a value that is not a Thenable',
-      category: 'Best Practices',
       recommended: 'error',
       requiresTypeChecking: true,
     },

diff --git a/packages/eslint-plugin/src/rules/ban-ts-comment.ts b/packages/eslint-plugin/src/rules/ban-ts-comment.ts
@@ -22,7 +22,6 @@ export default util.createRule<[Options], MessageIds>({
     docs: {
       description:
         'Bans `@ts-<directive>` comments from being used or requires descriptions after directive',
-      category: 'Best Practices',
       recommended: 'error',
     },
     messages: {

diff --git a/packages/eslint-plugin/src/rules/ban-tslint-comment.ts b/packages/eslint-plugin/src/rules/ban-tslint-comment.ts
@@ -20,7 +20,6 @@ export default util.createRule({
     type: 'suggestion',
     docs: {
       description: 'Bans `// tslint:<rule-flag>` comments from being used',
-      category: 'Stylistic Issues',
       recommended: false,
     },
     messages: {

diff --git a/packages/eslint-plugin/src/rules/ban-types.ts b/packages/eslint-plugin/src/rules/ban-types.ts
@@ -124,7 +124,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Bans specific types from being used',
-      category: 'Best Practices',
       recommended: 'error',
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin/src/rules/brace-style.ts b/packages/eslint-plugin/src/rules/brace-style.ts
@@ -18,7 +18,6 @@ export default createRule<Options, MessageIds>({
     type: 'layout',
     docs: {
       description: 'Enforce consistent brace style for blocks',
-      category: 'Stylistic Issues',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/class-literal-property-style.ts b/packages/eslint-plugin/src/rules/class-literal-property-style.ts
@@ -44,7 +44,6 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description:
         'Ensures that literals on classes are exposed in a consistent style',
-      category: 'Best Practices',
       recommended: false,
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin/src/rules/comma-dangle.ts b/packages/eslint-plugin/src/rules/comma-dangle.ts
@@ -45,7 +45,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'layout',
     docs: {
       description: 'Require or disallow trailing comma',
-      category: 'Stylistic Issues',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/comma-spacing.ts b/packages/eslint-plugin/src/rules/comma-spacing.ts
@@ -23,7 +23,6 @@ export default createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Enforces consistent spacing before and after commas',
-      category: 'Stylistic Issues',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts b/packages/eslint-plugin/src/rules/consistent-indexed-object-style.ts
@@ -14,7 +14,6 @@ export default createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Enforce or disallow the use of the record type',
-      category: 'Stylistic Issues',
       // too opinionated to be recommended
       recommended: false,
     },

diff --git a/packages/eslint-plugin/src/rules/consistent-type-assertions.ts b/packages/eslint-plugin/src/rules/consistent-type-assertions.ts
@@ -25,7 +25,6 @@ export default util.createRule<Options, MessageIds>({
   meta: {
     type: 'suggestion',
     docs: {
-      category: 'Best Practices',
       description: 'Enforces consistent usage of type assertions',
       recommended: false,
     },

diff --git a/packages/eslint-plugin/src/rules/consistent-type-definitions.ts b/packages/eslint-plugin/src/rules/consistent-type-definitions.ts
@@ -13,7 +13,6 @@ export default util.createRule({
     docs: {
       description:
         'Consistent with type definition either `interface` or `type`',
-      category: 'Stylistic Issues',
       // too opinionated to be recommended
       recommended: false,
     },

diff --git a/packages/eslint-plugin/src/rules/consistent-type-imports.ts b/packages/eslint-plugin/src/rules/consistent-type-imports.ts
@@ -56,7 +56,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Enforces consistent usage of type imports',
-      category: 'Stylistic Issues',
       recommended: false,
     },
     messages: {

diff --git a/packages/eslint-plugin/src/rules/default-param-last.ts b/packages/eslint-plugin/src/rules/default-param-last.ts
@@ -10,7 +10,6 @@ export default createRule({
     type: 'suggestion',
     docs: {
       description: 'Enforce default parameters to be last',
-      category: 'Best Practices',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/dot-notation.ts b/packages/eslint-plugin/src/rules/dot-notation.ts
@@ -20,7 +20,6 @@ export default createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'enforce dot notation whenever possible',
-      category: 'Best Practices',
       recommended: false,
       extendsBaseRule: true,
       requiresTypeChecking: true,

diff --git a/packages/eslint-plugin/src/rules/explicit-function-return-type.ts b/packages/eslint-plugin/src/rules/explicit-function-return-type.ts
@@ -26,7 +26,6 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description:
         'Require explicit return types on functions and class methods',
-      category: 'Stylistic Issues',
       recommended: false,
     },
     messages: {

diff --git a/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts b/packages/eslint-plugin/src/rules/explicit-member-accessibility.ts
@@ -36,7 +36,6 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description:
         'Require explicit accessibility modifiers on class properties and methods',
-      category: 'Stylistic Issues',
       // too opinionated to be recommended
       recommended: false,
     },

diff --git a/packages/eslint-plugin/src/rules/explicit-module-boundary-types.ts b/packages/eslint-plugin/src/rules/explicit-module-boundary-types.ts
@@ -37,7 +37,6 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description:
         "Require explicit return and argument types on exported functions' and classes' public class methods",
-      category: 'Stylistic Issues',
       recommended: 'warn',
     },
     messages: {

diff --git a/packages/eslint-plugin/src/rules/func-call-spacing.ts b/packages/eslint-plugin/src/rules/func-call-spacing.ts
@@ -19,7 +19,6 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description:
         'Require or disallow spacing between function identifiers and their invocations',
-      category: 'Stylistic Issues',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/indent-new-do-not-use/index.ts b/packages/eslint-plugin/src/rules/indent-new-do-not-use/index.ts
@@ -257,7 +257,6 @@ export default createRule<Options, MessageIds>({
     type: 'layout',
     docs: {
       description: 'Enforce consistent indentation.',
-      category: 'Stylistic Issues',
       recommended: false,
     },
     fixable: 'whitespace',

diff --git a/packages/eslint-plugin/src/rules/indent.ts b/packages/eslint-plugin/src/rules/indent.ts
@@ -91,7 +91,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'layout',
     docs: {
       description: 'Enforce consistent indentation',
-      category: 'Stylistic Issues',
       // too opinionated to be recommended
       recommended: false,
       extendsBaseRule: true,

diff --git a/packages/eslint-plugin/src/rules/init-declarations.ts b/packages/eslint-plugin/src/rules/init-declarations.ts
@@ -21,7 +21,6 @@ export default createRule<Options, MessageIds>({
     docs: {
       description:
         'require or disallow initialization in variable declarations',
-      category: 'Variables',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/keyword-spacing.ts b/packages/eslint-plugin/src/rules/keyword-spacing.ts
@@ -13,7 +13,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'layout',
     docs: {
       description: 'Enforce consistent spacing before and after keywords',
-      category: 'Stylistic Issues',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/lines-between-class-members.ts b/packages/eslint-plugin/src/rules/lines-between-class-members.ts
@@ -28,7 +28,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'layout',
     docs: {
       description: 'Require or disallow an empty line between class members',
-      category: 'Stylistic Issues',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/member-delimiter-style.ts b/packages/eslint-plugin/src/rules/member-delimiter-style.ts
@@ -120,7 +120,6 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description:
         'Require a specific member delimiter style for interfaces and type literals',
-      category: 'Stylistic Issues',
       recommended: false,
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin/src/rules/member-ordering.ts b/packages/eslint-plugin/src/rules/member-ordering.ts
@@ -423,7 +423,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Require a consistent member declaration order',
-      category: 'Stylistic Issues',
       recommended: false,
     },
     messages: {

diff --git a/packages/eslint-plugin/src/rules/method-signature-style.ts b/packages/eslint-plugin/src/rules/method-signature-style.ts
@@ -13,7 +13,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Enforces using a particular method signature syntax.',
-      category: 'Best Practices',
       recommended: false,
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin/src/rules/naming-convention.ts b/packages/eslint-plugin/src/rules/naming-convention.ts
@@ -55,7 +55,6 @@ export default util.createRule<Options, MessageIds>({
   name: 'naming-convention',
   meta: {
     docs: {
-      category: 'Variables',
       description:
         'Enforces naming conventions for everything across a codebase',
       recommended: false,

diff --git a/packages/eslint-plugin/src/rules/no-array-constructor.ts b/packages/eslint-plugin/src/rules/no-array-constructor.ts
@@ -10,7 +10,6 @@ export default util.createRule({
     type: 'suggestion',
     docs: {
       description: 'Disallow generic `Array` constructors',
-      category: 'Stylistic Issues',
       recommended: 'error',
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/no-base-to-string.ts b/packages/eslint-plugin/src/rules/no-base-to-string.ts
@@ -25,7 +25,6 @@ export default util.createRule<Options, MessageIds>({
     docs: {
       description:
         'Requires that `.toString()` is only called on objects which provide useful information when stringified',
-      category: 'Best Practices',
       recommended: false,
       requiresTypeChecking: true,
     },

diff --git a/packages/eslint-plugin/src/rules/no-confusing-non-null-assertion.ts b/packages/eslint-plugin/src/rules/no-confusing-non-null-assertion.ts
@@ -13,7 +13,6 @@ export default util.createRule({
     docs: {
       description:
         'Disallow non-null assertion in locations that may be confusing',
-      category: 'Stylistic Issues',
       recommended: false,
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin/src/rules/no-confusing-void-expression.ts b/packages/eslint-plugin/src/rules/no-confusing-void-expression.ts
@@ -30,7 +30,6 @@ export default util.createRule<Options, MessageId>({
     docs: {
       description:
         'Requires expressions of type void to appear in statement position',
-      category: 'Best Practices',
       recommended: false,
       requiresTypeChecking: true,
     },

diff --git a/packages/eslint-plugin/src/rules/no-dupe-class-members.ts b/packages/eslint-plugin/src/rules/no-dupe-class-members.ts
@@ -16,7 +16,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'problem',
     docs: {
       description: 'Disallow duplicate class members',
-      category: 'Possible Errors',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/no-duplicate-imports.ts b/packages/eslint-plugin/src/rules/no-duplicate-imports.ts
@@ -16,7 +16,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'problem',
     docs: {
       description: 'Disallow duplicate imports',
-      category: 'Best Practices',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/no-dynamic-delete.ts b/packages/eslint-plugin/src/rules/no-dynamic-delete.ts
@@ -10,7 +10,6 @@ export default util.createRule({
   name: 'no-dynamic-delete',
   meta: {
     docs: {
-      category: 'Best Practices',
       description: 'Disallow the delete operator with computed key expressions',
       recommended: false,
     },

diff --git a/packages/eslint-plugin/src/rules/no-empty-function.ts b/packages/eslint-plugin/src/rules/no-empty-function.ts
@@ -45,7 +45,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Disallow empty functions',
-      category: 'Best Practices',
       recommended: 'error',
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/no-empty-interface.ts b/packages/eslint-plugin/src/rules/no-empty-interface.ts
@@ -14,7 +14,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Disallow the declaration of empty interfaces',
-      category: 'Best Practices',
       recommended: 'error',
       suggestion: true,
     },

diff --git a/packages/eslint-plugin/src/rules/no-explicit-any.ts b/packages/eslint-plugin/src/rules/no-explicit-any.ts
@@ -19,7 +19,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Disallow usage of the `any` type',
-      category: 'Best Practices',
       recommended: 'warn',
       suggestion: true,
     },

diff --git a/packages/eslint-plugin/src/rules/no-extra-non-null-assertion.ts b/packages/eslint-plugin/src/rules/no-extra-non-null-assertion.ts
@@ -7,7 +7,6 @@ export default util.createRule({
     type: 'problem',
     docs: {
       description: 'Disallow extra non-null assertion',
-      category: 'Stylistic Issues',
       recommended: 'error',
     },
     fixable: 'code',

diff --git a/packages/eslint-plugin/src/rules/no-extra-parens.ts b/packages/eslint-plugin/src/rules/no-extra-parens.ts
@@ -20,7 +20,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'layout',
     docs: {
       description: 'Disallow unnecessary parentheses',
-      category: 'Possible Errors',
       recommended: false,
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/no-extra-semi.ts b/packages/eslint-plugin/src/rules/no-extra-semi.ts
@@ -12,7 +12,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Disallow unnecessary semicolons',
-      category: 'Possible Errors',
       recommended: 'error',
       extendsBaseRule: true,
     },

diff --git a/packages/eslint-plugin/src/rules/no-extraneous-class.ts b/packages/eslint-plugin/src/rules/no-extraneous-class.ts
@@ -20,7 +20,6 @@ export default util.createRule<Options, MessageIds>({
     type: 'suggestion',
     docs: {
       description: 'Forbids the use of classes as namespaces',
-      category: 'Best Practices',
       recommended: false,
     },
     schema: [