Skip to content

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

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.

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ export default createRule({
meta: {
type: 'problem',
docs: {
category: 'Best Practices',
recommended: 'error',
description:
'Ensures consistent usage of AST_NODE_TYPES & AST_TOKEN_TYPES enums.',
Expand Down
2 changes: 0 additions & 2 deletions packages/eslint-plugin-tslint/src/rules/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ export default util.createRule({
type: 'suggestion',
docs: {
description: 'Require that member overloads be consecutive',
category: 'Best Practices',
recommended: 'error',
},
schema: [],
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/array-type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/await-thenable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/ban-ts-comment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/ban-tslint-comment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/ban-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/brace-style.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/comma-dangle.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/comma-spacing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/default-param-last.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ export default createRule({
type: 'suggestion',
docs: {
description: 'Enforce default parameters to be last',
category: 'Best Practices',
recommended: false,
extendsBaseRule: true,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/dot-notation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,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: {
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/func-call-spacing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,6 @@ export default createRule<Options, MessageIds>({
type: 'layout',
docs: {
description: 'Enforce consistent indentation.',
category: 'Stylistic Issues',
recommended: false,
},
fixable: 'whitespace',
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/indent.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/init-declarations.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ export default createRule<Options, MessageIds>({
docs: {
description:
'require or disallow initialization in variable declarations',
category: 'Variables',
recommended: false,
extendsBaseRule: true,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/keyword-spacing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/member-delimiter-style.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/member-ordering.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/method-signature-style.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/naming-convention.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-array-constructor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ export default util.createRule({
type: 'suggestion',
docs: {
description: 'Disallow generic `Array` constructors',
category: 'Stylistic Issues',
recommended: 'error',
extendsBaseRule: true,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-base-to-string.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-dupe-class-members.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-duplicate-imports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ export default util.createRule<Options, MessageIds>({
type: 'problem',
docs: {
description: 'Disallow duplicate imports',
category: 'Best Practices',
recommended: false,
extendsBaseRule: true,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-dynamic-delete.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-empty-function.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ export default util.createRule<Options, MessageIds>({
type: 'suggestion',
docs: {
description: 'Disallow empty functions',
category: 'Best Practices',
recommended: 'error',
extendsBaseRule: true,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-empty-interface.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-explicit-any.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ export default util.createRule({
type: 'problem',
docs: {
description: 'Disallow extra non-null assertion',
category: 'Stylistic Issues',
recommended: 'error',
},
fixable: 'code',
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-extra-parens.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ export default util.createRule<Options, MessageIds>({
type: 'layout',
docs: {
description: 'Disallow unnecessary parentheses',
category: 'Possible Errors',
recommended: false,
extendsBaseRule: true,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-extra-semi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ export default util.createRule<Options, MessageIds>({
type: 'suggestion',
docs: {
description: 'Disallow unnecessary semicolons',
category: 'Possible Errors',
recommended: 'error',
extendsBaseRule: true,
},
Expand Down
1 change: 0 additions & 1 deletion packages/eslint-plugin/src/rules/no-extraneous-class.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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: [
Expand Down
Loading