From 3ae0574fc78c4a2b406625e4792cb2859cb9bcb1 Mon Sep 17 00:00:00 2001 From: Amaresh S M Date: Wed, 29 Jun 2022 17:36:08 -0700 Subject: [PATCH] docs: Remove duplicate rule descriptions (#16052) * chore: remove hardcoded markdown desc * chore: capitalize rule description * chore: capitalize rule description * chore: removed unwanted changes * docs: restore description in removed rules --- .eslintrc.js | 2 +- docs/src/_data/rules.json | 520 ++++++++-------- docs/src/_data/rules_meta.json | 566 +++++++++--------- docs/src/rules/accessor-pairs.md | 1 - docs/src/rules/array-bracket-newline.md | 2 - docs/src/rules/array-bracket-spacing.md | 2 - docs/src/rules/array-callback-return.md | 1 - docs/src/rules/array-element-newline.md | 2 - docs/src/rules/arrow-parens.md | 2 - docs/src/rules/arrow-spacing.md | 2 - docs/src/rules/block-scoped-var.md | 1 - docs/src/rules/block-spacing.md | 2 - docs/src/rules/brace-style.md | 2 - docs/src/rules/callback-return.md | 1 - docs/src/rules/camelcase.md | 1 - docs/src/rules/capitalized-comments.md | 2 - docs/src/rules/class-methods-use-this.md | 1 - docs/src/rules/comma-dangle.md | 2 - docs/src/rules/comma-spacing.md | 2 - docs/src/rules/comma-style.md | 2 - docs/src/rules/complexity.md | 1 - docs/src/rules/computed-property-spacing.md | 2 - docs/src/rules/consistent-return.md | 1 - docs/src/rules/consistent-this.md | 1 - docs/src/rules/curly.md | 2 - docs/src/rules/default-case-last.md | 1 - docs/src/rules/default-case.md | 1 - docs/src/rules/default-param-last.md | 2 - docs/src/rules/dot-location.md | 2 - docs/src/rules/dot-notation.md | 2 - docs/src/rules/eol-last.md | 2 - docs/src/rules/eqeqeq.md | 2 - docs/src/rules/for-direction.md | 2 - docs/src/rules/func-call-spacing.md | 2 - docs/src/rules/func-name-matching.md | 1 - docs/src/rules/func-names.md | 1 - docs/src/rules/func-style.md | 1 - .../rules/function-call-argument-newline.md | 2 - docs/src/rules/function-paren-newline.md | 2 - docs/src/rules/generator-star-spacing.md | 2 - docs/src/rules/getter-return.md | 2 - docs/src/rules/global-require.md | 1 - docs/src/rules/grouped-accessor-pairs.md | 1 - docs/src/rules/guard-for-in.md | 1 - docs/src/rules/handle-callback-err.md | 1 - docs/src/rules/id-blacklist.md | 1 - docs/src/rules/id-denylist.md | 1 - docs/src/rules/id-length.md | 1 - docs/src/rules/id-match.md | 1 - docs/src/rules/implicit-arrow-linebreak.md | 2 - docs/src/rules/indent-legacy.md | 2 - docs/src/rules/indent.md | 2 - docs/src/rules/init-declarations.md | 1 - docs/src/rules/jsx-quotes.md | 2 - docs/src/rules/key-spacing.md | 2 - docs/src/rules/keyword-spacing.md | 2 - docs/src/rules/line-comment-position.md | 1 - docs/src/rules/linebreak-style.md | 2 - docs/src/rules/lines-around-comment.md | 2 - docs/src/rules/lines-around-directive.md | 2 - docs/src/rules/lines-between-class-members.md | 2 - docs/src/rules/max-classes-per-file.md | 1 - docs/src/rules/max-depth.md | 1 - docs/src/rules/max-len.md | 1 - docs/src/rules/max-lines-per-function.md | 1 - docs/src/rules/max-lines.md | 1 - docs/src/rules/max-nested-callbacks.md | 1 - docs/src/rules/max-params.md | 1 - docs/src/rules/max-statements-per-line.md | 1 - docs/src/rules/max-statements.md | 1 - docs/src/rules/multiline-comment-style.md | 2 - docs/src/rules/multiline-ternary.md | 2 - docs/src/rules/new-cap.md | 1 - docs/src/rules/new-parens.md | 2 - docs/src/rules/newline-after-var.md | 2 - docs/src/rules/newline-before-return.md | 2 - docs/src/rules/newline-per-chained-call.md | 2 - docs/src/rules/no-alert.md | 1 - docs/src/rules/no-array-constructor.md | 1 - docs/src/rules/no-async-promise-executor.md | 2 - docs/src/rules/no-await-in-loop.md | 1 - docs/src/rules/no-bitwise.md | 1 - docs/src/rules/no-buffer-constructor.md | 1 - docs/src/rules/no-caller.md | 1 - docs/src/rules/no-case-declarations.md | 2 - docs/src/rules/no-catch-shadow.md | 1 - docs/src/rules/no-class-assign.md | 2 - docs/src/rules/no-compare-neg-zero.md | 2 - docs/src/rules/no-cond-assign.md | 2 - docs/src/rules/no-confusing-arrow.md | 2 - docs/src/rules/no-console.md | 1 - docs/src/rules/no-const-assign.md | 2 - .../rules/no-constant-binary-expression.md | 1 - docs/src/rules/no-constant-condition.md | 2 - docs/src/rules/no-constructor-return.md | 1 - docs/src/rules/no-continue.md | 1 - docs/src/rules/no-control-regex.md | 2 - docs/src/rules/no-debugger.md | 2 - docs/src/rules/no-delete-var.md | 2 - docs/src/rules/no-div-regex.md | 2 - docs/src/rules/no-dupe-args.md | 2 - docs/src/rules/no-dupe-class-members.md | 2 - docs/src/rules/no-dupe-else-if.md | 2 - docs/src/rules/no-dupe-keys.md | 2 - docs/src/rules/no-duplicate-case.md | 2 - docs/src/rules/no-duplicate-imports.md | 1 - docs/src/rules/no-else-return.md | 2 - docs/src/rules/no-empty-character-class.md | 2 - docs/src/rules/no-empty-function.md | 1 - docs/src/rules/no-empty-pattern.md | 2 - docs/src/rules/no-empty.md | 2 - docs/src/rules/no-eq-null.md | 1 - docs/src/rules/no-eval.md | 1 - docs/src/rules/no-ex-assign.md | 2 - docs/src/rules/no-extend-native.md | 1 - docs/src/rules/no-extra-bind.md | 2 - docs/src/rules/no-extra-boolean-cast.md | 2 - docs/src/rules/no-extra-label.md | 2 - docs/src/rules/no-extra-parens.md | 2 - docs/src/rules/no-extra-semi.md | 2 - docs/src/rules/no-fallthrough.md | 2 - docs/src/rules/no-floating-decimal.md | 2 - docs/src/rules/no-func-assign.md | 2 - docs/src/rules/no-global-assign.md | 2 - docs/src/rules/no-implicit-coercion.md | 2 - docs/src/rules/no-implicit-globals.md | 1 - docs/src/rules/no-implied-eval.md | 1 - docs/src/rules/no-import-assign.md | 2 - docs/src/rules/no-inline-comments.md | 1 - docs/src/rules/no-inner-declarations.md | 2 - docs/src/rules/no-invalid-regexp.md | 2 - docs/src/rules/no-invalid-this.md | 1 - docs/src/rules/no-irregular-whitespace.md | 2 - docs/src/rules/no-iterator.md | 1 - docs/src/rules/no-label-var.md | 1 - docs/src/rules/no-labels.md | 1 - docs/src/rules/no-lone-blocks.md | 1 - docs/src/rules/no-lonely-if.md | 2 - docs/src/rules/no-loop-func.md | 1 - docs/src/rules/no-loss-of-precision.md | 2 - docs/src/rules/no-magic-numbers.md | 1 - .../rules/no-misleading-character-class.md | 2 - docs/src/rules/no-mixed-operators.md | 1 - docs/src/rules/no-mixed-requires.md | 1 - docs/src/rules/no-mixed-spaces-and-tabs.md | 2 - docs/src/rules/no-multi-assign.md | 1 - docs/src/rules/no-multi-spaces.md | 2 - docs/src/rules/no-multi-str.md | 1 - docs/src/rules/no-multiple-empty-lines.md | 2 - docs/src/rules/no-native-reassign.md | 1 - docs/src/rules/no-negated-condition.md | 1 - docs/src/rules/no-negated-in-lhs.md | 1 - docs/src/rules/no-nested-ternary.md | 1 - docs/src/rules/no-new-func.md | 1 - docs/src/rules/no-new-object.md | 1 - docs/src/rules/no-new-require.md | 1 - docs/src/rules/no-new-symbol.md | 2 - docs/src/rules/no-new-wrappers.md | 1 - docs/src/rules/no-new.md | 1 - docs/src/rules/no-nonoctal-decimal-escape.md | 2 - docs/src/rules/no-obj-calls.md | 2 - docs/src/rules/no-octal-escape.md | 1 - docs/src/rules/no-octal.md | 2 - docs/src/rules/no-param-reassign.md | 1 - docs/src/rules/no-path-concat.md | 1 - docs/src/rules/no-plusplus.md | 1 - docs/src/rules/no-process-env.md | 1 - docs/src/rules/no-process-exit.md | 1 - docs/src/rules/no-promise-executor-return.md | 1 - docs/src/rules/no-proto.md | 1 - docs/src/rules/no-prototype-builtins.md | 2 - docs/src/rules/no-redeclare.md | 2 - docs/src/rules/no-regex-spaces.md | 2 - docs/src/rules/no-restricted-exports.md | 1 - docs/src/rules/no-restricted-globals.md | 1 - docs/src/rules/no-restricted-imports.md | 1 - docs/src/rules/no-restricted-modules.md | 1 - docs/src/rules/no-restricted-properties.md | 1 - docs/src/rules/no-restricted-syntax.md | 1 - docs/src/rules/no-return-assign.md | 1 - docs/src/rules/no-return-await.md | 1 - docs/src/rules/no-script-url.md | 1 - docs/src/rules/no-self-assign.md | 2 - docs/src/rules/no-self-compare.md | 1 - docs/src/rules/no-sequences.md | 1 - docs/src/rules/no-setter-return.md | 2 - docs/src/rules/no-shadow-restricted-names.md | 2 - docs/src/rules/no-shadow.md | 1 - docs/src/rules/no-spaced-func.md | 2 - docs/src/rules/no-sparse-arrays.md | 2 - docs/src/rules/no-sync.md | 1 - docs/src/rules/no-tabs.md | 1 - docs/src/rules/no-template-curly-in-string.md | 1 - docs/src/rules/no-ternary.md | 1 - docs/src/rules/no-this-before-super.md | 2 - docs/src/rules/no-throw-literal.md | 1 - docs/src/rules/no-trailing-spaces.md | 2 - docs/src/rules/no-undef-init.md | 2 - docs/src/rules/no-undef.md | 2 - docs/src/rules/no-undefined.md | 1 - docs/src/rules/no-underscore-dangle.md | 1 - docs/src/rules/no-unexpected-multiline.md | 2 - .../src/rules/no-unmodified-loop-condition.md | 1 - docs/src/rules/no-unneeded-ternary.md | 2 - docs/src/rules/no-unreachable-loop.md | 1 - docs/src/rules/no-unreachable.md | 2 - docs/src/rules/no-unsafe-finally.md | 2 - docs/src/rules/no-unsafe-negation.md | 2 - docs/src/rules/no-unsafe-optional-chaining.md | 2 - docs/src/rules/no-unused-expressions.md | 1 - docs/src/rules/no-unused-labels.md | 2 - .../rules/no-unused-private-class-members.md | 1 - docs/src/rules/no-unused-vars.md | 2 - docs/src/rules/no-use-before-define.md | 1 - docs/src/rules/no-useless-backreference.md | 2 - docs/src/rules/no-useless-call.md | 1 - docs/src/rules/no-useless-catch.md | 2 - docs/src/rules/no-useless-computed-key.md | 2 - docs/src/rules/no-useless-concat.md | 1 - docs/src/rules/no-useless-constructor.md | 1 - docs/src/rules/no-useless-escape.md | 2 - docs/src/rules/no-useless-rename.md | 2 - docs/src/rules/no-useless-return.md | 2 - docs/src/rules/no-var.md | 2 - docs/src/rules/no-void.md | 1 - docs/src/rules/no-warning-comments.md | 1 - .../rules/no-whitespace-before-property.md | 2 - docs/src/rules/no-with.md | 2 - .../rules/nonblock-statement-body-position.md | 2 - docs/src/rules/object-curly-newline.md | 2 - docs/src/rules/object-curly-spacing.md | 2 - docs/src/rules/object-property-newline.md | 2 - docs/src/rules/object-shorthand.md | 2 - .../src/rules/one-var-declaration-per-line.md | 2 - docs/src/rules/one-var.md | 2 - docs/src/rules/operator-assignment.md | 2 - docs/src/rules/operator-linebreak.md | 2 - docs/src/rules/padded-blocks.md | 2 - .../rules/padding-line-between-statements.md | 2 - docs/src/rules/prefer-arrow-callback.md | 2 - docs/src/rules/prefer-const.md | 2 - docs/src/rules/prefer-destructuring.md | 2 - .../rules/prefer-exponentiation-operator.md | 2 - docs/src/rules/prefer-named-capture-group.md | 1 - docs/src/rules/prefer-numeric-literals.md | 2 - docs/src/rules/prefer-object-has-own.md | 2 - docs/src/rules/prefer-object-spread.md | 2 - .../src/rules/prefer-promise-reject-errors.md | 1 - docs/src/rules/prefer-reflect.md | 1 - docs/src/rules/prefer-regex-literals.md | 2 - docs/src/rules/prefer-rest-params.md | 1 - docs/src/rules/prefer-spread.md | 1 - docs/src/rules/prefer-template.md | 2 - docs/src/rules/quote-props.md | 2 - docs/src/rules/quotes.md | 2 - docs/src/rules/radix.md | 2 - docs/src/rules/require-atomic-updates.md | 1 - docs/src/rules/require-await.md | 1 - docs/src/rules/require-jsdoc.md | 1 - docs/src/rules/require-unicode-regexp.md | 1 - docs/src/rules/require-yield.md | 2 - docs/src/rules/rest-spread-spacing.md | 2 - docs/src/rules/semi-spacing.md | 2 - docs/src/rules/semi-style.md | 2 - docs/src/rules/semi.md | 2 - docs/src/rules/sort-imports.md | 2 - docs/src/rules/sort-keys.md | 1 - docs/src/rules/sort-vars.md | 2 - docs/src/rules/space-before-blocks.md | 2 - docs/src/rules/space-before-function-paren.md | 2 - docs/src/rules/space-in-parens.md | 2 - docs/src/rules/space-infix-ops.md | 2 - docs/src/rules/space-unary-ops.md | 2 - docs/src/rules/spaced-comment.md | 2 - docs/src/rules/strict.md | 2 - docs/src/rules/switch-colon-spacing.md | 2 - docs/src/rules/symbol-description.md | 1 - docs/src/rules/template-curly-spacing.md | 2 - docs/src/rules/template-tag-spacing.md | 2 - docs/src/rules/unicode-bom.md | 2 - docs/src/rules/use-isnan.md | 2 - docs/src/rules/valid-jsdoc.md | 2 - docs/src/rules/valid-typeof.md | 2 - docs/src/rules/vars-on-top.md | 1 - docs/src/rules/wrap-iife.md | 2 - docs/src/rules/wrap-regex.md | 2 - docs/src/rules/yield-star-spacing.md | 2 - docs/src/rules/yoda.md | 2 - lib/rules/accessor-pairs.js | 2 +- lib/rules/array-bracket-newline.js | 2 +- lib/rules/array-bracket-spacing.js | 2 +- lib/rules/array-callback-return.js | 2 +- lib/rules/array-element-newline.js | 2 +- lib/rules/arrow-body-style.js | 2 +- lib/rules/arrow-parens.js | 2 +- lib/rules/arrow-spacing.js | 2 +- lib/rules/block-scoped-var.js | 2 +- lib/rules/block-spacing.js | 2 +- lib/rules/brace-style.js | 2 +- lib/rules/callback-return.js | 2 +- lib/rules/camelcase.js | 2 +- lib/rules/capitalized-comments.js | 2 +- lib/rules/class-methods-use-this.js | 2 +- lib/rules/comma-dangle.js | 2 +- lib/rules/comma-spacing.js | 2 +- lib/rules/comma-style.js | 2 +- lib/rules/complexity.js | 2 +- lib/rules/computed-property-spacing.js | 2 +- lib/rules/consistent-return.js | 2 +- lib/rules/consistent-this.js | 2 +- lib/rules/constructor-super.js | 2 +- lib/rules/curly.js | 2 +- lib/rules/default-case-last.js | 2 +- lib/rules/default-case.js | 2 +- lib/rules/default-param-last.js | 2 +- lib/rules/dot-location.js | 2 +- lib/rules/dot-notation.js | 2 +- lib/rules/eol-last.js | 2 +- lib/rules/eqeqeq.js | 2 +- lib/rules/for-direction.js | 2 +- lib/rules/func-call-spacing.js | 2 +- lib/rules/func-name-matching.js | 2 +- lib/rules/func-names.js | 2 +- lib/rules/func-style.js | 2 +- lib/rules/function-call-argument-newline.js | 2 +- lib/rules/function-paren-newline.js | 2 +- lib/rules/generator-star-spacing.js | 2 +- lib/rules/getter-return.js | 2 +- lib/rules/global-require.js | 2 +- lib/rules/grouped-accessor-pairs.js | 2 +- lib/rules/guard-for-in.js | 2 +- lib/rules/handle-callback-err.js | 2 +- lib/rules/id-blacklist.js | 2 +- lib/rules/id-denylist.js | 2 +- lib/rules/id-length.js | 2 +- lib/rules/id-match.js | 2 +- lib/rules/implicit-arrow-linebreak.js | 2 +- lib/rules/indent-legacy.js | 2 +- lib/rules/indent.js | 2 +- lib/rules/init-declarations.js | 2 +- lib/rules/jsx-quotes.js | 2 +- lib/rules/key-spacing.js | 2 +- lib/rules/keyword-spacing.js | 2 +- lib/rules/line-comment-position.js | 2 +- lib/rules/linebreak-style.js | 2 +- lib/rules/lines-around-comment.js | 2 +- lib/rules/lines-around-directive.js | 2 +- lib/rules/lines-between-class-members.js | 2 +- lib/rules/max-classes-per-file.js | 2 +- lib/rules/max-depth.js | 2 +- lib/rules/max-len.js | 2 +- lib/rules/max-lines-per-function.js | 2 +- lib/rules/max-lines.js | 2 +- lib/rules/max-nested-callbacks.js | 2 +- lib/rules/max-params.js | 2 +- lib/rules/max-statements-per-line.js | 2 +- lib/rules/max-statements.js | 2 +- lib/rules/multiline-comment-style.js | 2 +- lib/rules/multiline-ternary.js | 2 +- lib/rules/new-cap.js | 2 +- lib/rules/new-parens.js | 2 +- lib/rules/newline-after-var.js | 2 +- lib/rules/newline-before-return.js | 2 +- lib/rules/newline-per-chained-call.js | 2 +- lib/rules/no-alert.js | 2 +- lib/rules/no-array-constructor.js | 2 +- lib/rules/no-async-promise-executor.js | 2 +- lib/rules/no-await-in-loop.js | 2 +- lib/rules/no-bitwise.js | 2 +- lib/rules/no-buffer-constructor.js | 2 +- lib/rules/no-caller.js | 2 +- lib/rules/no-case-declarations.js | 2 +- lib/rules/no-catch-shadow.js | 2 +- lib/rules/no-class-assign.js | 2 +- lib/rules/no-compare-neg-zero.js | 2 +- lib/rules/no-cond-assign.js | 2 +- lib/rules/no-confusing-arrow.js | 2 +- lib/rules/no-console.js | 2 +- lib/rules/no-const-assign.js | 2 +- lib/rules/no-constant-binary-expression.js | 2 +- lib/rules/no-constant-condition.js | 2 +- lib/rules/no-constructor-return.js | 2 +- lib/rules/no-continue.js | 2 +- lib/rules/no-control-regex.js | 2 +- lib/rules/no-debugger.js | 2 +- lib/rules/no-delete-var.js | 2 +- lib/rules/no-div-regex.js | 2 +- lib/rules/no-dupe-args.js | 2 +- lib/rules/no-dupe-class-members.js | 2 +- lib/rules/no-dupe-else-if.js | 2 +- lib/rules/no-dupe-keys.js | 2 +- lib/rules/no-duplicate-case.js | 2 +- lib/rules/no-duplicate-imports.js | 2 +- lib/rules/no-else-return.js | 2 +- lib/rules/no-empty-character-class.js | 2 +- lib/rules/no-empty-function.js | 2 +- lib/rules/no-empty-pattern.js | 2 +- lib/rules/no-empty.js | 2 +- lib/rules/no-eq-null.js | 2 +- lib/rules/no-eval.js | 2 +- lib/rules/no-ex-assign.js | 2 +- lib/rules/no-extend-native.js | 2 +- lib/rules/no-extra-bind.js | 2 +- lib/rules/no-extra-boolean-cast.js | 2 +- lib/rules/no-extra-label.js | 2 +- lib/rules/no-extra-parens.js | 2 +- lib/rules/no-extra-semi.js | 2 +- lib/rules/no-fallthrough.js | 2 +- lib/rules/no-floating-decimal.js | 2 +- lib/rules/no-func-assign.js | 2 +- lib/rules/no-global-assign.js | 2 +- lib/rules/no-implicit-coercion.js | 2 +- lib/rules/no-implicit-globals.js | 2 +- lib/rules/no-implied-eval.js | 2 +- lib/rules/no-import-assign.js | 2 +- lib/rules/no-inline-comments.js | 2 +- lib/rules/no-inner-declarations.js | 2 +- lib/rules/no-invalid-regexp.js | 2 +- lib/rules/no-invalid-this.js | 2 +- lib/rules/no-irregular-whitespace.js | 2 +- lib/rules/no-iterator.js | 2 +- lib/rules/no-label-var.js | 2 +- lib/rules/no-labels.js | 2 +- lib/rules/no-lone-blocks.js | 2 +- lib/rules/no-lonely-if.js | 2 +- lib/rules/no-loop-func.js | 2 +- lib/rules/no-loss-of-precision.js | 2 +- lib/rules/no-magic-numbers.js | 2 +- lib/rules/no-misleading-character-class.js | 2 +- lib/rules/no-mixed-operators.js | 2 +- lib/rules/no-mixed-requires.js | 2 +- lib/rules/no-mixed-spaces-and-tabs.js | 2 +- lib/rules/no-multi-assign.js | 2 +- lib/rules/no-multi-spaces.js | 2 +- lib/rules/no-multi-str.js | 2 +- lib/rules/no-multiple-empty-lines.js | 2 +- lib/rules/no-native-reassign.js | 2 +- lib/rules/no-negated-condition.js | 2 +- lib/rules/no-negated-in-lhs.js | 2 +- lib/rules/no-nested-ternary.js | 2 +- lib/rules/no-new-func.js | 2 +- lib/rules/no-new-object.js | 2 +- lib/rules/no-new-require.js | 2 +- lib/rules/no-new-symbol.js | 2 +- lib/rules/no-new-wrappers.js | 2 +- lib/rules/no-new.js | 2 +- lib/rules/no-nonoctal-decimal-escape.js | 2 +- lib/rules/no-obj-calls.js | 2 +- lib/rules/no-octal-escape.js | 2 +- lib/rules/no-octal.js | 2 +- lib/rules/no-param-reassign.js | 2 +- lib/rules/no-path-concat.js | 2 +- lib/rules/no-plusplus.js | 2 +- lib/rules/no-process-env.js | 2 +- lib/rules/no-process-exit.js | 2 +- lib/rules/no-promise-executor-return.js | 2 +- lib/rules/no-proto.js | 2 +- lib/rules/no-prototype-builtins.js | 2 +- lib/rules/no-redeclare.js | 2 +- lib/rules/no-regex-spaces.js | 2 +- lib/rules/no-restricted-exports.js | 2 +- lib/rules/no-restricted-globals.js | 2 +- lib/rules/no-restricted-imports.js | 2 +- lib/rules/no-restricted-modules.js | 2 +- lib/rules/no-restricted-properties.js | 2 +- lib/rules/no-restricted-syntax.js | 2 +- lib/rules/no-return-assign.js | 2 +- lib/rules/no-return-await.js | 2 +- lib/rules/no-script-url.js | 2 +- lib/rules/no-self-assign.js | 2 +- lib/rules/no-self-compare.js | 2 +- lib/rules/no-sequences.js | 2 +- lib/rules/no-setter-return.js | 2 +- lib/rules/no-shadow-restricted-names.js | 2 +- lib/rules/no-shadow.js | 2 +- lib/rules/no-spaced-func.js | 2 +- lib/rules/no-sparse-arrays.js | 2 +- lib/rules/no-sync.js | 2 +- lib/rules/no-tabs.js | 2 +- lib/rules/no-template-curly-in-string.js | 2 +- lib/rules/no-ternary.js | 2 +- lib/rules/no-this-before-super.js | 2 +- lib/rules/no-throw-literal.js | 2 +- lib/rules/no-trailing-spaces.js | 2 +- lib/rules/no-undef-init.js | 2 +- lib/rules/no-undef.js | 2 +- lib/rules/no-undefined.js | 2 +- lib/rules/no-underscore-dangle.js | 2 +- lib/rules/no-unexpected-multiline.js | 2 +- lib/rules/no-unmodified-loop-condition.js | 2 +- lib/rules/no-unneeded-ternary.js | 2 +- lib/rules/no-unreachable-loop.js | 2 +- lib/rules/no-unreachable.js | 2 +- lib/rules/no-unsafe-finally.js | 2 +- lib/rules/no-unsafe-negation.js | 2 +- lib/rules/no-unsafe-optional-chaining.js | 2 +- lib/rules/no-unused-expressions.js | 2 +- lib/rules/no-unused-labels.js | 2 +- lib/rules/no-unused-private-class-members.js | 2 +- lib/rules/no-unused-vars.js | 2 +- lib/rules/no-use-before-define.js | 2 +- lib/rules/no-useless-backreference.js | 2 +- lib/rules/no-useless-call.js | 2 +- lib/rules/no-useless-catch.js | 2 +- lib/rules/no-useless-computed-key.js | 2 +- lib/rules/no-useless-concat.js | 2 +- lib/rules/no-useless-constructor.js | 2 +- lib/rules/no-useless-escape.js | 2 +- lib/rules/no-useless-rename.js | 2 +- lib/rules/no-useless-return.js | 2 +- lib/rules/no-var.js | 2 +- lib/rules/no-void.js | 2 +- lib/rules/no-warning-comments.js | 2 +- lib/rules/no-whitespace-before-property.js | 2 +- lib/rules/no-with.js | 2 +- lib/rules/nonblock-statement-body-position.js | 2 +- lib/rules/object-curly-newline.js | 2 +- lib/rules/object-curly-spacing.js | 2 +- lib/rules/object-property-newline.js | 2 +- lib/rules/object-shorthand.js | 2 +- lib/rules/one-var-declaration-per-line.js | 2 +- lib/rules/one-var.js | 2 +- lib/rules/operator-assignment.js | 2 +- lib/rules/operator-linebreak.js | 2 +- lib/rules/padded-blocks.js | 2 +- lib/rules/padding-line-between-statements.js | 2 +- lib/rules/prefer-arrow-callback.js | 2 +- lib/rules/prefer-const.js | 2 +- lib/rules/prefer-destructuring.js | 2 +- lib/rules/prefer-exponentiation-operator.js | 2 +- lib/rules/prefer-named-capture-group.js | 2 +- lib/rules/prefer-numeric-literals.js | 2 +- lib/rules/prefer-object-has-own.js | 2 +- lib/rules/prefer-object-spread.js | 2 +- lib/rules/prefer-promise-reject-errors.js | 2 +- lib/rules/prefer-reflect.js | 2 +- lib/rules/prefer-regex-literals.js | 2 +- lib/rules/prefer-rest-params.js | 2 +- lib/rules/prefer-spread.js | 2 +- lib/rules/prefer-template.js | 2 +- lib/rules/quote-props.js | 2 +- lib/rules/quotes.js | 2 +- lib/rules/radix.js | 2 +- lib/rules/require-atomic-updates.js | 2 +- lib/rules/require-await.js | 2 +- lib/rules/require-jsdoc.js | 2 +- lib/rules/require-unicode-regexp.js | 2 +- lib/rules/require-yield.js | 2 +- lib/rules/rest-spread-spacing.js | 2 +- lib/rules/semi-spacing.js | 2 +- lib/rules/semi-style.js | 2 +- lib/rules/semi.js | 2 +- lib/rules/sort-imports.js | 2 +- lib/rules/sort-keys.js | 2 +- lib/rules/sort-vars.js | 2 +- lib/rules/space-before-blocks.js | 2 +- lib/rules/space-before-function-paren.js | 2 +- lib/rules/space-in-parens.js | 2 +- lib/rules/space-infix-ops.js | 2 +- lib/rules/space-unary-ops.js | 2 +- lib/rules/spaced-comment.js | 2 +- lib/rules/strict.js | 2 +- lib/rules/switch-colon-spacing.js | 2 +- lib/rules/symbol-description.js | 2 +- lib/rules/template-curly-spacing.js | 2 +- lib/rules/template-tag-spacing.js | 2 +- lib/rules/unicode-bom.js | 2 +- lib/rules/use-isnan.js | 2 +- lib/rules/valid-jsdoc.js | 2 +- lib/rules/valid-typeof.js | 2 +- lib/rules/vars-on-top.js | 2 +- lib/rules/wrap-iife.js | 2 +- lib/rules/wrap-regex.js | 2 +- lib/rules/yield-star-spacing.js | 2 +- lib/rules/yoda.js | 2 +- tools/internal-rules/no-invalid-meta.js | 2 +- 576 files changed, 832 insertions(+), 1280 deletions(-) diff --git a/.eslintrc.js b/.eslintrc.js index 4df24ee7349..4a5fdc5aeb6 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -82,7 +82,7 @@ module.exports = { "eslint-plugin/prefer-placeholders": "error", "eslint-plugin/prefer-replace-text": "error", "eslint-plugin/report-message-format": ["error", "[^a-z].*\\.$"], - "eslint-plugin/require-meta-docs-description": "error", + "eslint-plugin/require-meta-docs-description": ["error", { pattern: "^(Enforce|Require|Disallow)" }], "internal-rules/no-invalid-meta": "error" } }, diff --git a/docs/src/_data/rules.json b/docs/src/_data/rules.json index 76430c547de..2e4676efc9a 100644 --- a/docs/src/_data/rules.json +++ b/docs/src/_data/rules.json @@ -7,399 +7,399 @@ "rules": [ { "name": "array-callback-return", - "description": "enforce `return` statements in callbacks of array methods", + "description": "Enforce `return` statements in callbacks of array methods", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "constructor-super", - "description": "require `super()` calls in constructors", + "description": "Require `super()` calls in constructors", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "for-direction", - "description": "enforce \"for\" loop update clause moving the counter in the right direction.", + "description": "Enforce \"for\" loop update clause moving the counter in the right direction.", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "getter-return", - "description": "enforce `return` statements in getters", + "description": "Enforce `return` statements in getters", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-async-promise-executor", - "description": "disallow using an async function as a Promise executor", + "description": "Disallow using an async function as a Promise executor", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-await-in-loop", - "description": "disallow `await` inside of loops", + "description": "Disallow `await` inside of loops", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-class-assign", - "description": "disallow reassigning class members", + "description": "Disallow reassigning class members", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-compare-neg-zero", - "description": "disallow comparing against -0", + "description": "Disallow comparing against -0", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-cond-assign", - "description": "disallow assignment operators in conditional expressions", + "description": "Disallow assignment operators in conditional expressions", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-const-assign", - "description": "disallow reassigning `const` variables", + "description": "Disallow reassigning `const` variables", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-constant-binary-expression", - "description": "disallow expressions where the operation doesn't affect the value", + "description": "Disallow expressions where the operation doesn't affect the value", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-constant-condition", - "description": "disallow constant expressions in conditions", + "description": "Disallow constant expressions in conditions", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-constructor-return", - "description": "disallow returning value from constructor", + "description": "Disallow returning value from constructor", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-control-regex", - "description": "disallow control characters in regular expressions", + "description": "Disallow control characters in regular expressions", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-debugger", - "description": "disallow the use of `debugger`", + "description": "Disallow the use of `debugger`", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-dupe-args", - "description": "disallow duplicate arguments in `function` definitions", + "description": "Disallow duplicate arguments in `function` definitions", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-dupe-class-members", - "description": "disallow duplicate class members", + "description": "Disallow duplicate class members", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-dupe-else-if", - "description": "disallow duplicate conditions in if-else-if chains", + "description": "Disallow duplicate conditions in if-else-if chains", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-dupe-keys", - "description": "disallow duplicate keys in object literals", + "description": "Disallow duplicate keys in object literals", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-duplicate-case", - "description": "disallow duplicate case labels", + "description": "Disallow duplicate case labels", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-duplicate-imports", - "description": "disallow duplicate module imports", + "description": "Disallow duplicate module imports", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-empty-character-class", - "description": "disallow empty character classes in regular expressions", + "description": "Disallow empty character classes in regular expressions", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-empty-pattern", - "description": "disallow empty destructuring patterns", + "description": "Disallow empty destructuring patterns", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-ex-assign", - "description": "disallow reassigning exceptions in `catch` clauses", + "description": "Disallow reassigning exceptions in `catch` clauses", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-fallthrough", - "description": "disallow fallthrough of `case` statements", + "description": "Disallow fallthrough of `case` statements", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-func-assign", - "description": "disallow reassigning `function` declarations", + "description": "Disallow reassigning `function` declarations", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-import-assign", - "description": "disallow assigning to imported bindings", + "description": "Disallow assigning to imported bindings", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-inner-declarations", - "description": "disallow variable or `function` declarations in nested blocks", + "description": "Disallow variable or `function` declarations in nested blocks", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-invalid-regexp", - "description": "disallow invalid regular expression strings in `RegExp` constructors", + "description": "Disallow invalid regular expression strings in `RegExp` constructors", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-irregular-whitespace", - "description": "disallow irregular whitespace", + "description": "Disallow irregular whitespace", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-loss-of-precision", - "description": "disallow literal numbers that lose precision", + "description": "Disallow literal numbers that lose precision", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-misleading-character-class", - "description": "disallow characters which are made with multiple code points in character class syntax", + "description": "Disallow characters which are made with multiple code points in character class syntax", "recommended": true, "fixable": false, "hasSuggestions": true }, { "name": "no-new-symbol", - "description": "disallow `new` operators with the `Symbol` object", + "description": "Disallow `new` operators with the `Symbol` object", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-obj-calls", - "description": "disallow calling global object properties as functions", + "description": "Disallow calling global object properties as functions", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-promise-executor-return", - "description": "disallow returning values from Promise executor functions", + "description": "Disallow returning values from Promise executor functions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-prototype-builtins", - "description": "disallow calling some `Object.prototype` methods directly on objects", + "description": "Disallow calling some `Object.prototype` methods directly on objects", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-self-assign", - "description": "disallow assignments where both sides are exactly the same", + "description": "Disallow assignments where both sides are exactly the same", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-self-compare", - "description": "disallow comparisons where both sides are exactly the same", + "description": "Disallow comparisons where both sides are exactly the same", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-setter-return", - "description": "disallow returning values from setters", + "description": "Disallow returning values from setters", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-sparse-arrays", - "description": "disallow sparse arrays", + "description": "Disallow sparse arrays", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-template-curly-in-string", - "description": "disallow template literal placeholder syntax in regular strings", + "description": "Disallow template literal placeholder syntax in regular strings", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-this-before-super", - "description": "disallow `this`/`super` before calling `super()` in constructors", + "description": "Disallow `this`/`super` before calling `super()` in constructors", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-undef", - "description": "disallow the use of undeclared variables unless mentioned in `/*global */` comments", + "description": "Disallow the use of undeclared variables unless mentioned in `/*global */` comments", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-unexpected-multiline", - "description": "disallow confusing multiline expressions", + "description": "Disallow confusing multiline expressions", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-unmodified-loop-condition", - "description": "disallow unmodified loop conditions", + "description": "Disallow unmodified loop conditions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-unreachable", - "description": "disallow unreachable code after `return`, `throw`, `continue`, and `break` statements", + "description": "Disallow unreachable code after `return`, `throw`, `continue`, and `break` statements", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-unreachable-loop", - "description": "disallow loops with a body that allows only one iteration", + "description": "Disallow loops with a body that allows only one iteration", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-unsafe-finally", - "description": "disallow control flow statements in `finally` blocks", + "description": "Disallow control flow statements in `finally` blocks", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-unsafe-negation", - "description": "disallow negating the left operand of relational operators", + "description": "Disallow negating the left operand of relational operators", "recommended": true, "fixable": false, "hasSuggestions": true }, { "name": "no-unsafe-optional-chaining", - "description": "disallow use of optional chaining in contexts where the `undefined` value is not allowed", + "description": "Disallow use of optional chaining in contexts where the `undefined` value is not allowed", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-unused-private-class-members", - "description": "disallow unused private class members", + "description": "Disallow unused private class members", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-unused-vars", - "description": "disallow unused variables", + "description": "Disallow unused variables", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-use-before-define", - "description": "disallow the use of variables before they are defined", + "description": "Disallow the use of variables before they are defined", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-useless-backreference", - "description": "disallow useless backreferences in regular expressions", + "description": "Disallow useless backreferences in regular expressions", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "require-atomic-updates", - "description": "disallow assignments that can lead to race conditions due to usage of `await` or `yield`", + "description": "Disallow assignments that can lead to race conditions due to usage of `await` or `yield`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "use-isnan", - "description": "require calls to `isNaN()` when checking for `NaN`", + "description": "Require calls to `isNaN()` when checking for `NaN`", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "valid-typeof", - "description": "enforce comparing `typeof` expressions against valid strings", + "description": "Enforce comparing `typeof` expressions against valid strings", "recommended": true, "fixable": false, "hasSuggestions": true @@ -413,875 +413,875 @@ "rules": [ { "name": "accessor-pairs", - "description": "enforce getter and setter pairs in objects and classes", + "description": "Enforce getter and setter pairs in objects and classes", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "arrow-body-style", - "description": "require braces around arrow function bodies", + "description": "Require braces around arrow function bodies", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "block-scoped-var", - "description": "enforce the use of variables within the scope they are defined", + "description": "Enforce the use of variables within the scope they are defined", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "camelcase", - "description": "enforce camelcase naming convention", + "description": "Enforce camelcase naming convention", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "capitalized-comments", - "description": "enforce or disallow capitalization of the first letter of a comment", + "description": "Enforce or disallow capitalization of the first letter of a comment", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "class-methods-use-this", - "description": "enforce that class methods utilize `this`", + "description": "Enforce that class methods utilize `this`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "complexity", - "description": "enforce a maximum cyclomatic complexity allowed in a program", + "description": "Enforce a maximum cyclomatic complexity allowed in a program", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "consistent-return", - "description": "require `return` statements to either always or never specify values", + "description": "Require `return` statements to either always or never specify values", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "consistent-this", - "description": "enforce consistent naming when capturing the current execution context", + "description": "Enforce consistent naming when capturing the current execution context", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "curly", - "description": "enforce consistent brace style for all control statements", + "description": "Enforce consistent brace style for all control statements", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "default-case", - "description": "require `default` cases in `switch` statements", + "description": "Require `default` cases in `switch` statements", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "default-case-last", - "description": "enforce default clauses in switch statements to be last", + "description": "Enforce default clauses in switch statements to be last", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "default-param-last", - "description": "enforce default parameters to be last", + "description": "Enforce default parameters to be last", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "dot-notation", - "description": "enforce dot notation whenever possible", + "description": "Enforce dot notation whenever possible", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "eqeqeq", - "description": "require the use of `===` and `!==`", + "description": "Require the use of `===` and `!==`", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "func-name-matching", - "description": "require function names to match the name of the variable or property to which they are assigned", + "description": "Require function names to match the name of the variable or property to which they are assigned", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "func-names", - "description": "require or disallow named `function` expressions", + "description": "Require or disallow named `function` expressions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "func-style", - "description": "enforce the consistent use of either `function` declarations or expressions", + "description": "Enforce the consistent use of either `function` declarations or expressions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "grouped-accessor-pairs", - "description": "require grouped accessor pairs in object literals and classes", + "description": "Require grouped accessor pairs in object literals and classes", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "guard-for-in", - "description": "require `for-in` loops to include an `if` statement", + "description": "Require `for-in` loops to include an `if` statement", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "id-denylist", - "description": "disallow specified identifiers", + "description": "Disallow specified identifiers", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "id-length", - "description": "enforce minimum and maximum identifier lengths", + "description": "Enforce minimum and maximum identifier lengths", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "id-match", - "description": "require identifiers to match a specified regular expression", + "description": "Require identifiers to match a specified regular expression", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "init-declarations", - "description": "require or disallow initialization in variable declarations", + "description": "Require or disallow initialization in variable declarations", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "max-classes-per-file", - "description": "enforce a maximum number of classes per file", + "description": "Enforce a maximum number of classes per file", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "max-depth", - "description": "enforce a maximum depth that blocks can be nested", + "description": "Enforce a maximum depth that blocks can be nested", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "max-lines", - "description": "enforce a maximum number of lines per file", + "description": "Enforce a maximum number of lines per file", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "max-lines-per-function", - "description": "enforce a maximum number of lines of code in a function", + "description": "Enforce a maximum number of lines of code in a function", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "max-nested-callbacks", - "description": "enforce a maximum depth that callbacks can be nested", + "description": "Enforce a maximum depth that callbacks can be nested", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "max-params", - "description": "enforce a maximum number of parameters in function definitions", + "description": "Enforce a maximum number of parameters in function definitions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "max-statements", - "description": "enforce a maximum number of statements allowed in function blocks", + "description": "Enforce a maximum number of statements allowed in function blocks", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "multiline-comment-style", - "description": "enforce a particular style for multiline comments", + "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", + "description": "Require constructor names to begin with a capital letter", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-alert", - "description": "disallow the use of `alert`, `confirm`, and `prompt`", + "description": "Disallow the use of `alert`, `confirm`, and `prompt`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-array-constructor", - "description": "disallow `Array` constructors", + "description": "Disallow `Array` constructors", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-bitwise", - "description": "disallow bitwise operators", + "description": "Disallow bitwise operators", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-caller", - "description": "disallow the use of `arguments.caller` or `arguments.callee`", + "description": "Disallow the use of `arguments.caller` or `arguments.callee`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-case-declarations", - "description": "disallow lexical declarations in case clauses", + "description": "Disallow lexical declarations in case clauses", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-confusing-arrow", - "description": "disallow arrow functions where they could be confused with comparisons", + "description": "Disallow arrow functions where they could be confused with comparisons", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-console", - "description": "disallow the use of `console`", + "description": "Disallow the use of `console`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-continue", - "description": "disallow `continue` statements", + "description": "Disallow `continue` statements", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-delete-var", - "description": "disallow deleting variables", + "description": "Disallow deleting variables", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-div-regex", - "description": "disallow division operators explicitly at the beginning of regular expressions", + "description": "Disallow division operators explicitly at the beginning of regular expressions", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-else-return", - "description": "disallow `else` blocks after `return` statements in `if` statements", + "description": "Disallow `else` blocks after `return` statements in `if` statements", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-empty", - "description": "disallow empty block statements", + "description": "Disallow empty block statements", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-empty-function", - "description": "disallow empty functions", + "description": "Disallow empty functions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-eq-null", - "description": "disallow `null` comparisons without type-checking operators", + "description": "Disallow `null` comparisons without type-checking operators", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-eval", - "description": "disallow the use of `eval()`", + "description": "Disallow the use of `eval()`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-extend-native", - "description": "disallow extending native types", + "description": "Disallow extending native types", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-extra-bind", - "description": "disallow unnecessary calls to `.bind()`", + "description": "Disallow unnecessary calls to `.bind()`", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-extra-boolean-cast", - "description": "disallow unnecessary boolean casts", + "description": "Disallow unnecessary boolean casts", "recommended": true, "fixable": true, "hasSuggestions": false }, { "name": "no-extra-label", - "description": "disallow unnecessary labels", + "description": "Disallow unnecessary labels", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-extra-semi", - "description": "disallow unnecessary semicolons", + "description": "Disallow unnecessary semicolons", "recommended": true, "fixable": true, "hasSuggestions": false }, { "name": "no-floating-decimal", - "description": "disallow leading or trailing decimal points in numeric literals", + "description": "Disallow leading or trailing decimal points in numeric literals", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-global-assign", - "description": "disallow assignments to native objects or read-only global variables", + "description": "Disallow assignments to native objects or read-only global variables", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-implicit-coercion", - "description": "disallow shorthand type conversions", + "description": "Disallow shorthand type conversions", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-implicit-globals", - "description": "disallow declarations in the global scope", + "description": "Disallow declarations in the global scope", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-implied-eval", - "description": "disallow the use of `eval()`-like methods", + "description": "Disallow the use of `eval()`-like methods", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-inline-comments", - "description": "disallow inline comments after code", + "description": "Disallow inline comments after code", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-invalid-this", - "description": "disallow use of `this` in contexts where the value of `this` is `undefined`", + "description": "Disallow use of `this` in contexts where the value of `this` is `undefined`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-iterator", - "description": "disallow the use of the `__iterator__` property", + "description": "Disallow the use of the `__iterator__` property", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-label-var", - "description": "disallow labels that share a name with a variable", + "description": "Disallow labels that share a name with a variable", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-labels", - "description": "disallow labeled statements", + "description": "Disallow labeled statements", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-lone-blocks", - "description": "disallow unnecessary nested blocks", + "description": "Disallow unnecessary nested blocks", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-lonely-if", - "description": "disallow `if` statements as the only statement in `else` blocks", + "description": "Disallow `if` statements as the only statement in `else` blocks", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-loop-func", - "description": "disallow function declarations that contain unsafe references inside loop statements", + "description": "Disallow function declarations that contain unsafe references inside loop statements", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-magic-numbers", - "description": "disallow magic numbers", + "description": "Disallow magic numbers", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-mixed-operators", - "description": "disallow mixed binary operators", + "description": "Disallow mixed binary operators", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-multi-assign", - "description": "disallow use of chained assignment expressions", + "description": "Disallow use of chained assignment expressions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-multi-str", - "description": "disallow multiline strings", + "description": "Disallow multiline strings", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-negated-condition", - "description": "disallow negated conditions", + "description": "Disallow negated conditions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-nested-ternary", - "description": "disallow nested ternary expressions", + "description": "Disallow nested ternary expressions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-new", - "description": "disallow `new` operators outside of assignments or comparisons", + "description": "Disallow `new` operators outside of assignments or comparisons", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-new-func", - "description": "disallow `new` operators with the `Function` object", + "description": "Disallow `new` operators with the `Function` object", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-new-object", - "description": "disallow `Object` constructors", + "description": "Disallow `Object` constructors", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-new-wrappers", - "description": "disallow `new` operators with the `String`, `Number`, and `Boolean` objects", + "description": "Disallow `new` operators with the `String`, `Number`, and `Boolean` objects", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-nonoctal-decimal-escape", - "description": "disallow `\\8` and `\\9` escape sequences in string literals", + "description": "Disallow `\\8` and `\\9` escape sequences in string literals", "recommended": true, "fixable": false, "hasSuggestions": true }, { "name": "no-octal", - "description": "disallow octal literals", + "description": "Disallow octal literals", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-octal-escape", - "description": "disallow octal escape sequences in string literals", + "description": "Disallow octal escape sequences in string literals", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-param-reassign", - "description": "disallow reassigning `function` parameters", + "description": "Disallow reassigning `function` parameters", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-plusplus", - "description": "disallow the unary operators `++` and `--`", + "description": "Disallow the unary operators `++` and `--`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-proto", - "description": "disallow the use of the `__proto__` property", + "description": "Disallow the use of the `__proto__` property", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-redeclare", - "description": "disallow variable redeclaration", + "description": "Disallow variable redeclaration", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-regex-spaces", - "description": "disallow multiple spaces in regular expressions", + "description": "Disallow multiple spaces in regular expressions", "recommended": true, "fixable": true, "hasSuggestions": false }, { "name": "no-restricted-exports", - "description": "disallow specified names in exports", + "description": "Disallow specified names in exports", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-restricted-globals", - "description": "disallow specified global variables", + "description": "Disallow specified global variables", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-restricted-imports", - "description": "disallow specified modules when loaded by `import`", + "description": "Disallow specified modules when loaded by `import`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-restricted-properties", - "description": "disallow certain properties on certain objects", + "description": "Disallow certain properties on certain objects", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-restricted-syntax", - "description": "disallow specified syntax", + "description": "Disallow specified syntax", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-return-assign", - "description": "disallow assignment operators in `return` statements", + "description": "Disallow assignment operators in `return` statements", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-return-await", - "description": "disallow unnecessary `return await`", + "description": "Disallow unnecessary `return await`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-script-url", - "description": "disallow `javascript:` urls", + "description": "Disallow `javascript:` urls", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-sequences", - "description": "disallow comma operators", + "description": "Disallow comma operators", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-shadow", - "description": "disallow variable declarations from shadowing variables declared in the outer scope", + "description": "Disallow variable declarations from shadowing variables declared in the outer scope", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-shadow-restricted-names", - "description": "disallow identifiers from shadowing restricted names", + "description": "Disallow identifiers from shadowing restricted names", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-ternary", - "description": "disallow ternary operators", + "description": "Disallow ternary operators", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-throw-literal", - "description": "disallow throwing literals as exceptions", + "description": "Disallow throwing literals as exceptions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-undef-init", - "description": "disallow initializing variables to `undefined`", + "description": "Disallow initializing variables to `undefined`", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-undefined", - "description": "disallow the use of `undefined` as an identifier", + "description": "Disallow the use of `undefined` as an identifier", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-underscore-dangle", - "description": "disallow dangling underscores in identifiers", + "description": "Disallow dangling underscores in identifiers", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-unneeded-ternary", - "description": "disallow ternary operators when simpler alternatives exist", + "description": "Disallow ternary operators when simpler alternatives exist", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-unused-expressions", - "description": "disallow unused expressions", + "description": "Disallow unused expressions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-unused-labels", - "description": "disallow unused labels", + "description": "Disallow unused labels", "recommended": true, "fixable": true, "hasSuggestions": false }, { "name": "no-useless-call", - "description": "disallow unnecessary calls to `.call()` and `.apply()`", + "description": "Disallow unnecessary calls to `.call()` and `.apply()`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-useless-catch", - "description": "disallow unnecessary `catch` clauses", + "description": "Disallow unnecessary `catch` clauses", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-useless-computed-key", - "description": "disallow unnecessary computed property keys in objects and classes", + "description": "Disallow unnecessary computed property keys in objects and classes", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-useless-concat", - "description": "disallow unnecessary concatenation of literals or template literals", + "description": "Disallow unnecessary concatenation of literals or template literals", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-useless-constructor", - "description": "disallow unnecessary constructors", + "description": "Disallow unnecessary constructors", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-useless-escape", - "description": "disallow unnecessary escape characters", + "description": "Disallow unnecessary escape characters", "recommended": true, "fixable": false, "hasSuggestions": true }, { "name": "no-useless-rename", - "description": "disallow renaming import, export, and destructured assignments to the same name", + "description": "Disallow renaming import, export, and destructured assignments to the same name", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-useless-return", - "description": "disallow redundant return statements", + "description": "Disallow redundant return statements", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-var", - "description": "require `let` or `const` instead of `var`", + "description": "Require `let` or `const` instead of `var`", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-void", - "description": "disallow `void` operators", + "description": "Disallow `void` operators", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-warning-comments", - "description": "disallow specified warning terms in comments", + "description": "Disallow specified warning terms in comments", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-with", - "description": "disallow `with` statements", + "description": "Disallow `with` statements", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "object-shorthand", - "description": "require or disallow method and property shorthand syntax for object literals", + "description": "Require or disallow method and property shorthand syntax for object literals", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "one-var", - "description": "enforce variables to be declared either together or separately in functions", + "description": "Enforce variables to be declared either together or separately in functions", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "one-var-declaration-per-line", - "description": "require or disallow newlines around variable declarations", + "description": "Require or disallow newlines around variable declarations", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "operator-assignment", - "description": "require or disallow assignment operator shorthand where possible", + "description": "Require or disallow assignment operator shorthand where possible", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "prefer-arrow-callback", - "description": "require using arrow functions for callbacks", + "description": "Require using arrow functions for callbacks", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "prefer-const", - "description": "require `const` declarations for variables that are never reassigned after declared", + "description": "Require `const` declarations for variables that are never reassigned after declared", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "prefer-destructuring", - "description": "require destructuring from arrays and/or objects", + "description": "Require destructuring from arrays and/or objects", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "prefer-exponentiation-operator", - "description": "disallow the use of `Math.pow` in favor of the `**` operator", + "description": "Disallow the use of `Math.pow` in favor of the `**` operator", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "prefer-named-capture-group", - "description": "enforce using named capture group in regular expression", + "description": "Enforce using named capture group in regular expression", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "prefer-numeric-literals", - "description": "disallow `parseInt()` and `Number.parseInt()` in favor of binary, octal, and hexadecimal literals", + "description": "Disallow `parseInt()` and `Number.parseInt()` in favor of binary, octal, and hexadecimal literals", "recommended": false, "fixable": true, "hasSuggestions": false @@ -1302,126 +1302,126 @@ }, { "name": "prefer-promise-reject-errors", - "description": "require using Error objects as Promise rejection reasons", + "description": "Require using Error objects as Promise rejection reasons", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "prefer-regex-literals", - "description": "disallow use of the `RegExp` constructor in favor of regular expression literals", + "description": "Disallow use of the `RegExp` constructor in favor of regular expression literals", "recommended": false, "fixable": false, "hasSuggestions": true }, { "name": "prefer-rest-params", - "description": "require rest parameters instead of `arguments`", + "description": "Require rest parameters instead of `arguments`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "prefer-spread", - "description": "require spread operators instead of `.apply()`", + "description": "Require spread operators instead of `.apply()`", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "prefer-template", - "description": "require template literals instead of string concatenation", + "description": "Require template literals instead of string concatenation", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "quote-props", - "description": "require quotes around object literal property names", + "description": "Require quotes around object literal property names", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "radix", - "description": "enforce the consistent use of the radix argument when using `parseInt()`", + "description": "Enforce the consistent use of the radix argument when using `parseInt()`", "recommended": false, "fixable": false, "hasSuggestions": true }, { "name": "require-await", - "description": "disallow async functions which have no `await` expression", + "description": "Disallow async functions which have no `await` expression", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "require-unicode-regexp", - "description": "enforce the use of `u` flag on RegExp", + "description": "Enforce the use of `u` flag on RegExp", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "require-yield", - "description": "require generator functions to contain `yield`", + "description": "Require generator functions to contain `yield`", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "sort-imports", - "description": "enforce sorted import declarations within modules", + "description": "Enforce sorted import declarations within modules", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "sort-keys", - "description": "require object keys to be sorted", + "description": "Require object keys to be sorted", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "sort-vars", - "description": "require variables within the same declaration block to be sorted", + "description": "Require variables within the same declaration block to be sorted", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "spaced-comment", - "description": "enforce consistent spacing after the `//` or `/*` in a comment", + "description": "Enforce consistent spacing after the `//` or `/*` in a comment", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "strict", - "description": "require or disallow strict mode directives", + "description": "Require or disallow strict mode directives", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "symbol-description", - "description": "require symbol descriptions", + "description": "Require symbol descriptions", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "vars-on-top", - "description": "require `var` declarations be placed at the top of their containing scope", + "description": "Require `var` declarations be placed at the top of their containing scope", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "yoda", - "description": "require or disallow \"Yoda\" conditions", + "description": "Require or disallow \"Yoda\" conditions", "recommended": false, "fixable": true, "hasSuggestions": false @@ -1435,133 +1435,133 @@ "rules": [ { "name": "array-bracket-newline", - "description": "enforce linebreaks after opening and before closing array brackets", + "description": "Enforce linebreaks after opening and before closing array brackets", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "array-bracket-spacing", - "description": "enforce consistent spacing inside array brackets", + "description": "Enforce consistent spacing inside array brackets", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "array-element-newline", - "description": "enforce line breaks after each array element", + "description": "Enforce line breaks after each array element", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "arrow-parens", - "description": "require parentheses around arrow function arguments", + "description": "Require parentheses around arrow function arguments", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "arrow-spacing", - "description": "enforce consistent spacing before and after the arrow in arrow functions", + "description": "Enforce consistent spacing before and after the arrow in arrow functions", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "block-spacing", - "description": "disallow or enforce spaces inside of blocks after opening block and before closing block", + "description": "Disallow or enforce spaces inside of blocks after opening block and before closing block", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "brace-style", - "description": "enforce consistent brace style for blocks", + "description": "Enforce consistent brace style for blocks", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "comma-dangle", - "description": "require or disallow trailing commas", + "description": "Require or disallow trailing commas", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "comma-spacing", - "description": "enforce consistent spacing before and after commas", + "description": "Enforce consistent spacing before and after commas", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "comma-style", - "description": "enforce consistent comma style", + "description": "Enforce consistent comma style", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "computed-property-spacing", - "description": "enforce consistent spacing inside computed property brackets", + "description": "Enforce consistent spacing inside computed property brackets", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "dot-location", - "description": "enforce consistent newlines before and after dots", + "description": "Enforce consistent newlines before and after dots", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "eol-last", - "description": "require or disallow newline at the end of files", + "description": "Require or disallow newline at the end of files", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "func-call-spacing", - "description": "require or disallow spacing between function identifiers and their invocations", + "description": "Require or disallow spacing between function identifiers and their invocations", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "function-call-argument-newline", - "description": "enforce line breaks between arguments of a function call", + "description": "Enforce line breaks between arguments of a function call", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "function-paren-newline", - "description": "enforce consistent line breaks inside function parentheses", + "description": "Enforce consistent line breaks inside function parentheses", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "generator-star-spacing", - "description": "enforce consistent spacing around `*` operators in generator functions", + "description": "Enforce consistent spacing around `*` operators in generator functions", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "implicit-arrow-linebreak", - "description": "enforce the location of arrow function bodies", + "description": "Enforce the location of arrow function bodies", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "indent", - "description": "enforce consistent indentation", + "description": "Enforce consistent indentation", "recommended": false, "fixable": true, "hasSuggestions": false @@ -1575,175 +1575,175 @@ }, { "name": "key-spacing", - "description": "enforce consistent spacing between keys and values in object literal properties", + "description": "Enforce consistent spacing between keys and values in object literal properties", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "keyword-spacing", - "description": "enforce consistent spacing before and after keywords", + "description": "Enforce consistent spacing before and after keywords", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "line-comment-position", - "description": "enforce position of line comments", + "description": "Enforce position of line comments", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "linebreak-style", - "description": "enforce consistent linebreak style", + "description": "Enforce consistent linebreak style", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "lines-around-comment", - "description": "require empty lines around comments", + "description": "Require empty lines around comments", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "lines-between-class-members", - "description": "require or disallow an empty line between class members", + "description": "Require or disallow an empty line between class members", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "max-len", - "description": "enforce a maximum line length", + "description": "Enforce a maximum line length", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "max-statements-per-line", - "description": "enforce a maximum number of statements allowed per line", + "description": "Enforce a maximum number of statements allowed per line", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "multiline-ternary", - "description": "enforce newlines between operands of ternary expressions", + "description": "Enforce newlines between operands of ternary expressions", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "new-parens", - "description": "enforce or disallow parentheses when invoking a constructor with no arguments", + "description": "Enforce or disallow parentheses when invoking a constructor with no arguments", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "newline-per-chained-call", - "description": "require a newline after each call in a method chain", + "description": "Require a newline after each call in a method chain", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-extra-parens", - "description": "disallow unnecessary parentheses", + "description": "Disallow unnecessary parentheses", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-mixed-spaces-and-tabs", - "description": "disallow mixed spaces and tabs for indentation", + "description": "Disallow mixed spaces and tabs for indentation", "recommended": true, "fixable": false, "hasSuggestions": false }, { "name": "no-multi-spaces", - "description": "disallow multiple spaces", + "description": "Disallow multiple spaces", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-multiple-empty-lines", - "description": "disallow multiple empty lines", + "description": "Disallow multiple empty lines", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-tabs", - "description": "disallow all tabs", + "description": "Disallow all tabs", "recommended": false, "fixable": false, "hasSuggestions": false }, { "name": "no-trailing-spaces", - "description": "disallow trailing whitespace at the end of lines", + "description": "Disallow trailing whitespace at the end of lines", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "no-whitespace-before-property", - "description": "disallow whitespace before properties", + "description": "Disallow whitespace before properties", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "nonblock-statement-body-position", - "description": "enforce the location of single-line statements", + "description": "Enforce the location of single-line statements", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "object-curly-newline", - "description": "enforce consistent line breaks after opening and before closing braces", + "description": "Enforce consistent line breaks after opening and before closing braces", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "object-curly-spacing", - "description": "enforce consistent spacing inside braces", + "description": "Enforce consistent spacing inside braces", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "object-property-newline", - "description": "enforce placing object properties on separate lines", + "description": "Enforce placing object properties on separate lines", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "operator-linebreak", - "description": "enforce consistent linebreak style for operators", + "description": "Enforce consistent linebreak style for operators", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "padded-blocks", - "description": "require or disallow padding within blocks", + "description": "Require or disallow padding within blocks", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "padding-line-between-statements", - "description": "require or disallow padding lines between statements", + "description": "Require or disallow padding lines between statements", "recommended": false, "fixable": true, "hasSuggestions": false @@ -1757,112 +1757,112 @@ }, { "name": "rest-spread-spacing", - "description": "enforce spacing between rest and spread operators and their expressions", + "description": "Enforce spacing between rest and spread operators and their expressions", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "semi", - "description": "require or disallow semicolons instead of ASI", + "description": "Require or disallow semicolons instead of ASI", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "semi-spacing", - "description": "enforce consistent spacing before and after semicolons", + "description": "Enforce consistent spacing before and after semicolons", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "semi-style", - "description": "enforce location of semicolons", + "description": "Enforce location of semicolons", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "space-before-blocks", - "description": "enforce consistent spacing before blocks", + "description": "Enforce consistent spacing before blocks", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "space-before-function-paren", - "description": "enforce consistent spacing before `function` definition opening parenthesis", + "description": "Enforce consistent spacing before `function` definition opening parenthesis", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "space-in-parens", - "description": "enforce consistent spacing inside parentheses", + "description": "Enforce consistent spacing inside parentheses", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "space-infix-ops", - "description": "require spacing around infix operators", + "description": "Require spacing around infix operators", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "space-unary-ops", - "description": "enforce consistent spacing before or after unary operators", + "description": "Enforce consistent spacing before or after unary operators", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "switch-colon-spacing", - "description": "enforce spacing around colons of switch statements", + "description": "Enforce spacing around colons of switch statements", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "template-curly-spacing", - "description": "require or disallow spacing around embedded expressions of template strings", + "description": "Require or disallow spacing around embedded expressions of template strings", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "template-tag-spacing", - "description": "require or disallow spacing between template tags and their literals", + "description": "Require or disallow spacing between template tags and their literals", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "unicode-bom", - "description": "require or disallow Unicode byte order mark (BOM)", + "description": "Require or disallow Unicode byte order mark (BOM)", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "wrap-iife", - "description": "require parentheses around immediate `function` invocations", + "description": "Require parentheses around immediate `function` invocations", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "wrap-regex", - "description": "require parenthesis around regex literals", + "description": "Require parenthesis around regex literals", "recommended": false, "fixable": true, "hasSuggestions": false }, { "name": "yield-star-spacing", - "description": "require or disallow spacing around the `*` in `yield*` expressions", + "description": "Require or disallow spacing around the `*` in `yield*` expressions", "recommended": false, "fixable": true, "hasSuggestions": false diff --git a/docs/src/_data/rules_meta.json b/docs/src/_data/rules_meta.json index 7984e561278..ee7ebd64cc8 100644 --- a/docs/src/_data/rules_meta.json +++ b/docs/src/_data/rules_meta.json @@ -2,7 +2,7 @@ "accessor-pairs": { "type": "suggestion", "docs": { - "description": "enforce getter and setter pairs in objects and classes", + "description": "Enforce getter and setter pairs in objects and classes", "recommended": false, "url": "https://eslint.org/docs/rules/accessor-pairs" } @@ -10,7 +10,7 @@ "array-bracket-newline": { "type": "layout", "docs": { - "description": "enforce linebreaks after opening and before closing array brackets", + "description": "Enforce linebreaks after opening and before closing array brackets", "recommended": false, "url": "https://eslint.org/docs/rules/array-bracket-newline" }, @@ -19,7 +19,7 @@ "array-bracket-spacing": { "type": "layout", "docs": { - "description": "enforce consistent spacing inside array brackets", + "description": "Enforce consistent spacing inside array brackets", "recommended": false, "url": "https://eslint.org/docs/rules/array-bracket-spacing" }, @@ -28,7 +28,7 @@ "array-callback-return": { "type": "problem", "docs": { - "description": "enforce `return` statements in callbacks of array methods", + "description": "Enforce `return` statements in callbacks of array methods", "recommended": false, "url": "https://eslint.org/docs/rules/array-callback-return" } @@ -36,7 +36,7 @@ "array-element-newline": { "type": "layout", "docs": { - "description": "enforce line breaks after each array element", + "description": "Enforce line breaks after each array element", "recommended": false, "url": "https://eslint.org/docs/rules/array-element-newline" }, @@ -45,7 +45,7 @@ "arrow-body-style": { "type": "suggestion", "docs": { - "description": "require braces around arrow function bodies", + "description": "Require braces around arrow function bodies", "recommended": false, "url": "https://eslint.org/docs/rules/arrow-body-style" }, @@ -54,7 +54,7 @@ "arrow-parens": { "type": "layout", "docs": { - "description": "require parentheses around arrow function arguments", + "description": "Require parentheses around arrow function arguments", "recommended": false, "url": "https://eslint.org/docs/rules/arrow-parens" }, @@ -63,7 +63,7 @@ "arrow-spacing": { "type": "layout", "docs": { - "description": "enforce consistent spacing before and after the arrow in arrow functions", + "description": "Enforce consistent spacing before and after the arrow in arrow functions", "recommended": false, "url": "https://eslint.org/docs/rules/arrow-spacing" }, @@ -72,7 +72,7 @@ "block-scoped-var": { "type": "suggestion", "docs": { - "description": "enforce the use of variables within the scope they are defined", + "description": "Enforce the use of variables within the scope they are defined", "recommended": false, "url": "https://eslint.org/docs/rules/block-scoped-var" } @@ -80,7 +80,7 @@ "block-spacing": { "type": "layout", "docs": { - "description": "disallow or enforce spaces inside of blocks after opening block and before closing block", + "description": "Disallow or enforce spaces inside of blocks after opening block and before closing block", "recommended": false, "url": "https://eslint.org/docs/rules/block-spacing" }, @@ -89,7 +89,7 @@ "brace-style": { "type": "layout", "docs": { - "description": "enforce consistent brace style for blocks", + "description": "Enforce consistent brace style for blocks", "recommended": false, "url": "https://eslint.org/docs/rules/brace-style" }, @@ -100,7 +100,7 @@ "replacedBy": [], "type": "suggestion", "docs": { - "description": "require `return` statements after callbacks", + "description": "Require `return` statements after callbacks", "recommended": false, "url": "https://eslint.org/docs/rules/callback-return" } @@ -108,7 +108,7 @@ "camelcase": { "type": "suggestion", "docs": { - "description": "enforce camelcase naming convention", + "description": "Enforce camelcase naming convention", "recommended": false, "url": "https://eslint.org/docs/rules/camelcase" } @@ -116,7 +116,7 @@ "capitalized-comments": { "type": "suggestion", "docs": { - "description": "enforce or disallow capitalization of the first letter of a comment", + "description": "Enforce or disallow capitalization of the first letter of a comment", "recommended": false, "url": "https://eslint.org/docs/rules/capitalized-comments" }, @@ -125,7 +125,7 @@ "class-methods-use-this": { "type": "suggestion", "docs": { - "description": "enforce that class methods utilize `this`", + "description": "Enforce that class methods utilize `this`", "recommended": false, "url": "https://eslint.org/docs/rules/class-methods-use-this" } @@ -133,7 +133,7 @@ "comma-dangle": { "type": "layout", "docs": { - "description": "require or disallow trailing commas", + "description": "Require or disallow trailing commas", "recommended": false, "url": "https://eslint.org/docs/rules/comma-dangle" }, @@ -142,7 +142,7 @@ "comma-spacing": { "type": "layout", "docs": { - "description": "enforce consistent spacing before and after commas", + "description": "Enforce consistent spacing before and after commas", "recommended": false, "url": "https://eslint.org/docs/rules/comma-spacing" }, @@ -151,7 +151,7 @@ "comma-style": { "type": "layout", "docs": { - "description": "enforce consistent comma style", + "description": "Enforce consistent comma style", "recommended": false, "url": "https://eslint.org/docs/rules/comma-style" }, @@ -160,7 +160,7 @@ "complexity": { "type": "suggestion", "docs": { - "description": "enforce a maximum cyclomatic complexity allowed in a program", + "description": "Enforce a maximum cyclomatic complexity allowed in a program", "recommended": false, "url": "https://eslint.org/docs/rules/complexity" } @@ -168,7 +168,7 @@ "computed-property-spacing": { "type": "layout", "docs": { - "description": "enforce consistent spacing inside computed property brackets", + "description": "Enforce consistent spacing inside computed property brackets", "recommended": false, "url": "https://eslint.org/docs/rules/computed-property-spacing" }, @@ -177,7 +177,7 @@ "consistent-return": { "type": "suggestion", "docs": { - "description": "require `return` statements to either always or never specify values", + "description": "Require `return` statements to either always or never specify values", "recommended": false, "url": "https://eslint.org/docs/rules/consistent-return" } @@ -185,7 +185,7 @@ "consistent-this": { "type": "suggestion", "docs": { - "description": "enforce consistent naming when capturing the current execution context", + "description": "Enforce consistent naming when capturing the current execution context", "recommended": false, "url": "https://eslint.org/docs/rules/consistent-this" } @@ -193,7 +193,7 @@ "constructor-super": { "type": "problem", "docs": { - "description": "require `super()` calls in constructors", + "description": "Require `super()` calls in constructors", "recommended": true, "url": "https://eslint.org/docs/rules/constructor-super" } @@ -201,7 +201,7 @@ "curly": { "type": "suggestion", "docs": { - "description": "enforce consistent brace style for all control statements", + "description": "Enforce consistent brace style for all control statements", "recommended": false, "url": "https://eslint.org/docs/rules/curly" }, @@ -210,7 +210,7 @@ "default-case": { "type": "suggestion", "docs": { - "description": "require `default` cases in `switch` statements", + "description": "Require `default` cases in `switch` statements", "recommended": false, "url": "https://eslint.org/docs/rules/default-case" } @@ -218,7 +218,7 @@ "default-case-last": { "type": "suggestion", "docs": { - "description": "enforce default clauses in switch statements to be last", + "description": "Enforce default clauses in switch statements to be last", "recommended": false, "url": "https://eslint.org/docs/rules/default-case-last" } @@ -226,7 +226,7 @@ "default-param-last": { "type": "suggestion", "docs": { - "description": "enforce default parameters to be last", + "description": "Enforce default parameters to be last", "recommended": false, "url": "https://eslint.org/docs/rules/default-param-last" } @@ -234,7 +234,7 @@ "dot-location": { "type": "layout", "docs": { - "description": "enforce consistent newlines before and after dots", + "description": "Enforce consistent newlines before and after dots", "recommended": false, "url": "https://eslint.org/docs/rules/dot-location" }, @@ -243,7 +243,7 @@ "dot-notation": { "type": "suggestion", "docs": { - "description": "enforce dot notation whenever possible", + "description": "Enforce dot notation whenever possible", "recommended": false, "url": "https://eslint.org/docs/rules/dot-notation" }, @@ -252,7 +252,7 @@ "eol-last": { "type": "layout", "docs": { - "description": "require or disallow newline at the end of files", + "description": "Require or disallow newline at the end of files", "recommended": false, "url": "https://eslint.org/docs/rules/eol-last" }, @@ -261,7 +261,7 @@ "eqeqeq": { "type": "suggestion", "docs": { - "description": "require the use of `===` and `!==`", + "description": "Require the use of `===` and `!==`", "recommended": false, "url": "https://eslint.org/docs/rules/eqeqeq" }, @@ -270,7 +270,7 @@ "for-direction": { "type": "problem", "docs": { - "description": "enforce \"for\" loop update clause moving the counter in the right direction.", + "description": "Enforce \"for\" loop update clause moving the counter in the right direction.", "recommended": true, "url": "https://eslint.org/docs/rules/for-direction" }, @@ -279,7 +279,7 @@ "func-call-spacing": { "type": "layout", "docs": { - "description": "require or disallow spacing between function identifiers and their invocations", + "description": "Require or disallow spacing between function identifiers and their invocations", "recommended": false, "url": "https://eslint.org/docs/rules/func-call-spacing" }, @@ -288,7 +288,7 @@ "func-name-matching": { "type": "suggestion", "docs": { - "description": "require function names to match the name of the variable or property to which they are assigned", + "description": "Require function names to match the name of the variable or property to which they are assigned", "recommended": false, "url": "https://eslint.org/docs/rules/func-name-matching" } @@ -296,7 +296,7 @@ "func-names": { "type": "suggestion", "docs": { - "description": "require or disallow named `function` expressions", + "description": "Require or disallow named `function` expressions", "recommended": false, "url": "https://eslint.org/docs/rules/func-names" } @@ -304,7 +304,7 @@ "func-style": { "type": "suggestion", "docs": { - "description": "enforce the consistent use of either `function` declarations or expressions", + "description": "Enforce the consistent use of either `function` declarations or expressions", "recommended": false, "url": "https://eslint.org/docs/rules/func-style" } @@ -312,7 +312,7 @@ "function-call-argument-newline": { "type": "layout", "docs": { - "description": "enforce line breaks between arguments of a function call", + "description": "Enforce line breaks between arguments of a function call", "recommended": false, "url": "https://eslint.org/docs/rules/function-call-argument-newline" }, @@ -321,7 +321,7 @@ "function-paren-newline": { "type": "layout", "docs": { - "description": "enforce consistent line breaks inside function parentheses", + "description": "Enforce consistent line breaks inside function parentheses", "recommended": false, "url": "https://eslint.org/docs/rules/function-paren-newline" }, @@ -330,7 +330,7 @@ "generator-star-spacing": { "type": "layout", "docs": { - "description": "enforce consistent spacing around `*` operators in generator functions", + "description": "Enforce consistent spacing around `*` operators in generator functions", "recommended": false, "url": "https://eslint.org/docs/rules/generator-star-spacing" }, @@ -339,7 +339,7 @@ "getter-return": { "type": "problem", "docs": { - "description": "enforce `return` statements in getters", + "description": "Enforce `return` statements in getters", "recommended": true, "url": "https://eslint.org/docs/rules/getter-return" }, @@ -350,7 +350,7 @@ "replacedBy": [], "type": "suggestion", "docs": { - "description": "require `require()` calls to be placed at top-level module scope", + "description": "Require `require()` calls to be placed at top-level module scope", "recommended": false, "url": "https://eslint.org/docs/rules/global-require" } @@ -358,7 +358,7 @@ "grouped-accessor-pairs": { "type": "suggestion", "docs": { - "description": "require grouped accessor pairs in object literals and classes", + "description": "Require grouped accessor pairs in object literals and classes", "recommended": false, "url": "https://eslint.org/docs/rules/grouped-accessor-pairs" } @@ -366,7 +366,7 @@ "guard-for-in": { "type": "suggestion", "docs": { - "description": "require `for-in` loops to include an `if` statement", + "description": "Require `for-in` loops to include an `if` statement", "recommended": false, "url": "https://eslint.org/docs/rules/guard-for-in" } @@ -376,7 +376,7 @@ "replacedBy": [], "type": "suggestion", "docs": { - "description": "require error handling in callbacks", + "description": "Require error handling in callbacks", "recommended": false, "url": "https://eslint.org/docs/rules/handle-callback-err" } @@ -388,7 +388,7 @@ ], "type": "suggestion", "docs": { - "description": "disallow specified identifiers", + "description": "Disallow specified identifiers", "recommended": false, "url": "https://eslint.org/docs/rules/id-blacklist" } @@ -396,7 +396,7 @@ "id-denylist": { "type": "suggestion", "docs": { - "description": "disallow specified identifiers", + "description": "Disallow specified identifiers", "recommended": false, "url": "https://eslint.org/docs/rules/id-denylist" } @@ -404,7 +404,7 @@ "id-length": { "type": "suggestion", "docs": { - "description": "enforce minimum and maximum identifier lengths", + "description": "Enforce minimum and maximum identifier lengths", "recommended": false, "url": "https://eslint.org/docs/rules/id-length" } @@ -412,7 +412,7 @@ "id-match": { "type": "suggestion", "docs": { - "description": "require identifiers to match a specified regular expression", + "description": "Require identifiers to match a specified regular expression", "recommended": false, "url": "https://eslint.org/docs/rules/id-match" } @@ -420,7 +420,7 @@ "implicit-arrow-linebreak": { "type": "layout", "docs": { - "description": "enforce the location of arrow function bodies", + "description": "Enforce the location of arrow function bodies", "recommended": false, "url": "https://eslint.org/docs/rules/implicit-arrow-linebreak" }, @@ -429,7 +429,7 @@ "indent": { "type": "layout", "docs": { - "description": "enforce consistent indentation", + "description": "Enforce consistent indentation", "recommended": false, "url": "https://eslint.org/docs/rules/indent" }, @@ -438,7 +438,7 @@ "indent-legacy": { "type": "layout", "docs": { - "description": "enforce consistent indentation", + "description": "Enforce consistent indentation", "recommended": false, "url": "https://eslint.org/docs/rules/indent-legacy" }, @@ -451,7 +451,7 @@ "init-declarations": { "type": "suggestion", "docs": { - "description": "require or disallow initialization in variable declarations", + "description": "Require or disallow initialization in variable declarations", "recommended": false, "url": "https://eslint.org/docs/rules/init-declarations" } @@ -468,7 +468,7 @@ "key-spacing": { "type": "layout", "docs": { - "description": "enforce consistent spacing between keys and values in object literal properties", + "description": "Enforce consistent spacing between keys and values in object literal properties", "recommended": false, "url": "https://eslint.org/docs/rules/key-spacing" }, @@ -477,7 +477,7 @@ "keyword-spacing": { "type": "layout", "docs": { - "description": "enforce consistent spacing before and after keywords", + "description": "Enforce consistent spacing before and after keywords", "recommended": false, "url": "https://eslint.org/docs/rules/keyword-spacing" }, @@ -486,7 +486,7 @@ "line-comment-position": { "type": "layout", "docs": { - "description": "enforce position of line comments", + "description": "Enforce position of line comments", "recommended": false, "url": "https://eslint.org/docs/rules/line-comment-position" } @@ -494,7 +494,7 @@ "linebreak-style": { "type": "layout", "docs": { - "description": "enforce consistent linebreak style", + "description": "Enforce consistent linebreak style", "recommended": false, "url": "https://eslint.org/docs/rules/linebreak-style" }, @@ -503,7 +503,7 @@ "lines-around-comment": { "type": "layout", "docs": { - "description": "require empty lines around comments", + "description": "Require empty lines around comments", "recommended": false, "url": "https://eslint.org/docs/rules/lines-around-comment" }, @@ -512,7 +512,7 @@ "lines-around-directive": { "type": "layout", "docs": { - "description": "require or disallow newlines around directives", + "description": "Require or disallow newlines around directives", "recommended": false, "url": "https://eslint.org/docs/rules/lines-around-directive" }, @@ -525,7 +525,7 @@ "lines-between-class-members": { "type": "layout", "docs": { - "description": "require or disallow an empty line between class members", + "description": "Require or disallow an empty line between class members", "recommended": false, "url": "https://eslint.org/docs/rules/lines-between-class-members" }, @@ -534,7 +534,7 @@ "max-classes-per-file": { "type": "suggestion", "docs": { - "description": "enforce a maximum number of classes per file", + "description": "Enforce a maximum number of classes per file", "recommended": false, "url": "https://eslint.org/docs/rules/max-classes-per-file" } @@ -542,7 +542,7 @@ "max-depth": { "type": "suggestion", "docs": { - "description": "enforce a maximum depth that blocks can be nested", + "description": "Enforce a maximum depth that blocks can be nested", "recommended": false, "url": "https://eslint.org/docs/rules/max-depth" } @@ -550,7 +550,7 @@ "max-len": { "type": "layout", "docs": { - "description": "enforce a maximum line length", + "description": "Enforce a maximum line length", "recommended": false, "url": "https://eslint.org/docs/rules/max-len" } @@ -558,7 +558,7 @@ "max-lines": { "type": "suggestion", "docs": { - "description": "enforce a maximum number of lines per file", + "description": "Enforce a maximum number of lines per file", "recommended": false, "url": "https://eslint.org/docs/rules/max-lines" } @@ -566,7 +566,7 @@ "max-lines-per-function": { "type": "suggestion", "docs": { - "description": "enforce a maximum number of lines of code in a function", + "description": "Enforce a maximum number of lines of code in a function", "recommended": false, "url": "https://eslint.org/docs/rules/max-lines-per-function" } @@ -574,7 +574,7 @@ "max-nested-callbacks": { "type": "suggestion", "docs": { - "description": "enforce a maximum depth that callbacks can be nested", + "description": "Enforce a maximum depth that callbacks can be nested", "recommended": false, "url": "https://eslint.org/docs/rules/max-nested-callbacks" } @@ -582,7 +582,7 @@ "max-params": { "type": "suggestion", "docs": { - "description": "enforce a maximum number of parameters in function definitions", + "description": "Enforce a maximum number of parameters in function definitions", "recommended": false, "url": "https://eslint.org/docs/rules/max-params" } @@ -590,7 +590,7 @@ "max-statements": { "type": "suggestion", "docs": { - "description": "enforce a maximum number of statements allowed in function blocks", + "description": "Enforce a maximum number of statements allowed in function blocks", "recommended": false, "url": "https://eslint.org/docs/rules/max-statements" } @@ -598,7 +598,7 @@ "max-statements-per-line": { "type": "layout", "docs": { - "description": "enforce a maximum number of statements allowed per line", + "description": "Enforce a maximum number of statements allowed per line", "recommended": false, "url": "https://eslint.org/docs/rules/max-statements-per-line" } @@ -606,7 +606,7 @@ "multiline-comment-style": { "type": "suggestion", "docs": { - "description": "enforce a particular style for multiline comments", + "description": "Enforce a particular style for multiline comments", "recommended": false, "url": "https://eslint.org/docs/rules/multiline-comment-style" }, @@ -615,7 +615,7 @@ "multiline-ternary": { "type": "layout", "docs": { - "description": "enforce newlines between operands of ternary expressions", + "description": "Enforce newlines between operands of ternary expressions", "recommended": false, "url": "https://eslint.org/docs/rules/multiline-ternary" }, @@ -624,7 +624,7 @@ "new-cap": { "type": "suggestion", "docs": { - "description": "require constructor names to begin with a capital letter", + "description": "Require constructor names to begin with a capital letter", "recommended": false, "url": "https://eslint.org/docs/rules/new-cap" } @@ -632,7 +632,7 @@ "new-parens": { "type": "layout", "docs": { - "description": "enforce or disallow parentheses when invoking a constructor with no arguments", + "description": "Enforce or disallow parentheses when invoking a constructor with no arguments", "recommended": false, "url": "https://eslint.org/docs/rules/new-parens" }, @@ -641,7 +641,7 @@ "newline-after-var": { "type": "layout", "docs": { - "description": "require or disallow an empty line after variable declarations", + "description": "Require or disallow an empty line after variable declarations", "recommended": false, "url": "https://eslint.org/docs/rules/newline-after-var" }, @@ -654,7 +654,7 @@ "newline-before-return": { "type": "layout", "docs": { - "description": "require an empty line before `return` statements", + "description": "Require an empty line before `return` statements", "recommended": false, "url": "https://eslint.org/docs/rules/newline-before-return" }, @@ -667,7 +667,7 @@ "newline-per-chained-call": { "type": "layout", "docs": { - "description": "require a newline after each call in a method chain", + "description": "Require a newline after each call in a method chain", "recommended": false, "url": "https://eslint.org/docs/rules/newline-per-chained-call" }, @@ -676,7 +676,7 @@ "no-alert": { "type": "suggestion", "docs": { - "description": "disallow the use of `alert`, `confirm`, and `prompt`", + "description": "Disallow the use of `alert`, `confirm`, and `prompt`", "recommended": false, "url": "https://eslint.org/docs/rules/no-alert" } @@ -684,7 +684,7 @@ "no-array-constructor": { "type": "suggestion", "docs": { - "description": "disallow `Array` constructors", + "description": "Disallow `Array` constructors", "recommended": false, "url": "https://eslint.org/docs/rules/no-array-constructor" } @@ -692,7 +692,7 @@ "no-async-promise-executor": { "type": "problem", "docs": { - "description": "disallow using an async function as a Promise executor", + "description": "Disallow using an async function as a Promise executor", "recommended": true, "url": "https://eslint.org/docs/rules/no-async-promise-executor" }, @@ -701,7 +701,7 @@ "no-await-in-loop": { "type": "problem", "docs": { - "description": "disallow `await` inside of loops", + "description": "Disallow `await` inside of loops", "recommended": false, "url": "https://eslint.org/docs/rules/no-await-in-loop" } @@ -709,7 +709,7 @@ "no-bitwise": { "type": "suggestion", "docs": { - "description": "disallow bitwise operators", + "description": "Disallow bitwise operators", "recommended": false, "url": "https://eslint.org/docs/rules/no-bitwise" } @@ -719,7 +719,7 @@ "replacedBy": [], "type": "problem", "docs": { - "description": "disallow use of the `Buffer()` constructor", + "description": "Disallow use of the `Buffer()` constructor", "recommended": false, "url": "https://eslint.org/docs/rules/no-buffer-constructor" } @@ -727,7 +727,7 @@ "no-caller": { "type": "suggestion", "docs": { - "description": "disallow the use of `arguments.caller` or `arguments.callee`", + "description": "Disallow the use of `arguments.caller` or `arguments.callee`", "recommended": false, "url": "https://eslint.org/docs/rules/no-caller" } @@ -735,7 +735,7 @@ "no-case-declarations": { "type": "suggestion", "docs": { - "description": "disallow lexical declarations in case clauses", + "description": "Disallow lexical declarations in case clauses", "recommended": true, "url": "https://eslint.org/docs/rules/no-case-declarations" } @@ -743,7 +743,7 @@ "no-catch-shadow": { "type": "suggestion", "docs": { - "description": "disallow `catch` clause parameters from shadowing variables in the outer scope", + "description": "Disallow `catch` clause parameters from shadowing variables in the outer scope", "recommended": false, "url": "https://eslint.org/docs/rules/no-catch-shadow" }, @@ -755,7 +755,7 @@ "no-class-assign": { "type": "problem", "docs": { - "description": "disallow reassigning class members", + "description": "Disallow reassigning class members", "recommended": true, "url": "https://eslint.org/docs/rules/no-class-assign" } @@ -763,7 +763,7 @@ "no-compare-neg-zero": { "type": "problem", "docs": { - "description": "disallow comparing against -0", + "description": "Disallow comparing against -0", "recommended": true, "url": "https://eslint.org/docs/rules/no-compare-neg-zero" }, @@ -772,7 +772,7 @@ "no-cond-assign": { "type": "problem", "docs": { - "description": "disallow assignment operators in conditional expressions", + "description": "Disallow assignment operators in conditional expressions", "recommended": true, "url": "https://eslint.org/docs/rules/no-cond-assign" } @@ -780,7 +780,7 @@ "no-confusing-arrow": { "type": "suggestion", "docs": { - "description": "disallow arrow functions where they could be confused with comparisons", + "description": "Disallow arrow functions where they could be confused with comparisons", "recommended": false, "url": "https://eslint.org/docs/rules/no-confusing-arrow" }, @@ -789,7 +789,7 @@ "no-console": { "type": "suggestion", "docs": { - "description": "disallow the use of `console`", + "description": "Disallow the use of `console`", "recommended": false, "url": "https://eslint.org/docs/rules/no-console" } @@ -797,7 +797,7 @@ "no-const-assign": { "type": "problem", "docs": { - "description": "disallow reassigning `const` variables", + "description": "Disallow reassigning `const` variables", "recommended": true, "url": "https://eslint.org/docs/rules/no-const-assign" } @@ -805,7 +805,7 @@ "no-constant-binary-expression": { "type": "problem", "docs": { - "description": "disallow expressions where the operation doesn't affect the value", + "description": "Disallow expressions where the operation doesn't affect the value", "recommended": false, "url": "https://eslint.org/docs/rules/no-constant-binary-expression" } @@ -813,7 +813,7 @@ "no-constant-condition": { "type": "problem", "docs": { - "description": "disallow constant expressions in conditions", + "description": "Disallow constant expressions in conditions", "recommended": true, "url": "https://eslint.org/docs/rules/no-constant-condition" } @@ -821,7 +821,7 @@ "no-constructor-return": { "type": "problem", "docs": { - "description": "disallow returning value from constructor", + "description": "Disallow returning value from constructor", "recommended": false, "url": "https://eslint.org/docs/rules/no-constructor-return" }, @@ -830,7 +830,7 @@ "no-continue": { "type": "suggestion", "docs": { - "description": "disallow `continue` statements", + "description": "Disallow `continue` statements", "recommended": false, "url": "https://eslint.org/docs/rules/no-continue" } @@ -838,7 +838,7 @@ "no-control-regex": { "type": "problem", "docs": { - "description": "disallow control characters in regular expressions", + "description": "Disallow control characters in regular expressions", "recommended": true, "url": "https://eslint.org/docs/rules/no-control-regex" } @@ -846,7 +846,7 @@ "no-debugger": { "type": "problem", "docs": { - "description": "disallow the use of `debugger`", + "description": "Disallow the use of `debugger`", "recommended": true, "url": "https://eslint.org/docs/rules/no-debugger" }, @@ -855,7 +855,7 @@ "no-delete-var": { "type": "suggestion", "docs": { - "description": "disallow deleting variables", + "description": "Disallow deleting variables", "recommended": true, "url": "https://eslint.org/docs/rules/no-delete-var" } @@ -863,7 +863,7 @@ "no-div-regex": { "type": "suggestion", "docs": { - "description": "disallow division operators explicitly at the beginning of regular expressions", + "description": "Disallow division operators explicitly at the beginning of regular expressions", "recommended": false, "url": "https://eslint.org/docs/rules/no-div-regex" }, @@ -872,7 +872,7 @@ "no-dupe-args": { "type": "problem", "docs": { - "description": "disallow duplicate arguments in `function` definitions", + "description": "Disallow duplicate arguments in `function` definitions", "recommended": true, "url": "https://eslint.org/docs/rules/no-dupe-args" } @@ -880,7 +880,7 @@ "no-dupe-class-members": { "type": "problem", "docs": { - "description": "disallow duplicate class members", + "description": "Disallow duplicate class members", "recommended": true, "url": "https://eslint.org/docs/rules/no-dupe-class-members" } @@ -888,7 +888,7 @@ "no-dupe-else-if": { "type": "problem", "docs": { - "description": "disallow duplicate conditions in if-else-if chains", + "description": "Disallow duplicate conditions in if-else-if chains", "recommended": true, "url": "https://eslint.org/docs/rules/no-dupe-else-if" } @@ -896,7 +896,7 @@ "no-dupe-keys": { "type": "problem", "docs": { - "description": "disallow duplicate keys in object literals", + "description": "Disallow duplicate keys in object literals", "recommended": true, "url": "https://eslint.org/docs/rules/no-dupe-keys" } @@ -904,7 +904,7 @@ "no-duplicate-case": { "type": "problem", "docs": { - "description": "disallow duplicate case labels", + "description": "Disallow duplicate case labels", "recommended": true, "url": "https://eslint.org/docs/rules/no-duplicate-case" } @@ -912,7 +912,7 @@ "no-duplicate-imports": { "type": "problem", "docs": { - "description": "disallow duplicate module imports", + "description": "Disallow duplicate module imports", "recommended": false, "url": "https://eslint.org/docs/rules/no-duplicate-imports" } @@ -920,7 +920,7 @@ "no-else-return": { "type": "suggestion", "docs": { - "description": "disallow `else` blocks after `return` statements in `if` statements", + "description": "Disallow `else` blocks after `return` statements in `if` statements", "recommended": false, "url": "https://eslint.org/docs/rules/no-else-return" }, @@ -929,7 +929,7 @@ "no-empty": { "type": "suggestion", "docs": { - "description": "disallow empty block statements", + "description": "Disallow empty block statements", "recommended": true, "url": "https://eslint.org/docs/rules/no-empty" } @@ -937,7 +937,7 @@ "no-empty-character-class": { "type": "problem", "docs": { - "description": "disallow empty character classes in regular expressions", + "description": "Disallow empty character classes in regular expressions", "recommended": true, "url": "https://eslint.org/docs/rules/no-empty-character-class" } @@ -945,7 +945,7 @@ "no-empty-function": { "type": "suggestion", "docs": { - "description": "disallow empty functions", + "description": "Disallow empty functions", "recommended": false, "url": "https://eslint.org/docs/rules/no-empty-function" } @@ -953,7 +953,7 @@ "no-empty-pattern": { "type": "problem", "docs": { - "description": "disallow empty destructuring patterns", + "description": "Disallow empty destructuring patterns", "recommended": true, "url": "https://eslint.org/docs/rules/no-empty-pattern" } @@ -961,7 +961,7 @@ "no-eq-null": { "type": "suggestion", "docs": { - "description": "disallow `null` comparisons without type-checking operators", + "description": "Disallow `null` comparisons without type-checking operators", "recommended": false, "url": "https://eslint.org/docs/rules/no-eq-null" } @@ -969,7 +969,7 @@ "no-eval": { "type": "suggestion", "docs": { - "description": "disallow the use of `eval()`", + "description": "Disallow the use of `eval()`", "recommended": false, "url": "https://eslint.org/docs/rules/no-eval" } @@ -977,7 +977,7 @@ "no-ex-assign": { "type": "problem", "docs": { - "description": "disallow reassigning exceptions in `catch` clauses", + "description": "Disallow reassigning exceptions in `catch` clauses", "recommended": true, "url": "https://eslint.org/docs/rules/no-ex-assign" } @@ -985,7 +985,7 @@ "no-extend-native": { "type": "suggestion", "docs": { - "description": "disallow extending native types", + "description": "Disallow extending native types", "recommended": false, "url": "https://eslint.org/docs/rules/no-extend-native" } @@ -993,7 +993,7 @@ "no-extra-bind": { "type": "suggestion", "docs": { - "description": "disallow unnecessary calls to `.bind()`", + "description": "Disallow unnecessary calls to `.bind()`", "recommended": false, "url": "https://eslint.org/docs/rules/no-extra-bind" }, @@ -1002,7 +1002,7 @@ "no-extra-boolean-cast": { "type": "suggestion", "docs": { - "description": "disallow unnecessary boolean casts", + "description": "Disallow unnecessary boolean casts", "recommended": true, "url": "https://eslint.org/docs/rules/no-extra-boolean-cast" }, @@ -1011,7 +1011,7 @@ "no-extra-label": { "type": "suggestion", "docs": { - "description": "disallow unnecessary labels", + "description": "Disallow unnecessary labels", "recommended": false, "url": "https://eslint.org/docs/rules/no-extra-label" }, @@ -1020,7 +1020,7 @@ "no-extra-parens": { "type": "layout", "docs": { - "description": "disallow unnecessary parentheses", + "description": "Disallow unnecessary parentheses", "recommended": false, "url": "https://eslint.org/docs/rules/no-extra-parens" }, @@ -1029,7 +1029,7 @@ "no-extra-semi": { "type": "suggestion", "docs": { - "description": "disallow unnecessary semicolons", + "description": "Disallow unnecessary semicolons", "recommended": true, "url": "https://eslint.org/docs/rules/no-extra-semi" }, @@ -1038,7 +1038,7 @@ "no-fallthrough": { "type": "problem", "docs": { - "description": "disallow fallthrough of `case` statements", + "description": "Disallow fallthrough of `case` statements", "recommended": true, "url": "https://eslint.org/docs/rules/no-fallthrough" } @@ -1046,7 +1046,7 @@ "no-floating-decimal": { "type": "suggestion", "docs": { - "description": "disallow leading or trailing decimal points in numeric literals", + "description": "Disallow leading or trailing decimal points in numeric literals", "recommended": false, "url": "https://eslint.org/docs/rules/no-floating-decimal" }, @@ -1055,7 +1055,7 @@ "no-func-assign": { "type": "problem", "docs": { - "description": "disallow reassigning `function` declarations", + "description": "Disallow reassigning `function` declarations", "recommended": true, "url": "https://eslint.org/docs/rules/no-func-assign" } @@ -1063,7 +1063,7 @@ "no-global-assign": { "type": "suggestion", "docs": { - "description": "disallow assignments to native objects or read-only global variables", + "description": "Disallow assignments to native objects or read-only global variables", "recommended": true, "url": "https://eslint.org/docs/rules/no-global-assign" } @@ -1071,7 +1071,7 @@ "no-implicit-coercion": { "type": "suggestion", "docs": { - "description": "disallow shorthand type conversions", + "description": "Disallow shorthand type conversions", "recommended": false, "url": "https://eslint.org/docs/rules/no-implicit-coercion" }, @@ -1080,7 +1080,7 @@ "no-implicit-globals": { "type": "suggestion", "docs": { - "description": "disallow declarations in the global scope", + "description": "Disallow declarations in the global scope", "recommended": false, "url": "https://eslint.org/docs/rules/no-implicit-globals" } @@ -1088,7 +1088,7 @@ "no-implied-eval": { "type": "suggestion", "docs": { - "description": "disallow the use of `eval()`-like methods", + "description": "Disallow the use of `eval()`-like methods", "recommended": false, "url": "https://eslint.org/docs/rules/no-implied-eval" } @@ -1096,7 +1096,7 @@ "no-import-assign": { "type": "problem", "docs": { - "description": "disallow assigning to imported bindings", + "description": "Disallow assigning to imported bindings", "recommended": true, "url": "https://eslint.org/docs/rules/no-import-assign" } @@ -1104,7 +1104,7 @@ "no-inline-comments": { "type": "suggestion", "docs": { - "description": "disallow inline comments after code", + "description": "Disallow inline comments after code", "recommended": false, "url": "https://eslint.org/docs/rules/no-inline-comments" } @@ -1112,7 +1112,7 @@ "no-inner-declarations": { "type": "problem", "docs": { - "description": "disallow variable or `function` declarations in nested blocks", + "description": "Disallow variable or `function` declarations in nested blocks", "recommended": true, "url": "https://eslint.org/docs/rules/no-inner-declarations" } @@ -1120,7 +1120,7 @@ "no-invalid-regexp": { "type": "problem", "docs": { - "description": "disallow invalid regular expression strings in `RegExp` constructors", + "description": "Disallow invalid regular expression strings in `RegExp` constructors", "recommended": true, "url": "https://eslint.org/docs/rules/no-invalid-regexp" } @@ -1128,7 +1128,7 @@ "no-invalid-this": { "type": "suggestion", "docs": { - "description": "disallow use of `this` in contexts where the value of `this` is `undefined`", + "description": "Disallow use of `this` in contexts where the value of `this` is `undefined`", "recommended": false, "url": "https://eslint.org/docs/rules/no-invalid-this" } @@ -1136,7 +1136,7 @@ "no-irregular-whitespace": { "type": "problem", "docs": { - "description": "disallow irregular whitespace", + "description": "Disallow irregular whitespace", "recommended": true, "url": "https://eslint.org/docs/rules/no-irregular-whitespace" } @@ -1144,7 +1144,7 @@ "no-iterator": { "type": "suggestion", "docs": { - "description": "disallow the use of the `__iterator__` property", + "description": "Disallow the use of the `__iterator__` property", "recommended": false, "url": "https://eslint.org/docs/rules/no-iterator" } @@ -1152,7 +1152,7 @@ "no-label-var": { "type": "suggestion", "docs": { - "description": "disallow labels that share a name with a variable", + "description": "Disallow labels that share a name with a variable", "recommended": false, "url": "https://eslint.org/docs/rules/no-label-var" } @@ -1160,7 +1160,7 @@ "no-labels": { "type": "suggestion", "docs": { - "description": "disallow labeled statements", + "description": "Disallow labeled statements", "recommended": false, "url": "https://eslint.org/docs/rules/no-labels" } @@ -1168,7 +1168,7 @@ "no-lone-blocks": { "type": "suggestion", "docs": { - "description": "disallow unnecessary nested blocks", + "description": "Disallow unnecessary nested blocks", "recommended": false, "url": "https://eslint.org/docs/rules/no-lone-blocks" } @@ -1176,7 +1176,7 @@ "no-lonely-if": { "type": "suggestion", "docs": { - "description": "disallow `if` statements as the only statement in `else` blocks", + "description": "Disallow `if` statements as the only statement in `else` blocks", "recommended": false, "url": "https://eslint.org/docs/rules/no-lonely-if" }, @@ -1185,7 +1185,7 @@ "no-loop-func": { "type": "suggestion", "docs": { - "description": "disallow function declarations that contain unsafe references inside loop statements", + "description": "Disallow function declarations that contain unsafe references inside loop statements", "recommended": false, "url": "https://eslint.org/docs/rules/no-loop-func" } @@ -1193,7 +1193,7 @@ "no-loss-of-precision": { "type": "problem", "docs": { - "description": "disallow literal numbers that lose precision", + "description": "Disallow literal numbers that lose precision", "recommended": true, "url": "https://eslint.org/docs/rules/no-loss-of-precision" } @@ -1201,7 +1201,7 @@ "no-magic-numbers": { "type": "suggestion", "docs": { - "description": "disallow magic numbers", + "description": "Disallow magic numbers", "recommended": false, "url": "https://eslint.org/docs/rules/no-magic-numbers" } @@ -1209,7 +1209,7 @@ "no-misleading-character-class": { "type": "problem", "docs": { - "description": "disallow characters which are made with multiple code points in character class syntax", + "description": "Disallow characters which are made with multiple code points in character class syntax", "recommended": true, "url": "https://eslint.org/docs/rules/no-misleading-character-class" }, @@ -1218,7 +1218,7 @@ "no-mixed-operators": { "type": "suggestion", "docs": { - "description": "disallow mixed binary operators", + "description": "Disallow mixed binary operators", "recommended": false, "url": "https://eslint.org/docs/rules/no-mixed-operators" } @@ -1228,7 +1228,7 @@ "replacedBy": [], "type": "suggestion", "docs": { - "description": "disallow `require` calls to be mixed with regular variable declarations", + "description": "Disallow `require` calls to be mixed with regular variable declarations", "recommended": false, "url": "https://eslint.org/docs/rules/no-mixed-requires" } @@ -1236,7 +1236,7 @@ "no-mixed-spaces-and-tabs": { "type": "layout", "docs": { - "description": "disallow mixed spaces and tabs for indentation", + "description": "Disallow mixed spaces and tabs for indentation", "recommended": true, "url": "https://eslint.org/docs/rules/no-mixed-spaces-and-tabs" } @@ -1244,7 +1244,7 @@ "no-multi-assign": { "type": "suggestion", "docs": { - "description": "disallow use of chained assignment expressions", + "description": "Disallow use of chained assignment expressions", "recommended": false, "url": "https://eslint.org/docs/rules/no-multi-assign" } @@ -1252,7 +1252,7 @@ "no-multi-spaces": { "type": "layout", "docs": { - "description": "disallow multiple spaces", + "description": "Disallow multiple spaces", "recommended": false, "url": "https://eslint.org/docs/rules/no-multi-spaces" }, @@ -1261,7 +1261,7 @@ "no-multi-str": { "type": "suggestion", "docs": { - "description": "disallow multiline strings", + "description": "Disallow multiline strings", "recommended": false, "url": "https://eslint.org/docs/rules/no-multi-str" } @@ -1269,7 +1269,7 @@ "no-multiple-empty-lines": { "type": "layout", "docs": { - "description": "disallow multiple empty lines", + "description": "Disallow multiple empty lines", "recommended": false, "url": "https://eslint.org/docs/rules/no-multiple-empty-lines" }, @@ -1278,7 +1278,7 @@ "no-native-reassign": { "type": "suggestion", "docs": { - "description": "disallow assignments to native objects or read-only global variables", + "description": "Disallow assignments to native objects or read-only global variables", "recommended": false, "url": "https://eslint.org/docs/rules/no-native-reassign" }, @@ -1290,7 +1290,7 @@ "no-negated-condition": { "type": "suggestion", "docs": { - "description": "disallow negated conditions", + "description": "Disallow negated conditions", "recommended": false, "url": "https://eslint.org/docs/rules/no-negated-condition" } @@ -1298,7 +1298,7 @@ "no-negated-in-lhs": { "type": "problem", "docs": { - "description": "disallow negating the left operand in `in` expressions", + "description": "Disallow negating the left operand in `in` expressions", "recommended": false, "url": "https://eslint.org/docs/rules/no-negated-in-lhs" }, @@ -1310,7 +1310,7 @@ "no-nested-ternary": { "type": "suggestion", "docs": { - "description": "disallow nested ternary expressions", + "description": "Disallow nested ternary expressions", "recommended": false, "url": "https://eslint.org/docs/rules/no-nested-ternary" } @@ -1318,7 +1318,7 @@ "no-new": { "type": "suggestion", "docs": { - "description": "disallow `new` operators outside of assignments or comparisons", + "description": "Disallow `new` operators outside of assignments or comparisons", "recommended": false, "url": "https://eslint.org/docs/rules/no-new" } @@ -1326,7 +1326,7 @@ "no-new-func": { "type": "suggestion", "docs": { - "description": "disallow `new` operators with the `Function` object", + "description": "Disallow `new` operators with the `Function` object", "recommended": false, "url": "https://eslint.org/docs/rules/no-new-func" } @@ -1334,7 +1334,7 @@ "no-new-object": { "type": "suggestion", "docs": { - "description": "disallow `Object` constructors", + "description": "Disallow `Object` constructors", "recommended": false, "url": "https://eslint.org/docs/rules/no-new-object" } @@ -1344,7 +1344,7 @@ "replacedBy": [], "type": "suggestion", "docs": { - "description": "disallow `new` operators with calls to `require`", + "description": "Disallow `new` operators with calls to `require`", "recommended": false, "url": "https://eslint.org/docs/rules/no-new-require" } @@ -1352,7 +1352,7 @@ "no-new-symbol": { "type": "problem", "docs": { - "description": "disallow `new` operators with the `Symbol` object", + "description": "Disallow `new` operators with the `Symbol` object", "recommended": true, "url": "https://eslint.org/docs/rules/no-new-symbol" } @@ -1360,7 +1360,7 @@ "no-new-wrappers": { "type": "suggestion", "docs": { - "description": "disallow `new` operators with the `String`, `Number`, and `Boolean` objects", + "description": "Disallow `new` operators with the `String`, `Number`, and `Boolean` objects", "recommended": false, "url": "https://eslint.org/docs/rules/no-new-wrappers" } @@ -1368,7 +1368,7 @@ "no-nonoctal-decimal-escape": { "type": "suggestion", "docs": { - "description": "disallow `\\8` and `\\9` escape sequences in string literals", + "description": "Disallow `\\8` and `\\9` escape sequences in string literals", "recommended": true, "url": "https://eslint.org/docs/rules/no-nonoctal-decimal-escape" }, @@ -1377,7 +1377,7 @@ "no-obj-calls": { "type": "problem", "docs": { - "description": "disallow calling global object properties as functions", + "description": "Disallow calling global object properties as functions", "recommended": true, "url": "https://eslint.org/docs/rules/no-obj-calls" } @@ -1385,7 +1385,7 @@ "no-octal": { "type": "suggestion", "docs": { - "description": "disallow octal literals", + "description": "Disallow octal literals", "recommended": true, "url": "https://eslint.org/docs/rules/no-octal" } @@ -1393,7 +1393,7 @@ "no-octal-escape": { "type": "suggestion", "docs": { - "description": "disallow octal escape sequences in string literals", + "description": "Disallow octal escape sequences in string literals", "recommended": false, "url": "https://eslint.org/docs/rules/no-octal-escape" } @@ -1401,7 +1401,7 @@ "no-param-reassign": { "type": "suggestion", "docs": { - "description": "disallow reassigning `function` parameters", + "description": "Disallow reassigning `function` parameters", "recommended": false, "url": "https://eslint.org/docs/rules/no-param-reassign" } @@ -1411,7 +1411,7 @@ "replacedBy": [], "type": "suggestion", "docs": { - "description": "disallow string concatenation with `__dirname` and `__filename`", + "description": "Disallow string concatenation with `__dirname` and `__filename`", "recommended": false, "url": "https://eslint.org/docs/rules/no-path-concat" } @@ -1419,7 +1419,7 @@ "no-plusplus": { "type": "suggestion", "docs": { - "description": "disallow the unary operators `++` and `--`", + "description": "Disallow the unary operators `++` and `--`", "recommended": false, "url": "https://eslint.org/docs/rules/no-plusplus" } @@ -1429,7 +1429,7 @@ "replacedBy": [], "type": "suggestion", "docs": { - "description": "disallow the use of `process.env`", + "description": "Disallow the use of `process.env`", "recommended": false, "url": "https://eslint.org/docs/rules/no-process-env" } @@ -1439,7 +1439,7 @@ "replacedBy": [], "type": "suggestion", "docs": { - "description": "disallow the use of `process.exit()`", + "description": "Disallow the use of `process.exit()`", "recommended": false, "url": "https://eslint.org/docs/rules/no-process-exit" } @@ -1447,7 +1447,7 @@ "no-promise-executor-return": { "type": "problem", "docs": { - "description": "disallow returning values from Promise executor functions", + "description": "Disallow returning values from Promise executor functions", "recommended": false, "url": "https://eslint.org/docs/rules/no-promise-executor-return" } @@ -1455,7 +1455,7 @@ "no-proto": { "type": "suggestion", "docs": { - "description": "disallow the use of the `__proto__` property", + "description": "Disallow the use of the `__proto__` property", "recommended": false, "url": "https://eslint.org/docs/rules/no-proto" } @@ -1463,7 +1463,7 @@ "no-prototype-builtins": { "type": "problem", "docs": { - "description": "disallow calling some `Object.prototype` methods directly on objects", + "description": "Disallow calling some `Object.prototype` methods directly on objects", "recommended": true, "url": "https://eslint.org/docs/rules/no-prototype-builtins" } @@ -1471,7 +1471,7 @@ "no-redeclare": { "type": "suggestion", "docs": { - "description": "disallow variable redeclaration", + "description": "Disallow variable redeclaration", "recommended": true, "url": "https://eslint.org/docs/rules/no-redeclare" } @@ -1479,7 +1479,7 @@ "no-regex-spaces": { "type": "suggestion", "docs": { - "description": "disallow multiple spaces in regular expressions", + "description": "Disallow multiple spaces in regular expressions", "recommended": true, "url": "https://eslint.org/docs/rules/no-regex-spaces" }, @@ -1488,7 +1488,7 @@ "no-restricted-exports": { "type": "suggestion", "docs": { - "description": "disallow specified names in exports", + "description": "Disallow specified names in exports", "recommended": false, "url": "https://eslint.org/docs/rules/no-restricted-exports" } @@ -1496,7 +1496,7 @@ "no-restricted-globals": { "type": "suggestion", "docs": { - "description": "disallow specified global variables", + "description": "Disallow specified global variables", "recommended": false, "url": "https://eslint.org/docs/rules/no-restricted-globals" } @@ -1504,7 +1504,7 @@ "no-restricted-imports": { "type": "suggestion", "docs": { - "description": "disallow specified modules when loaded by `import`", + "description": "Disallow specified modules when loaded by `import`", "recommended": false, "url": "https://eslint.org/docs/rules/no-restricted-imports" } @@ -1514,7 +1514,7 @@ "replacedBy": [], "type": "suggestion", "docs": { - "description": "disallow specified modules when loaded by `require`", + "description": "Disallow specified modules when loaded by `require`", "recommended": false, "url": "https://eslint.org/docs/rules/no-restricted-modules" } @@ -1522,7 +1522,7 @@ "no-restricted-properties": { "type": "suggestion", "docs": { - "description": "disallow certain properties on certain objects", + "description": "Disallow certain properties on certain objects", "recommended": false, "url": "https://eslint.org/docs/rules/no-restricted-properties" } @@ -1530,7 +1530,7 @@ "no-restricted-syntax": { "type": "suggestion", "docs": { - "description": "disallow specified syntax", + "description": "Disallow specified syntax", "recommended": false, "url": "https://eslint.org/docs/rules/no-restricted-syntax" } @@ -1538,7 +1538,7 @@ "no-return-assign": { "type": "suggestion", "docs": { - "description": "disallow assignment operators in `return` statements", + "description": "Disallow assignment operators in `return` statements", "recommended": false, "url": "https://eslint.org/docs/rules/no-return-assign" } @@ -1546,7 +1546,7 @@ "no-return-await": { "type": "suggestion", "docs": { - "description": "disallow unnecessary `return await`", + "description": "Disallow unnecessary `return await`", "recommended": false, "url": "https://eslint.org/docs/rules/no-return-await" }, @@ -1555,7 +1555,7 @@ "no-script-url": { "type": "suggestion", "docs": { - "description": "disallow `javascript:` urls", + "description": "Disallow `javascript:` urls", "recommended": false, "url": "https://eslint.org/docs/rules/no-script-url" } @@ -1563,7 +1563,7 @@ "no-self-assign": { "type": "problem", "docs": { - "description": "disallow assignments where both sides are exactly the same", + "description": "Disallow assignments where both sides are exactly the same", "recommended": true, "url": "https://eslint.org/docs/rules/no-self-assign" } @@ -1571,7 +1571,7 @@ "no-self-compare": { "type": "problem", "docs": { - "description": "disallow comparisons where both sides are exactly the same", + "description": "Disallow comparisons where both sides are exactly the same", "recommended": false, "url": "https://eslint.org/docs/rules/no-self-compare" } @@ -1579,7 +1579,7 @@ "no-sequences": { "type": "suggestion", "docs": { - "description": "disallow comma operators", + "description": "Disallow comma operators", "recommended": false, "url": "https://eslint.org/docs/rules/no-sequences" } @@ -1587,7 +1587,7 @@ "no-setter-return": { "type": "problem", "docs": { - "description": "disallow returning values from setters", + "description": "Disallow returning values from setters", "recommended": true, "url": "https://eslint.org/docs/rules/no-setter-return" } @@ -1595,7 +1595,7 @@ "no-shadow": { "type": "suggestion", "docs": { - "description": "disallow variable declarations from shadowing variables declared in the outer scope", + "description": "Disallow variable declarations from shadowing variables declared in the outer scope", "recommended": false, "url": "https://eslint.org/docs/rules/no-shadow" } @@ -1603,7 +1603,7 @@ "no-shadow-restricted-names": { "type": "suggestion", "docs": { - "description": "disallow identifiers from shadowing restricted names", + "description": "Disallow identifiers from shadowing restricted names", "recommended": true, "url": "https://eslint.org/docs/rules/no-shadow-restricted-names" } @@ -1611,7 +1611,7 @@ "no-spaced-func": { "type": "layout", "docs": { - "description": "disallow spacing between function identifiers and their applications (deprecated)", + "description": "Disallow spacing between function identifiers and their applications (deprecated)", "recommended": false, "url": "https://eslint.org/docs/rules/no-spaced-func" }, @@ -1624,7 +1624,7 @@ "no-sparse-arrays": { "type": "problem", "docs": { - "description": "disallow sparse arrays", + "description": "Disallow sparse arrays", "recommended": true, "url": "https://eslint.org/docs/rules/no-sparse-arrays" } @@ -1634,7 +1634,7 @@ "replacedBy": [], "type": "suggestion", "docs": { - "description": "disallow synchronous methods", + "description": "Disallow synchronous methods", "recommended": false, "url": "https://eslint.org/docs/rules/no-sync" } @@ -1642,7 +1642,7 @@ "no-tabs": { "type": "layout", "docs": { - "description": "disallow all tabs", + "description": "Disallow all tabs", "recommended": false, "url": "https://eslint.org/docs/rules/no-tabs" } @@ -1650,7 +1650,7 @@ "no-template-curly-in-string": { "type": "problem", "docs": { - "description": "disallow template literal placeholder syntax in regular strings", + "description": "Disallow template literal placeholder syntax in regular strings", "recommended": false, "url": "https://eslint.org/docs/rules/no-template-curly-in-string" } @@ -1658,7 +1658,7 @@ "no-ternary": { "type": "suggestion", "docs": { - "description": "disallow ternary operators", + "description": "Disallow ternary operators", "recommended": false, "url": "https://eslint.org/docs/rules/no-ternary" } @@ -1666,7 +1666,7 @@ "no-this-before-super": { "type": "problem", "docs": { - "description": "disallow `this`/`super` before calling `super()` in constructors", + "description": "Disallow `this`/`super` before calling `super()` in constructors", "recommended": true, "url": "https://eslint.org/docs/rules/no-this-before-super" } @@ -1674,7 +1674,7 @@ "no-throw-literal": { "type": "suggestion", "docs": { - "description": "disallow throwing literals as exceptions", + "description": "Disallow throwing literals as exceptions", "recommended": false, "url": "https://eslint.org/docs/rules/no-throw-literal" } @@ -1682,7 +1682,7 @@ "no-trailing-spaces": { "type": "layout", "docs": { - "description": "disallow trailing whitespace at the end of lines", + "description": "Disallow trailing whitespace at the end of lines", "recommended": false, "url": "https://eslint.org/docs/rules/no-trailing-spaces" }, @@ -1691,7 +1691,7 @@ "no-undef": { "type": "problem", "docs": { - "description": "disallow the use of undeclared variables unless mentioned in `/*global */` comments", + "description": "Disallow the use of undeclared variables unless mentioned in `/*global */` comments", "recommended": true, "url": "https://eslint.org/docs/rules/no-undef" } @@ -1699,7 +1699,7 @@ "no-undef-init": { "type": "suggestion", "docs": { - "description": "disallow initializing variables to `undefined`", + "description": "Disallow initializing variables to `undefined`", "recommended": false, "url": "https://eslint.org/docs/rules/no-undef-init" }, @@ -1708,7 +1708,7 @@ "no-undefined": { "type": "suggestion", "docs": { - "description": "disallow the use of `undefined` as an identifier", + "description": "Disallow the use of `undefined` as an identifier", "recommended": false, "url": "https://eslint.org/docs/rules/no-undefined" } @@ -1716,7 +1716,7 @@ "no-underscore-dangle": { "type": "suggestion", "docs": { - "description": "disallow dangling underscores in identifiers", + "description": "Disallow dangling underscores in identifiers", "recommended": false, "url": "https://eslint.org/docs/rules/no-underscore-dangle" } @@ -1724,7 +1724,7 @@ "no-unexpected-multiline": { "type": "problem", "docs": { - "description": "disallow confusing multiline expressions", + "description": "Disallow confusing multiline expressions", "recommended": true, "url": "https://eslint.org/docs/rules/no-unexpected-multiline" } @@ -1732,7 +1732,7 @@ "no-unmodified-loop-condition": { "type": "problem", "docs": { - "description": "disallow unmodified loop conditions", + "description": "Disallow unmodified loop conditions", "recommended": false, "url": "https://eslint.org/docs/rules/no-unmodified-loop-condition" } @@ -1740,7 +1740,7 @@ "no-unneeded-ternary": { "type": "suggestion", "docs": { - "description": "disallow ternary operators when simpler alternatives exist", + "description": "Disallow ternary operators when simpler alternatives exist", "recommended": false, "url": "https://eslint.org/docs/rules/no-unneeded-ternary" }, @@ -1749,7 +1749,7 @@ "no-unreachable": { "type": "problem", "docs": { - "description": "disallow unreachable code after `return`, `throw`, `continue`, and `break` statements", + "description": "Disallow unreachable code after `return`, `throw`, `continue`, and `break` statements", "recommended": true, "url": "https://eslint.org/docs/rules/no-unreachable" } @@ -1757,7 +1757,7 @@ "no-unreachable-loop": { "type": "problem", "docs": { - "description": "disallow loops with a body that allows only one iteration", + "description": "Disallow loops with a body that allows only one iteration", "recommended": false, "url": "https://eslint.org/docs/rules/no-unreachable-loop" } @@ -1765,7 +1765,7 @@ "no-unsafe-finally": { "type": "problem", "docs": { - "description": "disallow control flow statements in `finally` blocks", + "description": "Disallow control flow statements in `finally` blocks", "recommended": true, "url": "https://eslint.org/docs/rules/no-unsafe-finally" } @@ -1773,7 +1773,7 @@ "no-unsafe-negation": { "type": "problem", "docs": { - "description": "disallow negating the left operand of relational operators", + "description": "Disallow negating the left operand of relational operators", "recommended": true, "url": "https://eslint.org/docs/rules/no-unsafe-negation" }, @@ -1783,7 +1783,7 @@ "no-unsafe-optional-chaining": { "type": "problem", "docs": { - "description": "disallow use of optional chaining in contexts where the `undefined` value is not allowed", + "description": "Disallow use of optional chaining in contexts where the `undefined` value is not allowed", "recommended": true, "url": "https://eslint.org/docs/rules/no-unsafe-optional-chaining" }, @@ -1792,7 +1792,7 @@ "no-unused-expressions": { "type": "suggestion", "docs": { - "description": "disallow unused expressions", + "description": "Disallow unused expressions", "recommended": false, "url": "https://eslint.org/docs/rules/no-unused-expressions" } @@ -1800,7 +1800,7 @@ "no-unused-labels": { "type": "suggestion", "docs": { - "description": "disallow unused labels", + "description": "Disallow unused labels", "recommended": true, "url": "https://eslint.org/docs/rules/no-unused-labels" }, @@ -1809,7 +1809,7 @@ "no-unused-private-class-members": { "type": "problem", "docs": { - "description": "disallow unused private class members", + "description": "Disallow unused private class members", "recommended": false, "url": "https://eslint.org/docs/rules/no-unused-private-class-members" } @@ -1817,7 +1817,7 @@ "no-unused-vars": { "type": "problem", "docs": { - "description": "disallow unused variables", + "description": "Disallow unused variables", "recommended": true, "url": "https://eslint.org/docs/rules/no-unused-vars" } @@ -1825,7 +1825,7 @@ "no-use-before-define": { "type": "problem", "docs": { - "description": "disallow the use of variables before they are defined", + "description": "Disallow the use of variables before they are defined", "recommended": false, "url": "https://eslint.org/docs/rules/no-use-before-define" } @@ -1833,7 +1833,7 @@ "no-useless-backreference": { "type": "problem", "docs": { - "description": "disallow useless backreferences in regular expressions", + "description": "Disallow useless backreferences in regular expressions", "recommended": true, "url": "https://eslint.org/docs/rules/no-useless-backreference" } @@ -1841,7 +1841,7 @@ "no-useless-call": { "type": "suggestion", "docs": { - "description": "disallow unnecessary calls to `.call()` and `.apply()`", + "description": "Disallow unnecessary calls to `.call()` and `.apply()`", "recommended": false, "url": "https://eslint.org/docs/rules/no-useless-call" } @@ -1849,7 +1849,7 @@ "no-useless-catch": { "type": "suggestion", "docs": { - "description": "disallow unnecessary `catch` clauses", + "description": "Disallow unnecessary `catch` clauses", "recommended": true, "url": "https://eslint.org/docs/rules/no-useless-catch" } @@ -1857,7 +1857,7 @@ "no-useless-computed-key": { "type": "suggestion", "docs": { - "description": "disallow unnecessary computed property keys in objects and classes", + "description": "Disallow unnecessary computed property keys in objects and classes", "recommended": false, "url": "https://eslint.org/docs/rules/no-useless-computed-key" }, @@ -1866,7 +1866,7 @@ "no-useless-concat": { "type": "suggestion", "docs": { - "description": "disallow unnecessary concatenation of literals or template literals", + "description": "Disallow unnecessary concatenation of literals or template literals", "recommended": false, "url": "https://eslint.org/docs/rules/no-useless-concat" } @@ -1874,7 +1874,7 @@ "no-useless-constructor": { "type": "suggestion", "docs": { - "description": "disallow unnecessary constructors", + "description": "Disallow unnecessary constructors", "recommended": false, "url": "https://eslint.org/docs/rules/no-useless-constructor" } @@ -1882,7 +1882,7 @@ "no-useless-escape": { "type": "suggestion", "docs": { - "description": "disallow unnecessary escape characters", + "description": "Disallow unnecessary escape characters", "recommended": true, "url": "https://eslint.org/docs/rules/no-useless-escape" }, @@ -1891,7 +1891,7 @@ "no-useless-rename": { "type": "suggestion", "docs": { - "description": "disallow renaming import, export, and destructured assignments to the same name", + "description": "Disallow renaming import, export, and destructured assignments to the same name", "recommended": false, "url": "https://eslint.org/docs/rules/no-useless-rename" }, @@ -1900,7 +1900,7 @@ "no-useless-return": { "type": "suggestion", "docs": { - "description": "disallow redundant return statements", + "description": "Disallow redundant return statements", "recommended": false, "url": "https://eslint.org/docs/rules/no-useless-return" }, @@ -1909,7 +1909,7 @@ "no-var": { "type": "suggestion", "docs": { - "description": "require `let` or `const` instead of `var`", + "description": "Require `let` or `const` instead of `var`", "recommended": false, "url": "https://eslint.org/docs/rules/no-var" }, @@ -1918,7 +1918,7 @@ "no-void": { "type": "suggestion", "docs": { - "description": "disallow `void` operators", + "description": "Disallow `void` operators", "recommended": false, "url": "https://eslint.org/docs/rules/no-void" } @@ -1926,7 +1926,7 @@ "no-warning-comments": { "type": "suggestion", "docs": { - "description": "disallow specified warning terms in comments", + "description": "Disallow specified warning terms in comments", "recommended": false, "url": "https://eslint.org/docs/rules/no-warning-comments" } @@ -1934,7 +1934,7 @@ "no-whitespace-before-property": { "type": "layout", "docs": { - "description": "disallow whitespace before properties", + "description": "Disallow whitespace before properties", "recommended": false, "url": "https://eslint.org/docs/rules/no-whitespace-before-property" }, @@ -1943,7 +1943,7 @@ "no-with": { "type": "suggestion", "docs": { - "description": "disallow `with` statements", + "description": "Disallow `with` statements", "recommended": true, "url": "https://eslint.org/docs/rules/no-with" } @@ -1951,7 +1951,7 @@ "nonblock-statement-body-position": { "type": "layout", "docs": { - "description": "enforce the location of single-line statements", + "description": "Enforce the location of single-line statements", "recommended": false, "url": "https://eslint.org/docs/rules/nonblock-statement-body-position" }, @@ -1960,7 +1960,7 @@ "object-curly-newline": { "type": "layout", "docs": { - "description": "enforce consistent line breaks after opening and before closing braces", + "description": "Enforce consistent line breaks after opening and before closing braces", "recommended": false, "url": "https://eslint.org/docs/rules/object-curly-newline" }, @@ -1969,7 +1969,7 @@ "object-curly-spacing": { "type": "layout", "docs": { - "description": "enforce consistent spacing inside braces", + "description": "Enforce consistent spacing inside braces", "recommended": false, "url": "https://eslint.org/docs/rules/object-curly-spacing" }, @@ -1978,7 +1978,7 @@ "object-property-newline": { "type": "layout", "docs": { - "description": "enforce placing object properties on separate lines", + "description": "Enforce placing object properties on separate lines", "recommended": false, "url": "https://eslint.org/docs/rules/object-property-newline" }, @@ -1987,7 +1987,7 @@ "object-shorthand": { "type": "suggestion", "docs": { - "description": "require or disallow method and property shorthand syntax for object literals", + "description": "Require or disallow method and property shorthand syntax for object literals", "recommended": false, "url": "https://eslint.org/docs/rules/object-shorthand" }, @@ -1996,7 +1996,7 @@ "one-var": { "type": "suggestion", "docs": { - "description": "enforce variables to be declared either together or separately in functions", + "description": "Enforce variables to be declared either together or separately in functions", "recommended": false, "url": "https://eslint.org/docs/rules/one-var" }, @@ -2005,7 +2005,7 @@ "one-var-declaration-per-line": { "type": "suggestion", "docs": { - "description": "require or disallow newlines around variable declarations", + "description": "Require or disallow newlines around variable declarations", "recommended": false, "url": "https://eslint.org/docs/rules/one-var-declaration-per-line" }, @@ -2014,7 +2014,7 @@ "operator-assignment": { "type": "suggestion", "docs": { - "description": "require or disallow assignment operator shorthand where possible", + "description": "Require or disallow assignment operator shorthand where possible", "recommended": false, "url": "https://eslint.org/docs/rules/operator-assignment" }, @@ -2023,7 +2023,7 @@ "operator-linebreak": { "type": "layout", "docs": { - "description": "enforce consistent linebreak style for operators", + "description": "Enforce consistent linebreak style for operators", "recommended": false, "url": "https://eslint.org/docs/rules/operator-linebreak" }, @@ -2032,7 +2032,7 @@ "padded-blocks": { "type": "layout", "docs": { - "description": "require or disallow padding within blocks", + "description": "Require or disallow padding within blocks", "recommended": false, "url": "https://eslint.org/docs/rules/padded-blocks" }, @@ -2041,7 +2041,7 @@ "padding-line-between-statements": { "type": "layout", "docs": { - "description": "require or disallow padding lines between statements", + "description": "Require or disallow padding lines between statements", "recommended": false, "url": "https://eslint.org/docs/rules/padding-line-between-statements" }, @@ -2050,7 +2050,7 @@ "prefer-arrow-callback": { "type": "suggestion", "docs": { - "description": "require using arrow functions for callbacks", + "description": "Require using arrow functions for callbacks", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-arrow-callback" }, @@ -2059,7 +2059,7 @@ "prefer-const": { "type": "suggestion", "docs": { - "description": "require `const` declarations for variables that are never reassigned after declared", + "description": "Require `const` declarations for variables that are never reassigned after declared", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-const" }, @@ -2068,7 +2068,7 @@ "prefer-destructuring": { "type": "suggestion", "docs": { - "description": "require destructuring from arrays and/or objects", + "description": "Require destructuring from arrays and/or objects", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-destructuring" }, @@ -2077,7 +2077,7 @@ "prefer-exponentiation-operator": { "type": "suggestion", "docs": { - "description": "disallow the use of `Math.pow` in favor of the `**` operator", + "description": "Disallow the use of `Math.pow` in favor of the `**` operator", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-exponentiation-operator" }, @@ -2086,7 +2086,7 @@ "prefer-named-capture-group": { "type": "suggestion", "docs": { - "description": "enforce using named capture group in regular expression", + "description": "Enforce using named capture group in regular expression", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-named-capture-group" } @@ -2094,7 +2094,7 @@ "prefer-numeric-literals": { "type": "suggestion", "docs": { - "description": "disallow `parseInt()` and `Number.parseInt()` in favor of binary, octal, and hexadecimal literals", + "description": "Disallow `parseInt()` and `Number.parseInt()` in favor of binary, octal, and hexadecimal literals", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-numeric-literals" }, @@ -2121,7 +2121,7 @@ "prefer-promise-reject-errors": { "type": "suggestion", "docs": { - "description": "require using Error objects as Promise rejection reasons", + "description": "Require using Error objects as Promise rejection reasons", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-promise-reject-errors" }, @@ -2130,7 +2130,7 @@ "prefer-reflect": { "type": "suggestion", "docs": { - "description": "require `Reflect` methods where applicable", + "description": "Require `Reflect` methods where applicable", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-reflect" }, @@ -2140,7 +2140,7 @@ "prefer-regex-literals": { "type": "suggestion", "docs": { - "description": "disallow use of the `RegExp` constructor in favor of regular expression literals", + "description": "Disallow use of the `RegExp` constructor in favor of regular expression literals", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-regex-literals" }, @@ -2149,7 +2149,7 @@ "prefer-rest-params": { "type": "suggestion", "docs": { - "description": "require rest parameters instead of `arguments`", + "description": "Require rest parameters instead of `arguments`", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-rest-params" } @@ -2157,7 +2157,7 @@ "prefer-spread": { "type": "suggestion", "docs": { - "description": "require spread operators instead of `.apply()`", + "description": "Require spread operators instead of `.apply()`", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-spread" }, @@ -2166,7 +2166,7 @@ "prefer-template": { "type": "suggestion", "docs": { - "description": "require template literals instead of string concatenation", + "description": "Require template literals instead of string concatenation", "recommended": false, "url": "https://eslint.org/docs/rules/prefer-template" }, @@ -2175,7 +2175,7 @@ "quote-props": { "type": "suggestion", "docs": { - "description": "require quotes around object literal property names", + "description": "Require quotes around object literal property names", "recommended": false, "url": "https://eslint.org/docs/rules/quote-props" }, @@ -2193,7 +2193,7 @@ "radix": { "type": "suggestion", "docs": { - "description": "enforce the consistent use of the radix argument when using `parseInt()`", + "description": "Enforce the consistent use of the radix argument when using `parseInt()`", "recommended": false, "url": "https://eslint.org/docs/rules/radix" }, @@ -2202,7 +2202,7 @@ "require-atomic-updates": { "type": "problem", "docs": { - "description": "disallow assignments that can lead to race conditions due to usage of `await` or `yield`", + "description": "Disallow assignments that can lead to race conditions due to usage of `await` or `yield`", "recommended": false, "url": "https://eslint.org/docs/rules/require-atomic-updates" }, @@ -2211,7 +2211,7 @@ "require-await": { "type": "suggestion", "docs": { - "description": "disallow async functions which have no `await` expression", + "description": "Disallow async functions which have no `await` expression", "recommended": false, "url": "https://eslint.org/docs/rules/require-await" } @@ -2219,7 +2219,7 @@ "require-jsdoc": { "type": "suggestion", "docs": { - "description": "require JSDoc comments", + "description": "Require JSDoc comments", "recommended": false, "url": "https://eslint.org/docs/rules/require-jsdoc" }, @@ -2229,7 +2229,7 @@ "require-unicode-regexp": { "type": "suggestion", "docs": { - "description": "enforce the use of `u` flag on RegExp", + "description": "Enforce the use of `u` flag on RegExp", "recommended": false, "url": "https://eslint.org/docs/rules/require-unicode-regexp" } @@ -2237,7 +2237,7 @@ "require-yield": { "type": "suggestion", "docs": { - "description": "require generator functions to contain `yield`", + "description": "Require generator functions to contain `yield`", "recommended": true, "url": "https://eslint.org/docs/rules/require-yield" } @@ -2245,7 +2245,7 @@ "rest-spread-spacing": { "type": "layout", "docs": { - "description": "enforce spacing between rest and spread operators and their expressions", + "description": "Enforce spacing between rest and spread operators and their expressions", "recommended": false, "url": "https://eslint.org/docs/rules/rest-spread-spacing" }, @@ -2254,7 +2254,7 @@ "semi": { "type": "layout", "docs": { - "description": "require or disallow semicolons instead of ASI", + "description": "Require or disallow semicolons instead of ASI", "recommended": false, "url": "https://eslint.org/docs/rules/semi" }, @@ -2263,7 +2263,7 @@ "semi-spacing": { "type": "layout", "docs": { - "description": "enforce consistent spacing before and after semicolons", + "description": "Enforce consistent spacing before and after semicolons", "recommended": false, "url": "https://eslint.org/docs/rules/semi-spacing" }, @@ -2272,7 +2272,7 @@ "semi-style": { "type": "layout", "docs": { - "description": "enforce location of semicolons", + "description": "Enforce location of semicolons", "recommended": false, "url": "https://eslint.org/docs/rules/semi-style" }, @@ -2281,7 +2281,7 @@ "sort-imports": { "type": "suggestion", "docs": { - "description": "enforce sorted import declarations within modules", + "description": "Enforce sorted import declarations within modules", "recommended": false, "url": "https://eslint.org/docs/rules/sort-imports" }, @@ -2290,7 +2290,7 @@ "sort-keys": { "type": "suggestion", "docs": { - "description": "require object keys to be sorted", + "description": "Require object keys to be sorted", "recommended": false, "url": "https://eslint.org/docs/rules/sort-keys" } @@ -2298,7 +2298,7 @@ "sort-vars": { "type": "suggestion", "docs": { - "description": "require variables within the same declaration block to be sorted", + "description": "Require variables within the same declaration block to be sorted", "recommended": false, "url": "https://eslint.org/docs/rules/sort-vars" }, @@ -2307,7 +2307,7 @@ "space-before-blocks": { "type": "layout", "docs": { - "description": "enforce consistent spacing before blocks", + "description": "Enforce consistent spacing before blocks", "recommended": false, "url": "https://eslint.org/docs/rules/space-before-blocks" }, @@ -2316,7 +2316,7 @@ "space-before-function-paren": { "type": "layout", "docs": { - "description": "enforce consistent spacing before `function` definition opening parenthesis", + "description": "Enforce consistent spacing before `function` definition opening parenthesis", "recommended": false, "url": "https://eslint.org/docs/rules/space-before-function-paren" }, @@ -2325,7 +2325,7 @@ "space-in-parens": { "type": "layout", "docs": { - "description": "enforce consistent spacing inside parentheses", + "description": "Enforce consistent spacing inside parentheses", "recommended": false, "url": "https://eslint.org/docs/rules/space-in-parens" }, @@ -2334,7 +2334,7 @@ "space-infix-ops": { "type": "layout", "docs": { - "description": "require spacing around infix operators", + "description": "Require spacing around infix operators", "recommended": false, "url": "https://eslint.org/docs/rules/space-infix-ops" }, @@ -2343,7 +2343,7 @@ "space-unary-ops": { "type": "layout", "docs": { - "description": "enforce consistent spacing before or after unary operators", + "description": "Enforce consistent spacing before or after unary operators", "recommended": false, "url": "https://eslint.org/docs/rules/space-unary-ops" }, @@ -2352,7 +2352,7 @@ "spaced-comment": { "type": "suggestion", "docs": { - "description": "enforce consistent spacing after the `//` or `/*` in a comment", + "description": "Enforce consistent spacing after the `//` or `/*` in a comment", "recommended": false, "url": "https://eslint.org/docs/rules/spaced-comment" }, @@ -2361,7 +2361,7 @@ "strict": { "type": "suggestion", "docs": { - "description": "require or disallow strict mode directives", + "description": "Require or disallow strict mode directives", "recommended": false, "url": "https://eslint.org/docs/rules/strict" }, @@ -2370,7 +2370,7 @@ "switch-colon-spacing": { "type": "layout", "docs": { - "description": "enforce spacing around colons of switch statements", + "description": "Enforce spacing around colons of switch statements", "recommended": false, "url": "https://eslint.org/docs/rules/switch-colon-spacing" }, @@ -2379,7 +2379,7 @@ "symbol-description": { "type": "suggestion", "docs": { - "description": "require symbol descriptions", + "description": "Require symbol descriptions", "recommended": false, "url": "https://eslint.org/docs/rules/symbol-description" }, @@ -2388,7 +2388,7 @@ "template-curly-spacing": { "type": "layout", "docs": { - "description": "require or disallow spacing around embedded expressions of template strings", + "description": "Require or disallow spacing around embedded expressions of template strings", "recommended": false, "url": "https://eslint.org/docs/rules/template-curly-spacing" }, @@ -2397,7 +2397,7 @@ "template-tag-spacing": { "type": "layout", "docs": { - "description": "require or disallow spacing between template tags and their literals", + "description": "Require or disallow spacing between template tags and their literals", "recommended": false, "url": "https://eslint.org/docs/rules/template-tag-spacing" }, @@ -2406,7 +2406,7 @@ "unicode-bom": { "type": "layout", "docs": { - "description": "require or disallow Unicode byte order mark (BOM)", + "description": "Require or disallow Unicode byte order mark (BOM)", "recommended": false, "url": "https://eslint.org/docs/rules/unicode-bom" }, @@ -2415,7 +2415,7 @@ "use-isnan": { "type": "problem", "docs": { - "description": "require calls to `isNaN()` when checking for `NaN`", + "description": "Require calls to `isNaN()` when checking for `NaN`", "recommended": true, "url": "https://eslint.org/docs/rules/use-isnan" } @@ -2423,7 +2423,7 @@ "valid-jsdoc": { "type": "suggestion", "docs": { - "description": "enforce valid JSDoc comments", + "description": "Enforce valid JSDoc comments", "recommended": false, "url": "https://eslint.org/docs/rules/valid-jsdoc" }, @@ -2434,7 +2434,7 @@ "valid-typeof": { "type": "problem", "docs": { - "description": "enforce comparing `typeof` expressions against valid strings", + "description": "Enforce comparing `typeof` expressions against valid strings", "recommended": true, "url": "https://eslint.org/docs/rules/valid-typeof" }, @@ -2443,7 +2443,7 @@ "vars-on-top": { "type": "suggestion", "docs": { - "description": "require `var` declarations be placed at the top of their containing scope", + "description": "Require `var` declarations be placed at the top of their containing scope", "recommended": false, "url": "https://eslint.org/docs/rules/vars-on-top" } @@ -2451,7 +2451,7 @@ "wrap-iife": { "type": "layout", "docs": { - "description": "require parentheses around immediate `function` invocations", + "description": "Require parentheses around immediate `function` invocations", "recommended": false, "url": "https://eslint.org/docs/rules/wrap-iife" }, @@ -2460,7 +2460,7 @@ "wrap-regex": { "type": "layout", "docs": { - "description": "require parenthesis around regex literals", + "description": "Require parenthesis around regex literals", "recommended": false, "url": "https://eslint.org/docs/rules/wrap-regex" }, @@ -2469,7 +2469,7 @@ "yield-star-spacing": { "type": "layout", "docs": { - "description": "require or disallow spacing around the `*` in `yield*` expressions", + "description": "Require or disallow spacing around the `*` in `yield*` expressions", "recommended": false, "url": "https://eslint.org/docs/rules/yield-star-spacing" }, @@ -2478,7 +2478,7 @@ "yoda": { "type": "suggestion", "docs": { - "description": "require or disallow \"Yoda\" conditions", + "description": "Require or disallow \"Yoda\" conditions", "recommended": false, "url": "https://eslint.org/docs/rules/yoda" }, diff --git a/docs/src/rules/accessor-pairs.md b/docs/src/rules/accessor-pairs.md index a03283e7da2..0ce706a7708 100644 --- a/docs/src/rules/accessor-pairs.md +++ b/docs/src/rules/accessor-pairs.md @@ -12,7 +12,6 @@ further_reading: - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Working_with_Objects --- -Enforces getter/setter pairs in objects and classes. It's a common mistake in JavaScript to create an object with just a setter for a property but never have a corresponding getter defined for it. Without a getter, you cannot read the property, so it ends up not being used. diff --git a/docs/src/rules/array-bracket-newline.md b/docs/src/rules/array-bracket-newline.md index e5efdb36f71..04b527f8aff 100644 --- a/docs/src/rules/array-bracket-newline.md +++ b/docs/src/rules/array-bracket-newline.md @@ -9,8 +9,6 @@ related_rules: -Enforces line breaks after opening and before closing array brackets. - A number of style guides require or disallow line breaks inside of array brackets. ## Rule Details diff --git a/docs/src/rules/array-bracket-spacing.md b/docs/src/rules/array-bracket-spacing.md index b4270518a6e..cc5589ef502 100644 --- a/docs/src/rules/array-bracket-spacing.md +++ b/docs/src/rules/array-bracket-spacing.md @@ -11,8 +11,6 @@ related_rules: -Disallows or enforce spaces inside of brackets. - A number of style guides require or disallow spaces between array brackets and other tokens. This rule applies to both array literals and destructuring assignments (ECMAScript 6). diff --git a/docs/src/rules/array-callback-return.md b/docs/src/rules/array-callback-return.md index 1c63c6f2766..ebd7e977010 100644 --- a/docs/src/rules/array-callback-return.md +++ b/docs/src/rules/array-callback-return.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/array-callb rule_type: problem --- -Enforces return statements in callbacks of array's methods. `Array` has several methods for filtering, mapping, and folding. If we forget to write `return` statement in a callback of those, it's probably a mistake. If you don't want to use a return or don't need the returned results, consider using [.forEach](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach) instead. diff --git a/docs/src/rules/array-element-newline.md b/docs/src/rules/array-element-newline.md index f1e0c8a9723..ec21c6fbaae 100644 --- a/docs/src/rules/array-element-newline.md +++ b/docs/src/rules/array-element-newline.md @@ -16,8 +16,6 @@ related_rules: -Enforces line breaks between array elements. - A number of style guides require or disallow line breaks between array elements. ## Rule Details diff --git a/docs/src/rules/arrow-parens.md b/docs/src/rules/arrow-parens.md index 5e5ff03bd58..66c7fa8bca8 100644 --- a/docs/src/rules/arrow-parens.md +++ b/docs/src/rules/arrow-parens.md @@ -9,8 +9,6 @@ further_reading: -Requires parens in arrow function arguments. - Arrow functions can omit parentheses when they have exactly one parameter. In all other cases the parameter(s) must be wrapped in parentheses. This rule enforces the consistent use of parentheses in arrow functions. diff --git a/docs/src/rules/arrow-spacing.md b/docs/src/rules/arrow-spacing.md index 0cf54c5beff..a8feec96499 100644 --- a/docs/src/rules/arrow-spacing.md +++ b/docs/src/rules/arrow-spacing.md @@ -7,8 +7,6 @@ rule_type: layout -Requires space before/after arrow function's arrow. - This rule normalize style of spacing before/after an arrow function's arrow(`=>`). ```js diff --git a/docs/src/rules/block-scoped-var.md b/docs/src/rules/block-scoped-var.md index f9fc1926d7e..4ef6548f6fc 100644 --- a/docs/src/rules/block-scoped-var.md +++ b/docs/src/rules/block-scoped-var.md @@ -8,7 +8,6 @@ further_reading: - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/var#var_hoisting --- -Enforces treating `var` as block scoped. The `block-scoped-var` rule generates warnings when variables are used outside of the block in which they were defined. This emulates C-style block scope. diff --git a/docs/src/rules/block-spacing.md b/docs/src/rules/block-spacing.md index cd090166bb1..ea3426a7854 100644 --- a/docs/src/rules/block-spacing.md +++ b/docs/src/rules/block-spacing.md @@ -10,8 +10,6 @@ related_rules: -Disallows or enforces spaces inside of blocks after opening blocks and before closing blocks. - ## Rule Details This rule enforces consistent spacing inside an open block token and the next token on the same line. This rule also enforces consistent spacing inside a close block token and previous token on the same line. diff --git a/docs/src/rules/brace-style.md b/docs/src/rules/brace-style.md index 39ddbc7168e..6320fec42d3 100644 --- a/docs/src/rules/brace-style.md +++ b/docs/src/rules/brace-style.md @@ -12,8 +12,6 @@ further_reading: -Enforces consistent brace style for blocks. - Brace style is closely related to [indent style](https://en.wikipedia.org/wiki/Indent_style) in programming and describes the placement of braces relative to their control statement and body. There are probably a dozen, if not more, brace styles in the world. The *one true brace style* is one of the most common brace styles in JavaScript, in which the opening brace of a block is placed on the same line as its corresponding statement or declaration. For example: diff --git a/docs/src/rules/callback-return.md b/docs/src/rules/callback-return.md index 57d671d216f..b9db4659f82 100644 --- a/docs/src/rules/callback-return.md +++ b/docs/src/rules/callback-return.md @@ -10,7 +10,6 @@ further_reading: - https://web.archive.org/web/20171224042620/https://docs.nodejitsu.com/articles/errors/what-are-the-error-conventions/ --- -Enforces return after callback. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/camelcase.md b/docs/src/rules/camelcase.md index fc338debb84..175e0916d0d 100644 --- a/docs/src/rules/camelcase.md +++ b/docs/src/rules/camelcase.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/camelcase.m rule_type: suggestion --- -Enforces camelcase naming convention. When it comes to naming variables, style guides generally fall into one of two camps: camelcase (`variableName`) and underscores (`variable_name`). This rule focuses on using the camelcase approach. If your style guide calls for camelCasing your variable names, then this rule is for you! diff --git a/docs/src/rules/capitalized-comments.md b/docs/src/rules/capitalized-comments.md index 7342fc48600..1334aaaa173 100644 --- a/docs/src/rules/capitalized-comments.md +++ b/docs/src/rules/capitalized-comments.md @@ -7,8 +7,6 @@ rule_type: suggestion -Enforces or disallows capitalization of the first letter of a comment. - Comments are useful for leaving information for future developers. In order for that information to be useful and not distracting, it is sometimes desirable for comments to follow a particular style. One element of comment formatting styles is whether the first word of a comment should be capitalized or lowercase. In general, no comment style is any more or less valid than any others, but many developers would agree that a consistent style can improve a project's maintainability. diff --git a/docs/src/rules/class-methods-use-this.md b/docs/src/rules/class-methods-use-this.md index 152038360be..8b3df9643a4 100644 --- a/docs/src/rules/class-methods-use-this.md +++ b/docs/src/rules/class-methods-use-this.md @@ -8,7 +8,6 @@ further_reading: - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/static --- -Enforces that class methods utilize `this`. If a class method does not use `this`, it can *sometimes* be made into a static function. If you do convert the method into a static function, instances of the class that call that particular method have to be converted to a static call as well (`MyClass.callStaticMethod()`) diff --git a/docs/src/rules/comma-dangle.md b/docs/src/rules/comma-dangle.md index 071d47bca5d..26d650210c2 100644 --- a/docs/src/rules/comma-dangle.md +++ b/docs/src/rules/comma-dangle.md @@ -7,8 +7,6 @@ rule_type: layout -Requires or disallows trailing commas. - Trailing commas in object literals are valid according to the ECMAScript 5 (and ECMAScript 3!) spec. However, IE8 (when not in IE8 document mode) and below will throw an error when it encounters trailing commas in JavaScript. ```js diff --git a/docs/src/rules/comma-spacing.md b/docs/src/rules/comma-spacing.md index 8c14a0b271f..ed4bae760c5 100644 --- a/docs/src/rules/comma-spacing.md +++ b/docs/src/rules/comma-spacing.md @@ -19,8 +19,6 @@ further_reading: -Enforces spacing around commas. - Spacing around commas improves readability of a list of items. Although most of the style guidelines for languages prescribe adding a space after a comma and not before it, it is subjective to the preferences of a project. ```js diff --git a/docs/src/rules/comma-style.md b/docs/src/rules/comma-style.md index 3efb6dc57d3..1535ef667fa 100644 --- a/docs/src/rules/comma-style.md +++ b/docs/src/rules/comma-style.md @@ -11,8 +11,6 @@ further_reading: -Enforces consistent comma styles. - The Comma Style rule enforces styles for comma-separated lists. There are two comma styles primarily used in JavaScript: * The standard style, in which commas are placed at the end of the current line diff --git a/docs/src/rules/complexity.md b/docs/src/rules/complexity.md index 72b40d83608..cb4bbdb5d2d 100644 --- a/docs/src/rules/complexity.md +++ b/docs/src/rules/complexity.md @@ -19,7 +19,6 @@ further_reading: - https://github.com/eslint/eslint/issues/4808#issuecomment-167795140 --- -Enforces a maximum cyclomatic complexity. Cyclomatic complexity measures the number of linearly independent paths through a program's source code. This rule allows setting a cyclomatic complexity threshold. diff --git a/docs/src/rules/computed-property-spacing.md b/docs/src/rules/computed-property-spacing.md index 577a51936f8..96fb8b06132 100644 --- a/docs/src/rules/computed-property-spacing.md +++ b/docs/src/rules/computed-property-spacing.md @@ -11,8 +11,6 @@ related_rules: -Disallows or enforces spaces inside of computed properties. - While formatting preferences are very personal, a number of style guides require or disallow spaces between computed properties in the following situations: diff --git a/docs/src/rules/consistent-return.md b/docs/src/rules/consistent-return.md index 8f54ef0a96e..b948bc5607c 100644 --- a/docs/src/rules/consistent-return.md +++ b/docs/src/rules/consistent-return.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/consistent- rule_type: suggestion --- -Requires `return` statements to either always or never specify values. Unlike statically-typed languages which enforce that a function returns a specified type of value, JavaScript allows different code paths in a function to return different types of values. diff --git a/docs/src/rules/consistent-this.md b/docs/src/rules/consistent-this.md index 998bef0b074..8947d92d2f4 100644 --- a/docs/src/rules/consistent-this.md +++ b/docs/src/rules/consistent-this.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/consistent- rule_type: suggestion --- -Enforces consistent naming when capturing the current execution context. It is often necessary to capture the current execution context in order to make it available subsequently. A prominent example of this are jQuery callbacks: diff --git a/docs/src/rules/curly.md b/docs/src/rules/curly.md index b9ab572b26f..15f28c6559f 100644 --- a/docs/src/rules/curly.md +++ b/docs/src/rules/curly.md @@ -7,8 +7,6 @@ rule_type: suggestion -Requires following curly brace conventions. - JavaScript allows the omission of curly braces when a block contains only one statement. However, it is considered by many to be best practice to _never_ omit curly braces around blocks, even when they are optional, because it can lead to bugs and reduces code clarity. So the following: ```js diff --git a/docs/src/rules/default-case-last.md b/docs/src/rules/default-case-last.md index 9a50eae631a..7a3c5d60524 100644 --- a/docs/src/rules/default-case-last.md +++ b/docs/src/rules/default-case-last.md @@ -9,7 +9,6 @@ further_reading: - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/switch --- -Enforces default clauses in switch statements to be last. A `switch` statement can optionally have a `default` clause. diff --git a/docs/src/rules/default-case.md b/docs/src/rules/default-case.md index 61a2ac85b9d..cab7be84046 100644 --- a/docs/src/rules/default-case.md +++ b/docs/src/rules/default-case.md @@ -7,7 +7,6 @@ related_rules: - no-fallthrough --- -Requires a `default` case in switch statements. Some code conventions require that all `switch` statements have a `default` case, even if the default case is empty, such as: diff --git a/docs/src/rules/default-param-last.md b/docs/src/rules/default-param-last.md index 17d119d40f3..b9e85c71bbd 100644 --- a/docs/src/rules/default-param-last.md +++ b/docs/src/rules/default-param-last.md @@ -5,8 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/default-par rule_type: suggestion --- -Enforces default parameters to be last. - Putting default parameter at last allows function calls to omit optional tail arguments. ```js diff --git a/docs/src/rules/dot-location.md b/docs/src/rules/dot-location.md index 9fe5ce25e8c..5650ddd3bf1 100644 --- a/docs/src/rules/dot-location.md +++ b/docs/src/rules/dot-location.md @@ -10,8 +10,6 @@ related_rules: -Enforces newline before and after dots. - JavaScript allows you to place newlines before or after a dot in a member expression. Consistency in placing a newline before or after the dot can greatly increase readability. diff --git a/docs/src/rules/dot-notation.md b/docs/src/rules/dot-notation.md index d00f49671dd..3a40363ac42 100644 --- a/docs/src/rules/dot-notation.md +++ b/docs/src/rules/dot-notation.md @@ -7,8 +7,6 @@ rule_type: suggestion -Enforces dot notation whenever possible. - In JavaScript, one can access properties using the dot notation (`foo.bar`) or square-bracket notation (`foo["bar"]`). However, the dot notation is often preferred because it is easier to read, less verbose, and works better with aggressive JavaScript minimizers. ```js diff --git a/docs/src/rules/eol-last.md b/docs/src/rules/eol-last.md index 620d4d4cdd9..a3a19f983bb 100644 --- a/docs/src/rules/eol-last.md +++ b/docs/src/rules/eol-last.md @@ -7,8 +7,6 @@ rule_type: layout -Requires or disallows newline at the end of files. - Trailing newlines in non-empty files are a common UNIX idiom. Benefits of trailing newlines include the ability to concatenate or append to files as well as output files to the terminal without interfering with shell prompts. diff --git a/docs/src/rules/eqeqeq.md b/docs/src/rules/eqeqeq.md index 3bbf3a6fe91..6c16d0454a6 100644 --- a/docs/src/rules/eqeqeq.md +++ b/docs/src/rules/eqeqeq.md @@ -7,8 +7,6 @@ rule_type: suggestion -Requires the use of `===` and `!==`. - It is considered good practice to use the type-safe equality operators `===` and `!==` instead of their regular counterparts `==` and `!=`. The reason for this is that `==` and `!=` do type coercion which follows the rather obscure [Abstract Equality Comparison Algorithm](https://www.ecma-international.org/ecma-262/5.1/#sec-11.9.3). diff --git a/docs/src/rules/for-direction.md b/docs/src/rules/for-direction.md index bfecc588ed0..c9b99d6beae 100644 --- a/docs/src/rules/for-direction.md +++ b/docs/src/rules/for-direction.md @@ -7,8 +7,6 @@ rule_type: problem -Enforces `for` loop update clause moving the counter in the right direction. - ## Rule Details A `for` loop with a stop condition that can never be reached, such as one with a counter that moves in the wrong direction, will run infinitely. While there are occasions when an infinite loop is intended, the convention is to construct such loops as `while` loops. More typically, an infinite for loop is a bug. diff --git a/docs/src/rules/func-call-spacing.md b/docs/src/rules/func-call-spacing.md index 0b2f282bf8d..cc2005660b9 100644 --- a/docs/src/rules/func-call-spacing.md +++ b/docs/src/rules/func-call-spacing.md @@ -9,8 +9,6 @@ related_rules: -Requires or disallows spacing between function identifiers and their invocations. - When calling a function, developers may insert optional whitespace between the function's name and the parentheses that invoke it. The following pairs of function calls are equivalent: ```js diff --git a/docs/src/rules/func-name-matching.md b/docs/src/rules/func-name-matching.md index 6d3d631d40c..28cf9c770df 100644 --- a/docs/src/rules/func-name-matching.md +++ b/docs/src/rules/func-name-matching.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/func-name-m rule_type: suggestion --- -Requires function names to match the name of the variable or property to which they are assigned. ## Rule Details diff --git a/docs/src/rules/func-names.md b/docs/src/rules/func-names.md index 12cd9a2c62d..bdc0ea596f0 100644 --- a/docs/src/rules/func-names.md +++ b/docs/src/rules/func-names.md @@ -8,7 +8,6 @@ further_reading: - https://2ality.com/2015/09/function-names-es6.html --- -Requires or disallows named `function` expressions. A pattern that's becoming more common is to give function expressions names to aid in debugging. For example: diff --git a/docs/src/rules/func-style.md b/docs/src/rules/func-style.md index cb36e42e9da..8897692cec0 100644 --- a/docs/src/rules/func-style.md +++ b/docs/src/rules/func-style.md @@ -7,7 +7,6 @@ further_reading: - https://www.adequatelygood.com/JavaScript-Scoping-and-Hoisting.html --- -Enforces the consistent use of either `function` declarations or expressions. There are two ways of defining functions in JavaScript: `function` declarations and `function` expressions. Declarations contain the `function` keyword first, followed by a name and then its arguments and the function body, for example: diff --git a/docs/src/rules/function-call-argument-newline.md b/docs/src/rules/function-call-argument-newline.md index 584553e1f13..6a5ffb8c173 100644 --- a/docs/src/rules/function-call-argument-newline.md +++ b/docs/src/rules/function-call-argument-newline.md @@ -12,8 +12,6 @@ related_rules: -Enforces line breaks between arguments of a function call. - A number of style guides require or disallow line breaks between arguments of a function call. ## Rule Details diff --git a/docs/src/rules/function-paren-newline.md b/docs/src/rules/function-paren-newline.md index 05611807074..da1743ca9e7 100644 --- a/docs/src/rules/function-paren-newline.md +++ b/docs/src/rules/function-paren-newline.md @@ -7,8 +7,6 @@ rule_type: layout -Enforces consistent line breaks inside function parentheses. - Many style guides require or disallow newlines inside of function parentheses. ## Rule Details diff --git a/docs/src/rules/generator-star-spacing.md b/docs/src/rules/generator-star-spacing.md index def84cc5e90..8525a0879eb 100644 --- a/docs/src/rules/generator-star-spacing.md +++ b/docs/src/rules/generator-star-spacing.md @@ -9,8 +9,6 @@ further_reading: -Enforces spacing around the `*` in generator functions. - Generators are a new type of function in ECMAScript 6 that can return multiple values over time. These special functions are indicated by placing an `*` after the `function` keyword. diff --git a/docs/src/rules/getter-return.md b/docs/src/rules/getter-return.md index a64b7b68067..31dbd108b70 100644 --- a/docs/src/rules/getter-return.md +++ b/docs/src/rules/getter-return.md @@ -10,8 +10,6 @@ further_reading: -Enforces that a `return` statement is present in property getters. - The get syntax binds an object property to a function that will be called when that property is looked up. It was first introduced in ECMAScript 5: ```js diff --git a/docs/src/rules/global-require.md b/docs/src/rules/global-require.md index 18c390905e1..6c07bbbcb7b 100644 --- a/docs/src/rules/global-require.md +++ b/docs/src/rules/global-require.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/global-requ rule_type: suggestion --- -Enforces `require()` on the top-level module scope. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/grouped-accessor-pairs.md b/docs/src/rules/grouped-accessor-pairs.md index fdddf8b7942..a9eaa212415 100644 --- a/docs/src/rules/grouped-accessor-pairs.md +++ b/docs/src/rules/grouped-accessor-pairs.md @@ -13,7 +13,6 @@ further_reading: - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes --- -Requires grouped accessor pairs in object literals and classes. A getter and setter for the same property don't necessarily have to be defined adjacent to each other. diff --git a/docs/src/rules/guard-for-in.md b/docs/src/rules/guard-for-in.md index 26c42b053c6..8e3d22e2507 100644 --- a/docs/src/rules/guard-for-in.md +++ b/docs/src/rules/guard-for-in.md @@ -10,7 +10,6 @@ further_reading: - https://2ality.com/2012/01/objects-as-maps.html --- -Requires `for in` loops to include an `if` statement. Looping over objects with a `for in` loop will include properties that are inherited through the prototype chain. This behavior can lead to unexpected items in your for loop. diff --git a/docs/src/rules/handle-callback-err.md b/docs/src/rules/handle-callback-err.md index bee6c1586c7..210b119c7d4 100644 --- a/docs/src/rules/handle-callback-err.md +++ b/docs/src/rules/handle-callback-err.md @@ -8,7 +8,6 @@ further_reading: - https://web.archive.org/web/20171224042620/https://docs.nodejitsu.com/articles/errors/what-are-the-error-conventions/ --- -Enforces callback error handling. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/id-blacklist.md b/docs/src/rules/id-blacklist.md index bfb44e22a55..3c5cce27506 100644 --- a/docs/src/rules/id-blacklist.md +++ b/docs/src/rules/id-blacklist.md @@ -5,6 +5,5 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/id-blacklis rule_type: suggestion --- -Disallows specified identifiers. This rule was **deprecated** in ESLint v7.5.0 and replaced by the [id-denylist](id-denylist) rule. diff --git a/docs/src/rules/id-denylist.md b/docs/src/rules/id-denylist.md index bbb4aec1d52..9a782d613ad 100644 --- a/docs/src/rules/id-denylist.md +++ b/docs/src/rules/id-denylist.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/id-denylist rule_type: suggestion --- -Disallows specified identifiers. > "There are only two hard things in Computer Science: cache invalidation and naming things." — Phil Karlton diff --git a/docs/src/rules/id-length.md b/docs/src/rules/id-length.md index 1f22f31b5f0..a6b5c1a4d88 100644 --- a/docs/src/rules/id-length.md +++ b/docs/src/rules/id-length.md @@ -10,7 +10,6 @@ related_rules: - camelcase --- -Enforces minimum and maximum identifier lengths. Very short identifier names like `e`, `x`, `_t` or very long ones like `hashGeneratorResultOutputContainerObject` can make code harder to read and potentially less maintainable. To prevent this, one may enforce a minimum and/or maximum identifier length. diff --git a/docs/src/rules/id-match.md b/docs/src/rules/id-match.md index 8aa52ae830f..db43aa80cda 100644 --- a/docs/src/rules/id-match.md +++ b/docs/src/rules/id-match.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/id-match.md rule_type: suggestion --- -Requires identifiers to match a specified regular expression. > "There are only two hard things in Computer Science: cache invalidation and naming things." — Phil Karlton diff --git a/docs/src/rules/implicit-arrow-linebreak.md b/docs/src/rules/implicit-arrow-linebreak.md index 20ccf5ee4e7..b7887761bad 100644 --- a/docs/src/rules/implicit-arrow-linebreak.md +++ b/docs/src/rules/implicit-arrow-linebreak.md @@ -9,8 +9,6 @@ related_rules: -Enforces the location of arrow function bodies with implicit returns. - An arrow function body can contain an implicit return as an expression instead of a block body. It can be useful to enforce a consistent location for the implicitly returned expression. ## Rule Details diff --git a/docs/src/rules/indent-legacy.md b/docs/src/rules/indent-legacy.md index 4c8fe7958f6..9c887d802a4 100644 --- a/docs/src/rules/indent-legacy.md +++ b/docs/src/rules/indent-legacy.md @@ -7,8 +7,6 @@ rule_type: layout -Enforces consistent indentation. - This rule was **deprecated** in ESLint v4.0.0. ESLint 4.0.0 introduced a rewrite of the [`indent`](/docs/rules/indent) rule, which now reports more errors than it did in previous versions. To ease the process of migrating to 4.0.0, the `indent-legacy` rule was introduced as a snapshot of the `indent` rule from ESLint 3.x. If your build is failing after the upgrade to 4.0.0, you can disable `indent` and enable `indent-legacy` as a quick fix. Eventually, you should switch back to the `indent` rule to get bugfixes and improvements in future versions. diff --git a/docs/src/rules/indent.md b/docs/src/rules/indent.md index bb37b4864e5..dbe4f9bbc3f 100644 --- a/docs/src/rules/indent.md +++ b/docs/src/rules/indent.md @@ -7,8 +7,6 @@ rule_type: layout -Enforces consistent indentation. - There are several common guidelines which require specific indentation of nested blocks and statements, like: ```js diff --git a/docs/src/rules/init-declarations.md b/docs/src/rules/init-declarations.md index a890b3cf9f4..d5ccaef69aa 100644 --- a/docs/src/rules/init-declarations.md +++ b/docs/src/rules/init-declarations.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/init-declar rule_type: suggestion --- -Requires or disallows initialization in variable declarations. In JavaScript, variables can be assigned during declaration, or at any point afterwards using an assignment statement. For example, in the following code, `foo` is initialized during declaration, while `bar` is initialized later. diff --git a/docs/src/rules/jsx-quotes.md b/docs/src/rules/jsx-quotes.md index 65e07de321b..5196e66790d 100644 --- a/docs/src/rules/jsx-quotes.md +++ b/docs/src/rules/jsx-quotes.md @@ -9,8 +9,6 @@ related_rules: -Enforces the consistent use of either double or single quotes in JSX attributes. - JSX attribute values can contain string literals, which are delimited with single or double quotes. ```xml diff --git a/docs/src/rules/key-spacing.md b/docs/src/rules/key-spacing.md index cc48fe66d76..b744ff34b5a 100644 --- a/docs/src/rules/key-spacing.md +++ b/docs/src/rules/key-spacing.md @@ -7,8 +7,6 @@ rule_type: layout -Enforces consistent spacing between keys and values in object literal properties. - This rule enforces spacing around the colon in object literal properties. It can verify each property individually, or it can ensure horizontal alignment of adjacent properties in an object literal. ## Rule Details diff --git a/docs/src/rules/keyword-spacing.md b/docs/src/rules/keyword-spacing.md index 9508bf721dc..e90244cd618 100644 --- a/docs/src/rules/keyword-spacing.md +++ b/docs/src/rules/keyword-spacing.md @@ -7,8 +7,6 @@ rule_type: layout -Enforces consistent spacing before and after keywords. - Keywords are syntax elements of JavaScript, such as `try` and `if`. These keywords have special meaning to the language and so often appear in a different color in code editors. As an important part of the language, style guides often refer to the spacing that should be used around keywords. diff --git a/docs/src/rules/line-comment-position.md b/docs/src/rules/line-comment-position.md index 2d45409b22a..a49fd00ae5a 100644 --- a/docs/src/rules/line-comment-position.md +++ b/docs/src/rules/line-comment-position.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/line-commen rule_type: layout --- -Enforces position of line comments. Line comments can be positioned above or beside code. This rule helps teams maintain a consistent style. diff --git a/docs/src/rules/linebreak-style.md b/docs/src/rules/linebreak-style.md index 57ca92938a7..ef3c071a079 100644 --- a/docs/src/rules/linebreak-style.md +++ b/docs/src/rules/linebreak-style.md @@ -7,8 +7,6 @@ rule_type: layout -Enforces consistent linebreak style. - When developing with a lot of people all having different editors, VCS applications and operating systems it may occur that different line endings are written by either of the mentioned (might especially happen when using the windows and mac versions of SourceTree together). diff --git a/docs/src/rules/lines-around-comment.md b/docs/src/rules/lines-around-comment.md index 69536e361af..e78f34b072a 100644 --- a/docs/src/rules/lines-around-comment.md +++ b/docs/src/rules/lines-around-comment.md @@ -10,8 +10,6 @@ related_rules: -Requires empty lines around comments. - Many style guides require empty lines before or after comments. The primary goal of these rules is to make the comments easier to read and improve readability of the code. diff --git a/docs/src/rules/lines-around-directive.md b/docs/src/rules/lines-around-directive.md index ca288799cd7..d3697545668 100644 --- a/docs/src/rules/lines-around-directive.md +++ b/docs/src/rules/lines-around-directive.md @@ -10,8 +10,6 @@ related_rules: -Requires or disallow newlines around directives. - This rule was **deprecated** in ESLint v4.0.0 and replaced by the [padding-line-between-statements](padding-line-between-statements) rule. Directives are used in JavaScript to indicate to the execution environment that a script would like to opt into a feature such as `"strict mode"`. Directives are grouped together in a [directive prologue](https://www.ecma-international.org/ecma-262/7.0/#directive-prologue) at the top of either a file or function block and are applied to the scope in which they occur. diff --git a/docs/src/rules/lines-between-class-members.md b/docs/src/rules/lines-between-class-members.md index 017d91a5655..42ebf9d2a83 100644 --- a/docs/src/rules/lines-between-class-members.md +++ b/docs/src/rules/lines-between-class-members.md @@ -10,8 +10,6 @@ related_rules: -Requires or disallows an empty line between class members. - This rule improves readability by enforcing lines between class members. It will not check empty lines before the first member and after the last member, since that is already taken care of by padded-blocks. ## Rule Details diff --git a/docs/src/rules/max-classes-per-file.md b/docs/src/rules/max-classes-per-file.md index e34cb2f10bb..ef02619fe5b 100644 --- a/docs/src/rules/max-classes-per-file.md +++ b/docs/src/rules/max-classes-per-file.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/max-classes rule_type: suggestion --- -Enforces a maximum number of classes per file. Files containing multiple classes can often result in a less navigable and poorly structured codebase. Best practice is to keep each file diff --git a/docs/src/rules/max-depth.md b/docs/src/rules/max-depth.md index fd3133183a0..1a31c279a38 100644 --- a/docs/src/rules/max-depth.md +++ b/docs/src/rules/max-depth.md @@ -13,7 +13,6 @@ related_rules: - max-statements --- -Enforces a maximum depth that blocks can be nested. Many developers consider code difficult to read if blocks are nested beyond a certain depth. diff --git a/docs/src/rules/max-len.md b/docs/src/rules/max-len.md index b45744c240a..216b48d80ac 100644 --- a/docs/src/rules/max-len.md +++ b/docs/src/rules/max-len.md @@ -11,7 +11,6 @@ related_rules: - max-statements --- -Enforces a maximum line length. Very long lines of code in any language can be difficult to read. In order to aid in readability and maintainability many coders have developed a convention to limit lines of code to X number of characters (traditionally 80 characters). diff --git a/docs/src/rules/max-lines-per-function.md b/docs/src/rules/max-lines-per-function.md index 0c9f7dc978a..b10aafd38df 100644 --- a/docs/src/rules/max-lines-per-function.md +++ b/docs/src/rules/max-lines-per-function.md @@ -13,7 +13,6 @@ related_rules: - max-statements-per-line --- -Enforces a maximum function length. Some people consider large functions a code smell. Large functions tend to do a lot of things and can make it hard following what's going on. Many coding style guides dictate a limit of the number of lines that a function can comprise of. This rule can help enforce that style. diff --git a/docs/src/rules/max-lines.md b/docs/src/rules/max-lines.md index 7d89abc2d46..56c8dba30db 100644 --- a/docs/src/rules/max-lines.md +++ b/docs/src/rules/max-lines.md @@ -14,7 +14,6 @@ further_reading: - https://web.archive.org/web/20160725154648/http://www.mind2b.com/component/content/article/24-software-module-size-and-file-size --- -Enforces a maximum file length. Some people consider large files a code smell. Large files tend to do a lot of things and can make it hard following what's going. While there is not an objective maximum number of lines considered acceptable in a file, most people would agree it should not be in the thousands. Recommendations usually range from 100 to 500 lines. diff --git a/docs/src/rules/max-nested-callbacks.md b/docs/src/rules/max-nested-callbacks.md index a0db2698e4a..4bdc36be86f 100644 --- a/docs/src/rules/max-nested-callbacks.md +++ b/docs/src/rules/max-nested-callbacks.md @@ -17,7 +17,6 @@ further_reading: - https://web.archive.org/web/20220127215850/https://howtonode.org/control-flow-part-ii --- -Enforces a maximum depth that callbacks can be nested. Many JavaScript libraries use the callback pattern to manage asynchronous operations. A program of any complexity will most likely need to manage several asynchronous operations at various levels of concurrency. A common pitfall that is easy to fall into is nesting callbacks, which makes code more difficult to read the deeper the callbacks are nested. diff --git a/docs/src/rules/max-params.md b/docs/src/rules/max-params.md index 80a880b49f3..5a3a4ed8a2f 100644 --- a/docs/src/rules/max-params.md +++ b/docs/src/rules/max-params.md @@ -13,7 +13,6 @@ related_rules: - max-statements --- -Enforces a maximum number of parameters in function definitions. Functions that take numerous parameters can be difficult to read and write because it requires the memorization of what each parameter is, its type, and the order they should appear in. As a result, many coders adhere to a convention that caps the number of parameters a function can take. diff --git a/docs/src/rules/max-statements-per-line.md b/docs/src/rules/max-statements-per-line.md index 9f44924641d..ee5a9b730ff 100644 --- a/docs/src/rules/max-statements-per-line.md +++ b/docs/src/rules/max-statements-per-line.md @@ -13,7 +13,6 @@ related_rules: - max-statements --- -Enforces a maximum number of statements allowed per line. A line of code containing too many statements can be difficult to read. Code is generally read from the top down, especially when scanning, so limiting the number of statements allowed on a single line can be very beneficial for readability and maintainability. diff --git a/docs/src/rules/max-statements.md b/docs/src/rules/max-statements.md index bb4e8c99211..ec981ba424c 100644 --- a/docs/src/rules/max-statements.md +++ b/docs/src/rules/max-statements.md @@ -13,7 +13,6 @@ related_rules: - max-params --- -Enforces a maximum number of statements allowed in function blocks. The `max-statements` rule allows you to specify the maximum number of statements allowed in a function. diff --git a/docs/src/rules/multiline-comment-style.md b/docs/src/rules/multiline-comment-style.md index 51ff098c6b1..243cbc58cfc 100644 --- a/docs/src/rules/multiline-comment-style.md +++ b/docs/src/rules/multiline-comment-style.md @@ -7,8 +7,6 @@ rule_type: suggestion -Enforces a particular style for multiline comments. - Many style guides require a particular style for comments that span multiple lines. For example, some style guides prefer the use of a single block comment for multiline comments, whereas other style guides prefer consecutive line comments. ## Rule Details diff --git a/docs/src/rules/multiline-ternary.md b/docs/src/rules/multiline-ternary.md index e5577d58026..9f309efba45 100644 --- a/docs/src/rules/multiline-ternary.md +++ b/docs/src/rules/multiline-ternary.md @@ -9,8 +9,6 @@ related_rules: -Enforces or disallows newlines between operands of ternary expressions. - JavaScript allows operands of ternary expressions to be separated by newlines, which can improve the readability of your program. For example: diff --git a/docs/src/rules/new-cap.md b/docs/src/rules/new-cap.md index 170207a3bf9..1309ee821f7 100644 --- a/docs/src/rules/new-cap.md +++ b/docs/src/rules/new-cap.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/new-cap.md rule_type: suggestion --- -Requires constructor names to begin with a capital letter. The `new` operator in JavaScript creates a new instance of a particular type of object. That type of object is represented by a constructor function. Since constructor functions are just regular functions, the only defining characteristic is that `new` is being used as part of the call. Native JavaScript functions begin with an uppercase letter to distinguish those functions that are to be used as constructors from functions that are not. Many style guides recommend following this pattern to more easily determine which functions are to be used as constructors. diff --git a/docs/src/rules/new-parens.md b/docs/src/rules/new-parens.md index c3d1c59fd12..b51bdfe52d2 100644 --- a/docs/src/rules/new-parens.md +++ b/docs/src/rules/new-parens.md @@ -7,8 +7,6 @@ rule_type: layout -Requires parentheses when invoking a constructor with no arguments. - JavaScript allows the omission of parentheses when invoking a function via the `new` keyword and the constructor has no arguments. However, some coders believe that omitting the parentheses is inconsistent with the rest of the language and thus makes code less clear. ```js diff --git a/docs/src/rules/newline-after-var.md b/docs/src/rules/newline-after-var.md index 2f6a61cbd3e..da6f6e22cb0 100644 --- a/docs/src/rules/newline-after-var.md +++ b/docs/src/rules/newline-after-var.md @@ -7,8 +7,6 @@ rule_type: layout -Requires or disallows an empty line after variable declarations. - This rule was **deprecated** in ESLint v4.0.0 and replaced by the [padding-line-between-statements](padding-line-between-statements) rule. As of today there is no consistency in separating variable declarations from the rest of the code. Some developers leave an empty line between var statements and the rest of the code like: diff --git a/docs/src/rules/newline-before-return.md b/docs/src/rules/newline-before-return.md index 03b36e3f04d..62f12881a57 100644 --- a/docs/src/rules/newline-before-return.md +++ b/docs/src/rules/newline-before-return.md @@ -9,8 +9,6 @@ related_rules: -Requires an empty line before `return` statements. - This rule was **deprecated** in ESLint v4.0.0 and replaced by the [padding-line-between-statements](padding-line-between-statements) rule. There is no hard and fast rule about whether empty lines should precede `return` statements in JavaScript. However, clearly delineating where a function is returning can greatly increase the readability and clarity of the code. For example: diff --git a/docs/src/rules/newline-per-chained-call.md b/docs/src/rules/newline-per-chained-call.md index fba64e1f676..88d677c9598 100644 --- a/docs/src/rules/newline-per-chained-call.md +++ b/docs/src/rules/newline-per-chained-call.md @@ -7,8 +7,6 @@ rule_type: layout -Requires a newline after each call in a method chain. - Chained method calls on a single line without line breaks are harder to read, so some developers place a newline character after each method call in the chain to make it more readable and easy to maintain. Let's look at the following perfectly valid (but single line) code. diff --git a/docs/src/rules/no-alert.md b/docs/src/rules/no-alert.md index 2b7bc2d416a..4dcfdf97286 100644 --- a/docs/src/rules/no-alert.md +++ b/docs/src/rules/no-alert.md @@ -8,7 +8,6 @@ related_rules: - no-debugger --- -Disallows the use of `alert`, `confirm`, and `prompt`. JavaScript's `alert`, `confirm`, and `prompt` functions are widely considered to be obtrusive as UI elements and should be replaced by a more appropriate custom UI implementation. Furthermore, `alert` is often used while debugging code, which should be removed before deployment to production. diff --git a/docs/src/rules/no-array-constructor.md b/docs/src/rules/no-array-constructor.md index 4a7ac5cc2cf..9a96c5cc6a0 100644 --- a/docs/src/rules/no-array-constructor.md +++ b/docs/src/rules/no-array-constructor.md @@ -8,7 +8,6 @@ related_rules: - no-new-wrappers --- -Disallows `Array` constructors. Use of the `Array` constructor to construct a new array is generally discouraged in favor of array literal notation because of the single-argument diff --git a/docs/src/rules/no-async-promise-executor.md b/docs/src/rules/no-async-promise-executor.md index da6e00b1977..b32f137caee 100644 --- a/docs/src/rules/no-async-promise-executor.md +++ b/docs/src/rules/no-async-promise-executor.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows using an async function as a Promise executor. - The `new Promise` constructor accepts an *executor* function as an argument, which has `resolve` and `reject` parameters that can be used to control the state of the created Promise. For example: ```js diff --git a/docs/src/rules/no-await-in-loop.md b/docs/src/rules/no-await-in-loop.md index ff360b82a6a..6c2c1041992 100644 --- a/docs/src/rules/no-await-in-loop.md +++ b/docs/src/rules/no-await-in-loop.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-await-in rule_type: problem --- -Disallows `await` inside of loops. Performing an operation on each element of an iterable is a common task. However, performing an `await` as part of each operation is an indication that the program is not taking full advantage of diff --git a/docs/src/rules/no-bitwise.md b/docs/src/rules/no-bitwise.md index 16cc33ea36d..1cdbb60d9a7 100644 --- a/docs/src/rules/no-bitwise.md +++ b/docs/src/rules/no-bitwise.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-bitwise. rule_type: suggestion --- -Disallows bitwise operators. The use of bitwise operators in JavaScript is very rare and often `&` or `|` is simply a mistyped `&&` or `||`, which will lead to unexpected behavior. diff --git a/docs/src/rules/no-buffer-constructor.md b/docs/src/rules/no-buffer-constructor.md index 754e5e61210..96da4d15644 100644 --- a/docs/src/rules/no-buffer-constructor.md +++ b/docs/src/rules/no-buffer-constructor.md @@ -9,7 +9,6 @@ further_reading: - https://github.com/nodejs/node/issues/4660 --- -Disallows use of the `Buffer()` constructor. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/no-caller.md b/docs/src/rules/no-caller.md index c11dd9fd5f1..2dfabff100b 100644 --- a/docs/src/rules/no-caller.md +++ b/docs/src/rules/no-caller.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-caller.m rule_type: suggestion --- -Disallows use of `caller`/`callee`. The use of `arguments.caller` and `arguments.callee` make several code optimizations impossible. They have been deprecated in future versions of JavaScript and their use is forbidden in ECMAScript 5 while in strict mode. diff --git a/docs/src/rules/no-case-declarations.md b/docs/src/rules/no-case-declarations.md index c5a5c1bedb9..589c84ec3f5 100644 --- a/docs/src/rules/no-case-declarations.md +++ b/docs/src/rules/no-case-declarations.md @@ -9,8 +9,6 @@ related_rules: -Disallows lexical declarations in case/default clauses. - This rule disallows lexical declarations (`let`, `const`, `function` and `class`) in `case`/`default` clauses. The reason is that the lexical declaration is visible in the entire switch block but it only gets initialized when it is assigned, which diff --git a/docs/src/rules/no-catch-shadow.md b/docs/src/rules/no-catch-shadow.md index 1032c56bae4..08a484fb047 100644 --- a/docs/src/rules/no-catch-shadow.md +++ b/docs/src/rules/no-catch-shadow.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-catch-sh rule_type: suggestion --- -Disallows shadowing of variables inside of catch. This rule was **deprecated** in ESLint v5.1.0. diff --git a/docs/src/rules/no-class-assign.md b/docs/src/rules/no-class-assign.md index 9b0a5b38b3a..fa80612d768 100644 --- a/docs/src/rules/no-class-assign.md +++ b/docs/src/rules/no-class-assign.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows modifying variables of class declarations. - `ClassDeclaration` creates a variable, and we can modify the variable. ```js diff --git a/docs/src/rules/no-compare-neg-zero.md b/docs/src/rules/no-compare-neg-zero.md index ce5e2e11f16..20e584a0868 100644 --- a/docs/src/rules/no-compare-neg-zero.md +++ b/docs/src/rules/no-compare-neg-zero.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows comparing against `-0`. - ## Rule Details The rule should warn against code that tries to compare against `-0`, since that will not work as intended. That is, code like `x === -0` will pass for both `+0` and `-0`. The author probably intended `Object.is(x, -0)`. diff --git a/docs/src/rules/no-cond-assign.md b/docs/src/rules/no-cond-assign.md index 78c86e91a9b..f223ee7ec39 100644 --- a/docs/src/rules/no-cond-assign.md +++ b/docs/src/rules/no-cond-assign.md @@ -9,8 +9,6 @@ related_rules: -Disallows assignment operators in conditional statements. - In conditional statements, it is very easy to mistype a comparison operator (such as `==`) as an assignment operator (such as `=`). For example: ```js diff --git a/docs/src/rules/no-confusing-arrow.md b/docs/src/rules/no-confusing-arrow.md index 4e549f33f53..be4bb96fd5a 100644 --- a/docs/src/rules/no-confusing-arrow.md +++ b/docs/src/rules/no-confusing-arrow.md @@ -10,8 +10,6 @@ related_rules: -Disallows arrow functions where they could be confused with comparisons. - Arrow functions (`=>`) are similar in syntax to some comparison operators (`>`, `<`, `<=`, and `>=`). This rule warns against using the arrow function syntax in places where it could be confused with a comparison operator. Here's an example where the usage of `=>` could be confusing: diff --git a/docs/src/rules/no-console.md b/docs/src/rules/no-console.md index a970653b28b..5fdfbae020c 100644 --- a/docs/src/rules/no-console.md +++ b/docs/src/rules/no-console.md @@ -8,7 +8,6 @@ related_rules: - no-debugger --- -Disallows the use of `console`. In JavaScript that is designed to be executed in the browser, it's considered a best practice to avoid using methods on `console`. Such messages are considered to be for debugging purposes and therefore not suitable to ship to the client. In general, calls using `console` should be stripped before being pushed to production. diff --git a/docs/src/rules/no-const-assign.md b/docs/src/rules/no-const-assign.md index c9885fe90b6..38b59bae4f1 100644 --- a/docs/src/rules/no-const-assign.md +++ b/docs/src/rules/no-const-assign.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows modifying variables that are declared using `const`. - We cannot modify variables that are declared using `const` keyword. It will raise a runtime error. diff --git a/docs/src/rules/no-constant-binary-expression.md b/docs/src/rules/no-constant-binary-expression.md index 4375ed8a934..0f0eb7bd592 100644 --- a/docs/src/rules/no-constant-binary-expression.md +++ b/docs/src/rules/no-constant-binary-expression.md @@ -7,7 +7,6 @@ related_rules: - no-constant-condition --- -Disallows expressions where the operation doesn't affect the value. Comparisons which will always evaluate to true or false and logical expressions (`||`, `&&`, `??`) which either always short-circuit or never short-circuit are both likely indications of programmer error. diff --git a/docs/src/rules/no-constant-condition.md b/docs/src/rules/no-constant-condition.md index b5674e3d12a..959e3d6c87e 100644 --- a/docs/src/rules/no-constant-condition.md +++ b/docs/src/rules/no-constant-condition.md @@ -9,8 +9,6 @@ related_rules: -Disallows constant expressions in conditions. - A constant expression (for example, a literal) as a test condition might be a typo or development trigger for a specific behavior. For example, the following code looks as if it is not ready for production. ```js diff --git a/docs/src/rules/no-constructor-return.md b/docs/src/rules/no-constructor-return.md index ef29ce7ceee..f6e941b1b96 100644 --- a/docs/src/rules/no-constructor-return.md +++ b/docs/src/rules/no-constructor-return.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-construc rule_type: problem --- -Disallows returning values in constructor. In JavaScript, returning a value in the constructor of a class may be a mistake. Forbidding this pattern prevents mistakes resulting from unfamiliarity with the language or a copy-paste error. diff --git a/docs/src/rules/no-continue.md b/docs/src/rules/no-continue.md index 6789b0d469a..bd8ce43e117 100644 --- a/docs/src/rules/no-continue.md +++ b/docs/src/rules/no-continue.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-continue rule_type: suggestion --- -Disallows `continue` statements. The `continue` statement terminates execution of the statements in the current iteration of the current or labeled loop, and continues execution of the loop with the next iteration. When used incorrectly it makes code less testable, less readable and less maintainable. Structured control flow statements such as `if` should be used instead. diff --git a/docs/src/rules/no-control-regex.md b/docs/src/rules/no-control-regex.md index 55111279673..3e957063222 100644 --- a/docs/src/rules/no-control-regex.md +++ b/docs/src/rules/no-control-regex.md @@ -10,8 +10,6 @@ related_rules: -Disallows control characters in regular expressions. - Control characters are special, invisible characters in the ASCII range 0-31. These characters are rarely used in JavaScript strings so a regular expression containing elements that explicitly match these characters is most likely a mistake. ## Rule Details diff --git a/docs/src/rules/no-debugger.md b/docs/src/rules/no-debugger.md index d62376cdb0b..f9bd8b31f95 100644 --- a/docs/src/rules/no-debugger.md +++ b/docs/src/rules/no-debugger.md @@ -12,8 +12,6 @@ further_reading: -Disallows the use of `debugger`. - The `debugger` statement is used to tell the executing JavaScript environment to stop execution and start up a debugger at the current point in the code. This has fallen out of favor as a good practice with the advent of modern debugging and development tools. Production code should definitely not contain `debugger`, as it will cause the browser to stop executing code and open an appropriate debugger. ## Rule Details diff --git a/docs/src/rules/no-delete-var.md b/docs/src/rules/no-delete-var.md index 808c6d2b066..6abedd7f1e4 100644 --- a/docs/src/rules/no-delete-var.md +++ b/docs/src/rules/no-delete-var.md @@ -7,8 +7,6 @@ rule_type: suggestion -Disallows deleting variables. - The purpose of the `delete` operator is to remove a property from an object. Using the `delete` operator on a variable might lead to unexpected behavior. ## Rule Details diff --git a/docs/src/rules/no-div-regex.md b/docs/src/rules/no-div-regex.md index 5e7c3f0bc5d..31653a94208 100644 --- a/docs/src/rules/no-div-regex.md +++ b/docs/src/rules/no-div-regex.md @@ -10,8 +10,6 @@ related_rules: -Disallows regular expressions that look like division. - Require regex literals to escape division operators. ```js diff --git a/docs/src/rules/no-dupe-args.md b/docs/src/rules/no-dupe-args.md index d5d8df0a181..0556d70e9a0 100644 --- a/docs/src/rules/no-dupe-args.md +++ b/docs/src/rules/no-dupe-args.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows duplicate arguments in `function` definitions. - If more than one parameter has the same name in a function definition, the last occurrence "shadows" the preceding occurrences. A duplicated name might be a typing error. ## Rule Details diff --git a/docs/src/rules/no-dupe-class-members.md b/docs/src/rules/no-dupe-class-members.md index 27bc1b3fc15..cc32d47085a 100644 --- a/docs/src/rules/no-dupe-class-members.md +++ b/docs/src/rules/no-dupe-class-members.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows duplicate name in class members. - If there are declarations of the same name in class members, the last declaration overwrites other declarations silently. It can cause unexpected behaviors. diff --git a/docs/src/rules/no-dupe-else-if.md b/docs/src/rules/no-dupe-else-if.md index 0e2e2897048..b0010189e9f 100644 --- a/docs/src/rules/no-dupe-else-if.md +++ b/docs/src/rules/no-dupe-else-if.md @@ -10,8 +10,6 @@ related_rules: -Disallows duplicate conditions in `if-else-if` chains. - `if-else-if` chains are commonly used when there is a need to execute only one branch (or at most one branch) out of several possible branches, based on certain conditions. ```js diff --git a/docs/src/rules/no-dupe-keys.md b/docs/src/rules/no-dupe-keys.md index c83b944b8e7..45c8bbf3449 100644 --- a/docs/src/rules/no-dupe-keys.md +++ b/docs/src/rules/no-dupe-keys.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows duplicate keys in object literals. - Multiple properties with the same key in object literals can cause unexpected behavior in your application. ```js diff --git a/docs/src/rules/no-duplicate-case.md b/docs/src/rules/no-duplicate-case.md index 11affc0d3ae..5f221fabdc3 100644 --- a/docs/src/rules/no-duplicate-case.md +++ b/docs/src/rules/no-duplicate-case.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows duplicate `case` labels. - If a `switch` statement has duplicate test expressions in `case` clauses, it is likely that a programmer copied a `case` clause but forgot to change the test expression. ## Rule Details diff --git a/docs/src/rules/no-duplicate-imports.md b/docs/src/rules/no-duplicate-imports.md index ece810a9f60..f029093e7fe 100644 --- a/docs/src/rules/no-duplicate-imports.md +++ b/docs/src/rules/no-duplicate-imports.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-duplicat rule_type: problem --- -Disallows duplicate imports. Using a single `import` statement per module will make the code clearer because you can see everything being imported from that module on one line. diff --git a/docs/src/rules/no-else-return.md b/docs/src/rules/no-else-return.md index 8dc307a0485..8380d5a7b2e 100644 --- a/docs/src/rules/no-else-return.md +++ b/docs/src/rules/no-else-return.md @@ -7,8 +7,6 @@ rule_type: suggestion -Disallows `return` before `else`. - If an `if` block contains a `return` statement, the `else` block becomes unnecessary. Its contents can be placed outside of the block. ```js diff --git a/docs/src/rules/no-empty-character-class.md b/docs/src/rules/no-empty-character-class.md index 89038ea006b..3d8f544e6ba 100644 --- a/docs/src/rules/no-empty-character-class.md +++ b/docs/src/rules/no-empty-character-class.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows empty character classes in regular expressions. - Because empty character classes in regular expressions do not match anything, they might be typing mistakes. ```js diff --git a/docs/src/rules/no-empty-function.md b/docs/src/rules/no-empty-function.md index 13df518d3c8..192de97a3e7 100644 --- a/docs/src/rules/no-empty-function.md +++ b/docs/src/rules/no-empty-function.md @@ -7,7 +7,6 @@ related_rules: - no-empty --- -Disallows empty functions. Empty functions can reduce readability because readers need to guess whether it's intentional or not. So writing a clear comment for empty functions is a good practice. diff --git a/docs/src/rules/no-empty-pattern.md b/docs/src/rules/no-empty-pattern.md index b22a7c9daa6..a259bf22b07 100644 --- a/docs/src/rules/no-empty-pattern.md +++ b/docs/src/rules/no-empty-pattern.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows empty destructuring patterns. - When using destructuring, it's possible to create a pattern that has no effect. This happens when empty curly braces are used to the right of an embedded object destructuring pattern, such as: ```js diff --git a/docs/src/rules/no-empty.md b/docs/src/rules/no-empty.md index 4993557fd1b..70935afb3b6 100644 --- a/docs/src/rules/no-empty.md +++ b/docs/src/rules/no-empty.md @@ -9,8 +9,6 @@ related_rules: -Disallows empty block statements. - Empty block statements, while not technically errors, usually occur due to refactoring that wasn't completed. They can cause confusion when reading code. ## Rule Details diff --git a/docs/src/rules/no-eq-null.md b/docs/src/rules/no-eq-null.md index f3d82704a94..f2e17ac66c1 100644 --- a/docs/src/rules/no-eq-null.md +++ b/docs/src/rules/no-eq-null.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-eq-null. rule_type: suggestion --- -Disallows `null` comparisons without type-checking operators, Comparing to `null` without a type-checking operator (`==` or `!=`), can have unintended results as the comparison will evaluate to true when comparing to not just a `null`, but also an `undefined` value. diff --git a/docs/src/rules/no-eval.md b/docs/src/rules/no-eval.md index 5e2e43750d0..6079b168c7f 100644 --- a/docs/src/rules/no-eval.md +++ b/docs/src/rules/no-eval.md @@ -10,7 +10,6 @@ further_reading: - https://javascriptweblog.wordpress.com/2010/04/19/how-evil-is-eval/ --- -Disallows eval(). JavaScript's `eval()` function is potentially dangerous and is often misused. Using `eval()` on untrusted code can open a program up to several different injection attacks. The use of `eval()` in most contexts can be substituted for a better, alternative approach to a problem. diff --git a/docs/src/rules/no-ex-assign.md b/docs/src/rules/no-ex-assign.md index ba7d8d10718..9835a658bee 100644 --- a/docs/src/rules/no-ex-assign.md +++ b/docs/src/rules/no-ex-assign.md @@ -9,8 +9,6 @@ further_reading: -Disallows reassigning exceptions in `catch` clauses. - If a `catch` clause in a `try` statement accidentally (or purposely) assigns another value to the exception parameter, it is impossible to refer to the error from that point on. Since there is no `arguments` object to offer alternative access to this data, assignment of the parameter is absolutely destructive. diff --git a/docs/src/rules/no-extend-native.md b/docs/src/rules/no-extend-native.md index 323d5ed07e3..065b214cbc0 100644 --- a/docs/src/rules/no-extend-native.md +++ b/docs/src/rules/no-extend-native.md @@ -7,7 +7,6 @@ related_rules: - no-global-assign --- -Disallows extending of native objects. In JavaScript, you can extend any object, including builtin or "native" objects. Sometimes people change the behavior of these native objects in ways that break the assumptions made about them in other parts of the code. diff --git a/docs/src/rules/no-extra-bind.md b/docs/src/rules/no-extra-bind.md index ec078f4eb26..a783de9de28 100644 --- a/docs/src/rules/no-extra-bind.md +++ b/docs/src/rules/no-extra-bind.md @@ -10,8 +10,6 @@ further_reading: -Disallows unnecessary function binding. - The `bind()` method is used to create functions with specific `this` values and, optionally, binds arguments to specific values. When used to specify the value of `this`, it's important that the function actually uses `this` in its function body. For example: ```js diff --git a/docs/src/rules/no-extra-boolean-cast.md b/docs/src/rules/no-extra-boolean-cast.md index d32a21bc675..5429d8c6fc3 100644 --- a/docs/src/rules/no-extra-boolean-cast.md +++ b/docs/src/rules/no-extra-boolean-cast.md @@ -9,8 +9,6 @@ rule_type: suggestion -Disallows unnecessary boolean casts. - In contexts such as an `if` statement's test where the result of the expression will already be coerced to a Boolean, casting to a Boolean via double negation (`!!`) or a `Boolean` call is unnecessary. For example, these `if` statements are equivalent: ```js diff --git a/docs/src/rules/no-extra-label.md b/docs/src/rules/no-extra-label.md index 454bde82e4a..30a0ea2dcf7 100644 --- a/docs/src/rules/no-extra-label.md +++ b/docs/src/rules/no-extra-label.md @@ -11,8 +11,6 @@ related_rules: -Disallows unnecessary labels. - If a loop contains no nested loops or switches, labeling the loop is unnecessary. ```js diff --git a/docs/src/rules/no-extra-parens.md b/docs/src/rules/no-extra-parens.md index 3589486915f..669130cb074 100644 --- a/docs/src/rules/no-extra-parens.md +++ b/docs/src/rules/no-extra-parens.md @@ -13,8 +13,6 @@ further_reading: -Disallows unnecessary parentheses. - This rule restricts the use of parentheses to only where they are necessary. ## Rule Details diff --git a/docs/src/rules/no-extra-semi.md b/docs/src/rules/no-extra-semi.md index af27ac9328f..65d32df2833 100644 --- a/docs/src/rules/no-extra-semi.md +++ b/docs/src/rules/no-extra-semi.md @@ -12,8 +12,6 @@ related_rules: -Disallows unnecessary semicolons. - Typing mistakes and misunderstandings about where semicolons are required can lead to semicolons that are unnecessary. While not technically an error, extra semicolons can cause confusion when reading code. ## Rule Details diff --git a/docs/src/rules/no-fallthrough.md b/docs/src/rules/no-fallthrough.md index 4736573a7d8..ee9b4db2aab 100644 --- a/docs/src/rules/no-fallthrough.md +++ b/docs/src/rules/no-fallthrough.md @@ -9,8 +9,6 @@ related_rules: -Disallows case statement fallthroughs. - The `switch` statement in JavaScript is one of the more error-prone constructs of the language thanks in part to the ability to "fall through" from one `case` to the next. For example: ```js diff --git a/docs/src/rules/no-floating-decimal.md b/docs/src/rules/no-floating-decimal.md index 533e3134e7b..02dea7d2060 100644 --- a/docs/src/rules/no-floating-decimal.md +++ b/docs/src/rules/no-floating-decimal.md @@ -7,8 +7,6 @@ rule_type: suggestion -Disallows leading or trailing decimal points in numeric literals. - Float values in JavaScript contain a decimal point, and there is no requirement that the decimal point be preceded or followed by a number. For example, the following are all valid JavaScript numbers: ```js diff --git a/docs/src/rules/no-func-assign.md b/docs/src/rules/no-func-assign.md index e5a984a58c4..b98652c3aa1 100644 --- a/docs/src/rules/no-func-assign.md +++ b/docs/src/rules/no-func-assign.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows reassigning `function` declarations. - JavaScript functions can be written as a FunctionDeclaration `function foo() { ... }` or as a FunctionExpression `var foo = function() { ... };`. While a JavaScript interpreter might tolerate it, overwriting/reassigning a function written as a FunctionDeclaration is often indicative of a mistake or issue. ```js diff --git a/docs/src/rules/no-global-assign.md b/docs/src/rules/no-global-assign.md index ad41d1a3e4c..c7961122997 100644 --- a/docs/src/rules/no-global-assign.md +++ b/docs/src/rules/no-global-assign.md @@ -11,8 +11,6 @@ related_rules: -Disallows assignment to native objects or read-only global variables. - JavaScript environments contain a number of built-in global variables, such as `window` in browsers and `process` in Node.js. In almost all cases, you don't want to assign a value to these global variables as doing so could result in losing access to important functionality. For example, you probably don't want to do this in browser code: ```js diff --git a/docs/src/rules/no-implicit-coercion.md b/docs/src/rules/no-implicit-coercion.md index 3de46cb032e..2739292eceb 100644 --- a/docs/src/rules/no-implicit-coercion.md +++ b/docs/src/rules/no-implicit-coercion.md @@ -7,8 +7,6 @@ rule_type: suggestion -Disallows shorthand type conversions. - In JavaScript, there are a lot of different ways to convert value types. Some of them might be hard to read and understand. diff --git a/docs/src/rules/no-implicit-globals.md b/docs/src/rules/no-implicit-globals.md index ddca1632019..ce942e91c8f 100644 --- a/docs/src/rules/no-implicit-globals.md +++ b/docs/src/rules/no-implicit-globals.md @@ -12,7 +12,6 @@ further_reading: - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/let#Temporal_dead_zone --- -Disallows declarations in the global scope. It is the best practice to avoid 'polluting' the global scope with variables that are intended to be local to the script. diff --git a/docs/src/rules/no-implied-eval.md b/docs/src/rules/no-implied-eval.md index 22f5b465038..433c28360b3 100644 --- a/docs/src/rules/no-implied-eval.md +++ b/docs/src/rules/no-implied-eval.md @@ -7,7 +7,6 @@ related_rules: - no-eval --- -Disallows the use of `eval()`-like methods. It's considered a good practice to avoid using `eval()` in JavaScript. There are security and performance implications involved with doing so, which is why many linters (including ESLint) recommend disallowing `eval()`. However, there are some other ways to pass a string and have it interpreted as JavaScript code that have similar concerns. diff --git a/docs/src/rules/no-import-assign.md b/docs/src/rules/no-import-assign.md index 2421a549d43..980d230a501 100644 --- a/docs/src/rules/no-import-assign.md +++ b/docs/src/rules/no-import-assign.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows assigning to imported bindings. - The updates of imported bindings by ES Modules cause runtime errors. ## Rule Details diff --git a/docs/src/rules/no-inline-comments.md b/docs/src/rules/no-inline-comments.md index 21912325edd..4b2d9c3f92d 100644 --- a/docs/src/rules/no-inline-comments.md +++ b/docs/src/rules/no-inline-comments.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-inline-c rule_type: suggestion --- -Disallows inline comments after code. Some style guides disallow comments on the same line as code. Code can become difficult to read if comments immediately follow the code on the same line. On the other hand, it is sometimes faster and more obvious to put comments immediately following code. diff --git a/docs/src/rules/no-inner-declarations.md b/docs/src/rules/no-inner-declarations.md index 06acca8c5fe..3f126f4344d 100644 --- a/docs/src/rules/no-inner-declarations.md +++ b/docs/src/rules/no-inner-declarations.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows variable or `function` declarations in nested blocks. - In JavaScript, prior to ES6, a function declaration is only allowed in the first level of a program or the body of another function, though parsers sometimes [erroneously accept them elsewhere](https://code.google.com/p/esprima/issues/detail?id=422). This only applies to function declarations; named or anonymous function expressions can occur anywhere an expression is permitted. ```js diff --git a/docs/src/rules/no-invalid-regexp.md b/docs/src/rules/no-invalid-regexp.md index c203fec5a91..42c8d7bf348 100644 --- a/docs/src/rules/no-invalid-regexp.md +++ b/docs/src/rules/no-invalid-regexp.md @@ -9,8 +9,6 @@ further_reading: -Disallows invalid regular expression strings in `RegExp` constructors. - An invalid pattern in a regular expression literal is a `SyntaxError` when the code is parsed, but an invalid string in `RegExp` constructors throws a `SyntaxError` only when the code is executed. ## Rule Details diff --git a/docs/src/rules/no-invalid-this.md b/docs/src/rules/no-invalid-this.md index 187ed11df30..2fb5ec8b63c 100644 --- a/docs/src/rules/no-invalid-this.md +++ b/docs/src/rules/no-invalid-this.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-invalid- rule_type: suggestion --- -Disallows use of `this` in contexts where the value of `this` is `undefined`. Under the strict mode, `this` keywords outside of classes or class-like objects might be `undefined` and raise a `TypeError`. diff --git a/docs/src/rules/no-irregular-whitespace.md b/docs/src/rules/no-irregular-whitespace.md index e4d0a6096d5..5996fb53021 100644 --- a/docs/src/rules/no-irregular-whitespace.md +++ b/docs/src/rules/no-irregular-whitespace.md @@ -10,8 +10,6 @@ further_reading: -Disallows irregular whitespace characters. - Invalid or irregular whitespace causes issues with ECMAScript 5 parsers and also makes code harder to debug in a similar nature to mixed tabs and spaces. Various whitespace characters can be inputted by programmers by mistake for example from copying or keyboard shortcuts. Pressing Alt + Space on macOS adds in a non breaking space character for example. diff --git a/docs/src/rules/no-iterator.md b/docs/src/rules/no-iterator.md index 9abb28e96ea..fba039adcbd 100644 --- a/docs/src/rules/no-iterator.md +++ b/docs/src/rules/no-iterator.md @@ -9,7 +9,6 @@ further_reading: - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Deprecated_and_obsolete_features#Object_methods --- -Disallows the use of the `__iterator__` property. The `__iterator__` property was a SpiderMonkey extension to JavaScript that could be used to create custom iterators that are compatible with JavaScript's `for in` and `for each` constructs. However, this property is now obsolete, so it should not be used. Here's an example of how this used to work: diff --git a/docs/src/rules/no-label-var.md b/docs/src/rules/no-label-var.md index 9785c9417ac..c0a1ec13c4c 100644 --- a/docs/src/rules/no-label-var.md +++ b/docs/src/rules/no-label-var.md @@ -9,7 +9,6 @@ related_rules: - no-unused-labels --- -Disallows labels that are variable names. ## Rule Details diff --git a/docs/src/rules/no-labels.md b/docs/src/rules/no-labels.md index a772673f814..6df5f52fab6 100644 --- a/docs/src/rules/no-labels.md +++ b/docs/src/rules/no-labels.md @@ -9,7 +9,6 @@ related_rules: - no-unused-labels --- -Disallows labeled statements. Labeled statements in JavaScript are used in conjunction with `break` and `continue` to control flow around multiple loops. For example: diff --git a/docs/src/rules/no-lone-blocks.md b/docs/src/rules/no-lone-blocks.md index fad22b2c227..8255b3dafba 100644 --- a/docs/src/rules/no-lone-blocks.md +++ b/docs/src/rules/no-lone-blocks.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-lone-blo rule_type: suggestion --- -Disallows unnecessary nested blocks. In JavaScript, prior to ES6, standalone code blocks delimited by curly braces do not create a new scope and have no use. For example, these curly braces do nothing to `foo`: diff --git a/docs/src/rules/no-lonely-if.md b/docs/src/rules/no-lonely-if.md index 8c4d9672870..1ef30c57244 100644 --- a/docs/src/rules/no-lonely-if.md +++ b/docs/src/rules/no-lonely-if.md @@ -7,8 +7,6 @@ rule_type: suggestion -Disallows `if` statements as the only statement in `else` blocks. - If an `if` statement is the only statement in the `else` block, it is often clearer to use an `else if` form. ```js diff --git a/docs/src/rules/no-loop-func.md b/docs/src/rules/no-loop-func.md index f8aac815a2a..e37fe82a1e0 100644 --- a/docs/src/rules/no-loop-func.md +++ b/docs/src/rules/no-loop-func.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-loop-fun rule_type: suggestion --- -Disallows functions in loops. Writing functions within loops tends to result in errors due to the way the function creates a closure around the loop. For example: diff --git a/docs/src/rules/no-loss-of-precision.md b/docs/src/rules/no-loss-of-precision.md index f563dc83e83..3932866036e 100644 --- a/docs/src/rules/no-loss-of-precision.md +++ b/docs/src/rules/no-loss-of-precision.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows number literals that lose precision. - This rule would disallow the use of number literals that immediately lose precision at runtime when converted to a JS `Number` due to 64-bit floating-point rounding. ## Rule Details diff --git a/docs/src/rules/no-magic-numbers.md b/docs/src/rules/no-magic-numbers.md index 7bf5343b5ec..ad64a841104 100644 --- a/docs/src/rules/no-magic-numbers.md +++ b/docs/src/rules/no-magic-numbers.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-magic-nu rule_type: suggestion --- -Disallows magic numbers. 'Magic numbers' are numbers that occur multiple times in code without an explicit meaning. They should preferably be replaced by named constants. diff --git a/docs/src/rules/no-misleading-character-class.md b/docs/src/rules/no-misleading-character-class.md index 142b476643f..a3d156a4a4c 100644 --- a/docs/src/rules/no-misleading-character-class.md +++ b/docs/src/rules/no-misleading-character-class.md @@ -9,8 +9,6 @@ rule_type: problem -Disallows characters which are made with multiple code points in character class syntax. - Unicode includes the characters which are made with multiple code points. RegExp character class syntax (`/[abc]/`) cannot handle characters which are made by multiple code points as a character; those characters will be dissolved to each code point. For example, `❇️` is made by `❇` (`U+2747`) and VARIATION SELECTOR-16 (`U+FE0F`). If this character is in RegExp character class, it will match to either `❇` (`U+2747`) or VARIATION SELECTOR-16 (`U+FE0F`) rather than `❇️`. diff --git a/docs/src/rules/no-mixed-operators.md b/docs/src/rules/no-mixed-operators.md index 67f50e9c2d7..e55ede01aa4 100644 --- a/docs/src/rules/no-mixed-operators.md +++ b/docs/src/rules/no-mixed-operators.md @@ -7,7 +7,6 @@ related_rules: - no-extra-parens --- -Disallows mixes of different operators. Enclosing complex expressions by parentheses clarifies the developer's intention, which makes the code more readable. This rule warns when different operators are used consecutively without parentheses in an expression. diff --git a/docs/src/rules/no-mixed-requires.md b/docs/src/rules/no-mixed-requires.md index 9ba7358c218..6584e8fb7f1 100644 --- a/docs/src/rules/no-mixed-requires.md +++ b/docs/src/rules/no-mixed-requires.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-mixed-re rule_type: suggestion --- -Disallows `require` calls to be mixed with regular variable declarations. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/no-mixed-spaces-and-tabs.md b/docs/src/rules/no-mixed-spaces-and-tabs.md index b9b1d00d446..0dc791a9a35 100644 --- a/docs/src/rules/no-mixed-spaces-and-tabs.md +++ b/docs/src/rules/no-mixed-spaces-and-tabs.md @@ -9,8 +9,6 @@ further_reading: -Disallows mixed spaces and tabs for indentation. - Most code conventions require either tabs or spaces be used for indentation. As such, it's usually an error if a single line of code is indented with both tabs and spaces. ## Rule Details diff --git a/docs/src/rules/no-multi-assign.md b/docs/src/rules/no-multi-assign.md index 2335e755cf7..a6b08849cb4 100644 --- a/docs/src/rules/no-multi-assign.md +++ b/docs/src/rules/no-multi-assign.md @@ -7,7 +7,6 @@ related_rules: - max-statements-per-line --- -Disallows use of chained assignment expressions. Chaining the assignment of variables can lead to unexpected results and be difficult to read. diff --git a/docs/src/rules/no-multi-spaces.md b/docs/src/rules/no-multi-spaces.md index 6ad2e89ec11..e8a38dd96b9 100644 --- a/docs/src/rules/no-multi-spaces.md +++ b/docs/src/rules/no-multi-spaces.md @@ -15,8 +15,6 @@ related_rules: -Disallows multiple consecutive spaces. - Multiple spaces in a row that are not used for indentation are typically mistakes. For example: ```js diff --git a/docs/src/rules/no-multi-str.md b/docs/src/rules/no-multi-str.md index e5e946ff051..3548be839d8 100644 --- a/docs/src/rules/no-multi-str.md +++ b/docs/src/rules/no-multi-str.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-multi-st rule_type: suggestion --- -Disallows multiline strings. It's possible to create multiline strings in JavaScript by using a slash before a newline, such as: diff --git a/docs/src/rules/no-multiple-empty-lines.md b/docs/src/rules/no-multiple-empty-lines.md index 43fa0212fd2..5606beacf6c 100644 --- a/docs/src/rules/no-multiple-empty-lines.md +++ b/docs/src/rules/no-multiple-empty-lines.md @@ -7,8 +7,6 @@ rule_type: layout -Disallows multiple empty lines. - Some developers prefer to have multiple blank lines removed, while others feel that it helps improve readability. Whitespace is useful for separating logical sections of code, but excess whitespace takes up more of the screen. ## Rule Details diff --git a/docs/src/rules/no-native-reassign.md b/docs/src/rules/no-native-reassign.md index 6e96e61e8d2..b0146ff2eb3 100644 --- a/docs/src/rules/no-native-reassign.md +++ b/docs/src/rules/no-native-reassign.md @@ -9,7 +9,6 @@ related_rules: - no-shadow --- -Disallows reassignment of native objects. This rule was **deprecated** in ESLint v3.3.0 and replaced by the [no-global-assign](no-global-assign) rule. diff --git a/docs/src/rules/no-negated-condition.md b/docs/src/rules/no-negated-condition.md index 2da90a60dcd..3c8ff950388 100644 --- a/docs/src/rules/no-negated-condition.md +++ b/docs/src/rules/no-negated-condition.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-negated- rule_type: suggestion --- -Disallows negated conditions. Negated conditions are more difficult to understand. Code can be made more readable by inverting the condition instead. diff --git a/docs/src/rules/no-negated-in-lhs.md b/docs/src/rules/no-negated-in-lhs.md index 51061110212..02329fd2dfc 100644 --- a/docs/src/rules/no-negated-in-lhs.md +++ b/docs/src/rules/no-negated-in-lhs.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-negated- rule_type: problem --- -Disallows negating the left operand in `in` expressions. This rule was **deprecated** in ESLint v3.3.0 and replaced by the [no-unsafe-negation](no-unsafe-negation) rule. diff --git a/docs/src/rules/no-nested-ternary.md b/docs/src/rules/no-nested-ternary.md index 4a9c2bcc960..92e6a4124c0 100644 --- a/docs/src/rules/no-nested-ternary.md +++ b/docs/src/rules/no-nested-ternary.md @@ -8,7 +8,6 @@ related_rules: - no-unneeded-ternary --- -Disallows nested ternary expressions. Nesting ternary expressions can make code more difficult to understand. diff --git a/docs/src/rules/no-new-func.md b/docs/src/rules/no-new-func.md index 5f855045a5c..a82454440f1 100644 --- a/docs/src/rules/no-new-func.md +++ b/docs/src/rules/no-new-func.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-new-func rule_type: suggestion --- -Disallows `new` operators with the `Function` object. It's possible to create functions in JavaScript from strings at runtime using the `Function` constructor, such as: diff --git a/docs/src/rules/no-new-object.md b/docs/src/rules/no-new-object.md index eede27cb437..fb007c89e41 100644 --- a/docs/src/rules/no-new-object.md +++ b/docs/src/rules/no-new-object.md @@ -8,7 +8,6 @@ related_rules: - no-new-wrappers --- -Disallows `new` operators with the `Object` object. The `Object` constructor is used to create new generic objects in JavaScript, such as: diff --git a/docs/src/rules/no-new-require.md b/docs/src/rules/no-new-require.md index 52761720842..7b684ecf29b 100644 --- a/docs/src/rules/no-new-require.md +++ b/docs/src/rules/no-new-require.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-new-requ rule_type: suggestion --- -Disallows `new` operators with calls to `require`. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/no-new-symbol.md b/docs/src/rules/no-new-symbol.md index 8f116a412cd..d28383f1e2c 100644 --- a/docs/src/rules/no-new-symbol.md +++ b/docs/src/rules/no-new-symbol.md @@ -9,8 +9,6 @@ further_reading: -Disallows `new` operators with the `Symbol` object. - `Symbol` is not intended to be used with the `new` operator, but to be called as a function. ```js diff --git a/docs/src/rules/no-new-wrappers.md b/docs/src/rules/no-new-wrappers.md index 939f4b623a0..ee5c8546d7f 100644 --- a/docs/src/rules/no-new-wrappers.md +++ b/docs/src/rules/no-new-wrappers.md @@ -10,7 +10,6 @@ further_reading: - https://www.inkling.com/read/javascript-definitive-guide-david-flanagan-6th/chapter-3/wrapper-objects --- -Disallows `new` operators with the `String`, `Number`, and `Boolean` objects. There are three primitive types in JavaScript that have wrapper objects: string, number, and boolean. These are represented by the constructors `String`, `Number`, and `Boolean`, respectively. The primitive wrapper types are used whenever one of these primitive values is read, providing them with object-like capabilities such as methods. Behind the scenes, an object of the associated wrapper type is created and then destroyed, which is why you can call methods on primitive values, such as: diff --git a/docs/src/rules/no-new.md b/docs/src/rules/no-new.md index 893b006691e..b62a2975943 100644 --- a/docs/src/rules/no-new.md +++ b/docs/src/rules/no-new.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-new.md rule_type: suggestion --- -Disallows `new` operators outside of assignments or comparisons. The goal of using `new` with a constructor is typically to create an object of a particular type and store that object in a variable, such as: diff --git a/docs/src/rules/no-nonoctal-decimal-escape.md b/docs/src/rules/no-nonoctal-decimal-escape.md index 9eef9ab13aa..ba58cbf6386 100644 --- a/docs/src/rules/no-nonoctal-decimal-escape.md +++ b/docs/src/rules/no-nonoctal-decimal-escape.md @@ -13,8 +13,6 @@ further_reading: -Disallows `\8` and `\9` escape sequences in string literals. - Although not being specified in the language until ECMAScript 2021, `\8` and `\9` escape sequences in string literals were allowed in most JavaScript engines, and treated as "useless" escapes: ```js diff --git a/docs/src/rules/no-obj-calls.md b/docs/src/rules/no-obj-calls.md index 0cfc557eba3..04cfe61b695 100644 --- a/docs/src/rules/no-obj-calls.md +++ b/docs/src/rules/no-obj-calls.md @@ -9,8 +9,6 @@ further_reading: -Disallows calling global object properties as functions. - ECMAScript provides several global objects that are intended to be used as-is. Some of these objects look as if they could be constructors due their capitalization (such as `Math` and `JSON`) but will throw an error if you try to execute them as functions. The [ECMAScript 5 specification](https://es5.github.io/#x15.8) makes it clear that both `Math` and `JSON` cannot be invoked: diff --git a/docs/src/rules/no-octal-escape.md b/docs/src/rules/no-octal-escape.md index e0f530cb45f..366b3940b67 100644 --- a/docs/src/rules/no-octal-escape.md +++ b/docs/src/rules/no-octal-escape.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-octal-es rule_type: suggestion --- -Disallows octal escape sequences in string literals. As of the ECMAScript 5 specification, octal escape sequences in string literals are deprecated and should not be used. Unicode escape sequences should be used instead. diff --git a/docs/src/rules/no-octal.md b/docs/src/rules/no-octal.md index f3c2ddcb89c..cb86480d630 100644 --- a/docs/src/rules/no-octal.md +++ b/docs/src/rules/no-octal.md @@ -7,8 +7,6 @@ rule_type: suggestion -Disallows octal literals. - Octal literals are numerals that begin with a leading zero, such as: ```js diff --git a/docs/src/rules/no-param-reassign.md b/docs/src/rules/no-param-reassign.md index 84240673f3e..694c861c109 100644 --- a/docs/src/rules/no-param-reassign.md +++ b/docs/src/rules/no-param-reassign.md @@ -7,7 +7,6 @@ further_reading: - https://spin.atomicobject.com/2011/04/10/javascript-don-t-reassign-your-function-arguments/ --- -Disallows reassignment of function parameters. Assignment to variables declared as function parameters can be misleading and lead to confusing behavior, as modifying function parameters will also mutate the `arguments` object. Often, assignment to function parameters is unintended and indicative of a mistake or programmer error. diff --git a/docs/src/rules/no-path-concat.md b/docs/src/rules/no-path-concat.md index 43d57f235b0..c1887926d37 100644 --- a/docs/src/rules/no-path-concat.md +++ b/docs/src/rules/no-path-concat.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-path-con rule_type: suggestion --- -Disallows string concatenation when using `__dirname` and `__filename`. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/no-plusplus.md b/docs/src/rules/no-plusplus.md index db4b0a2ac7e..4c1df56a7de 100644 --- a/docs/src/rules/no-plusplus.md +++ b/docs/src/rules/no-plusplus.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-plusplus rule_type: suggestion --- -Disallows the unary operators `++` and `--`. Because the unary `++` and `--` operators are subject to automatic semicolon insertion, differences in whitespace can change semantics of source code. diff --git a/docs/src/rules/no-process-env.md b/docs/src/rules/no-process-env.md index e53f7413bca..dd95ec90492 100644 --- a/docs/src/rules/no-process-env.md +++ b/docs/src/rules/no-process-env.md @@ -8,7 +8,6 @@ further_reading: - https://blog.benhall.me.uk/2012/02/storing-application-config-data-in/ --- -Disallows the use of `process.env`. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/no-process-exit.md b/docs/src/rules/no-process-exit.md index 7f45f0509cb..8af40c50f90 100644 --- a/docs/src/rules/no-process-exit.md +++ b/docs/src/rules/no-process-exit.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-process- rule_type: suggestion --- -Disallows the use of `process.exit()`. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/no-promise-executor-return.md b/docs/src/rules/no-promise-executor-return.md index 0b228506c65..ffbc12124e4 100644 --- a/docs/src/rules/no-promise-executor-return.md +++ b/docs/src/rules/no-promise-executor-return.md @@ -9,7 +9,6 @@ further_reading: - https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise --- -Disallows returning values from Promise executor functions. The `new Promise` constructor accepts a single argument, called an *executor*. diff --git a/docs/src/rules/no-proto.md b/docs/src/rules/no-proto.md index d15130406bc..c8c15e4f403 100644 --- a/docs/src/rules/no-proto.md +++ b/docs/src/rules/no-proto.md @@ -7,7 +7,6 @@ further_reading: - https://johnresig.com/blog/objectgetprototypeof/ --- -Disallows the use of the `__proto__` property. `__proto__` property has been deprecated as of ECMAScript 3.1 and shouldn't be used in the code. Use `Object.getPrototypeOf` and `Object.setPrototypeOf` instead. diff --git a/docs/src/rules/no-prototype-builtins.md b/docs/src/rules/no-prototype-builtins.md index 64faa374759..ece2bb9f1c1 100644 --- a/docs/src/rules/no-prototype-builtins.md +++ b/docs/src/rules/no-prototype-builtins.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows calling some `Object.prototype` methods directly on objects. - In ECMAScript 5.1, `Object.create` was added, which enables the creation of objects with a specified `[[Prototype]]`. `Object.create(null)` is a common pattern used to create objects that will be used as a Map. This can lead to errors when it is assumed that objects will have properties from `Object.prototype`. This rule prevents calling some `Object.prototype` methods directly from an object. Additionally, objects can have properties that shadow the builtins on `Object.prototype`, potentially causing unintended behavior or denial-of-service security vulnerabilities. For example, it would be unsafe for a webserver to parse JSON input from a client and call `hasOwnProperty` directly on the resulting object, because a malicious client could send a JSON value like `{"hasOwnProperty": 1}` and cause the server to crash. diff --git a/docs/src/rules/no-redeclare.md b/docs/src/rules/no-redeclare.md index ac6c43892bc..141339a63c6 100644 --- a/docs/src/rules/no-redeclare.md +++ b/docs/src/rules/no-redeclare.md @@ -9,8 +9,6 @@ related_rules: -Disallows variable redeclarations. - In JavaScript, it's possible to redeclare the same variable name using `var`. This can lead to confusion as to where the variable is actually declared and initialized. ## Rule Details diff --git a/docs/src/rules/no-regex-spaces.md b/docs/src/rules/no-regex-spaces.md index 11e71845778..f1c7b748b5a 100644 --- a/docs/src/rules/no-regex-spaces.md +++ b/docs/src/rules/no-regex-spaces.md @@ -12,8 +12,6 @@ related_rules: -Disallows multiple spaces in regular expression literals. - Regular expressions can be very complex and difficult to understand, which is why it's important to keep them as simple as possible in order to avoid mistakes. One of the more error-prone things you can do with a regular expression is to use more than one space, such as: ```js diff --git a/docs/src/rules/no-restricted-exports.md b/docs/src/rules/no-restricted-exports.md index e776a1fa62c..0094dc37c64 100644 --- a/docs/src/rules/no-restricted-exports.md +++ b/docs/src/rules/no-restricted-exports.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-restrict rule_type: suggestion --- -Disallows specified names in exports. In a project, certain names may be disallowed from being used as exported names for various reasons. diff --git a/docs/src/rules/no-restricted-globals.md b/docs/src/rules/no-restricted-globals.md index 1361731e282..b9be80ee9ff 100644 --- a/docs/src/rules/no-restricted-globals.md +++ b/docs/src/rules/no-restricted-globals.md @@ -8,7 +8,6 @@ related_rules: - no-restricted-syntax --- -Disallows specific global variables. Disallowing usage of specific global variables can be useful if you want to allow a set of global variables by enabling an environment, but still want to disallow some of those. diff --git a/docs/src/rules/no-restricted-imports.md b/docs/src/rules/no-restricted-imports.md index 5c03814855d..dfead74da6b 100644 --- a/docs/src/rules/no-restricted-imports.md +++ b/docs/src/rules/no-restricted-imports.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-restrict rule_type: suggestion --- -Disallows specific imports. Imports are an ES6/ES2015 standard for making the functionality of other modules available in your current module. In CommonJS this is implemented through the `require()` call which makes this ESLint rule roughly equivalent to its CommonJS counterpart `no-restricted-modules`. diff --git a/docs/src/rules/no-restricted-modules.md b/docs/src/rules/no-restricted-modules.md index 81268374668..d144fc51a74 100644 --- a/docs/src/rules/no-restricted-modules.md +++ b/docs/src/rules/no-restricted-modules.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-restrict rule_type: suggestion --- -Disallows Node.js modules. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/no-restricted-properties.md b/docs/src/rules/no-restricted-properties.md index 4566cfe875b..e3438c5b097 100644 --- a/docs/src/rules/no-restricted-properties.md +++ b/docs/src/rules/no-restricted-properties.md @@ -8,7 +8,6 @@ related_rules: - no-restricted-syntax --- -Disallows certain object properties. Certain properties on objects may be disallowed in a codebase. This is useful for deprecating an API or restricting usage of a module's methods. For example, you may want to disallow using `describe.only` when using Mocha or telling people to use `Object.assign` instead of `_.extend`. diff --git a/docs/src/rules/no-restricted-syntax.md b/docs/src/rules/no-restricted-syntax.md index 4cbc5d5b48d..9b73a9c3e62 100644 --- a/docs/src/rules/no-restricted-syntax.md +++ b/docs/src/rules/no-restricted-syntax.md @@ -10,7 +10,6 @@ related_rules: - no-restricted-properties --- -Disallows specified syntax. JavaScript has a lot of language features, and not everyone likes all of them. As a result, some projects choose to disallow the use of certain language features altogether. For instance, you might decide to disallow the use of `try-catch` or `class`, or you might decide to disallow the use of the `in` operator. diff --git a/docs/src/rules/no-return-assign.md b/docs/src/rules/no-return-assign.md index 583be8b0cdc..c180685655c 100644 --- a/docs/src/rules/no-return-assign.md +++ b/docs/src/rules/no-return-assign.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-return-a rule_type: suggestion --- -Disallows assignment operators in `return` statements. One of the interesting, and sometimes confusing, aspects of JavaScript is that assignment can happen at almost any point. Because of this, an errant equals sign can end up causing assignment when the true intent was to do a comparison. This is especially true when using a `return` statement. For example: diff --git a/docs/src/rules/no-return-await.md b/docs/src/rules/no-return-await.md index 1cf9fbfc440..d05f6367070 100644 --- a/docs/src/rules/no-return-await.md +++ b/docs/src/rules/no-return-await.md @@ -8,7 +8,6 @@ further_reading: - https://jakearchibald.com/2017/await-vs-return-vs-return-await/ --- -Disallows unnecessary `return await`. Using `return await` inside an `async function` keeps the current function in the call stack until the Promise that is being awaited has resolved, at the cost of an extra microtask before resolving the outer Promise. `return await` can also be used in a try/catch statement to catch errors from another function that returns a Promise. diff --git a/docs/src/rules/no-script-url.md b/docs/src/rules/no-script-url.md index bc91e7faa6b..f4bc56e0191 100644 --- a/docs/src/rules/no-script-url.md +++ b/docs/src/rules/no-script-url.md @@ -7,7 +7,6 @@ further_reading: - https://stackoverflow.com/questions/13497971/what-is-the-matter-with-script-targeted-urls --- -Disallows `javascript:` URLs. Using `javascript:` URLs is considered by some as a form of `eval`. Code passed in `javascript:` URLs has to be parsed and evaluated by the browser in the same way that `eval` is processed. diff --git a/docs/src/rules/no-self-assign.md b/docs/src/rules/no-self-assign.md index 646cdc4b5a0..74eac23cdf3 100644 --- a/docs/src/rules/no-self-assign.md +++ b/docs/src/rules/no-self-assign.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows assignments where both sides are exactly the same. - Self assignments have no effect, so probably those are an error due to incomplete refactoring. Those indicate that what you should do is still remaining. diff --git a/docs/src/rules/no-self-compare.md b/docs/src/rules/no-self-compare.md index 9ffb88857af..a0ba9bdd0cb 100644 --- a/docs/src/rules/no-self-compare.md +++ b/docs/src/rules/no-self-compare.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-self-com rule_type: problem --- -Disallows comparisons where both sides are exactly the same. Comparing a variable against itself is usually an error, either a typo or refactoring error. It is confusing to the reader and may potentially introduce a runtime error. diff --git a/docs/src/rules/no-sequences.md b/docs/src/rules/no-sequences.md index ca228ef3e66..6e9ab59d2e5 100644 --- a/docs/src/rules/no-sequences.md +++ b/docs/src/rules/no-sequences.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-sequence rule_type: suggestion --- -Disallows use of the comma operator. The comma operator includes multiple expressions where only one is expected. It evaluates each operand from left to right and returns the value of the last operand. However, this frequently obscures side effects, and its use is often an accident. Here are some examples of sequences: diff --git a/docs/src/rules/no-setter-return.md b/docs/src/rules/no-setter-return.md index 6934e214d0f..2538cd8f797 100644 --- a/docs/src/rules/no-setter-return.md +++ b/docs/src/rules/no-setter-return.md @@ -11,8 +11,6 @@ further_reading: -Disallows returning values from setters. - Setters cannot return values. While returning a value from a setter does not produce an error, the returned value is being ignored. Therefore, returning a value from a setter is either unnecessary or a possible error, since the returned value cannot be used. diff --git a/docs/src/rules/no-shadow-restricted-names.md b/docs/src/rules/no-shadow-restricted-names.md index 4bd48e16b2a..64a00184d41 100644 --- a/docs/src/rules/no-shadow-restricted-names.md +++ b/docs/src/rules/no-shadow-restricted-names.md @@ -12,8 +12,6 @@ further_reading: -Disallows identifiers from shadowing restricted names. - ES5 §15.1.1 Value Properties of the Global Object (`NaN`, `Infinity`, `undefined`) as well as strict mode restricted identifiers `eval` and `arguments` are considered to be restricted names in JavaScript. Defining them to mean something else can have unintended consequences and confuse others reading the code. For example, there's nothing preventing you from writing: ```js diff --git a/docs/src/rules/no-shadow.md b/docs/src/rules/no-shadow.md index 1bb49c90668..5d8ccf732e1 100644 --- a/docs/src/rules/no-shadow.md +++ b/docs/src/rules/no-shadow.md @@ -9,7 +9,6 @@ further_reading: - https://en.wikipedia.org/wiki/Variable_shadowing --- -Disallows variable declarations from shadowing variables declared in the outer scope. Shadowing is the process by which a local variable shares the same name as a variable in its containing scope. For example: diff --git a/docs/src/rules/no-spaced-func.md b/docs/src/rules/no-spaced-func.md index bffd8494779..5858cea9b44 100644 --- a/docs/src/rules/no-spaced-func.md +++ b/docs/src/rules/no-spaced-func.md @@ -7,8 +7,6 @@ rule_type: layout -Disallows spacing between function identifiers and their applications. - This rule was **deprecated** in ESLint v3.3.0 and replaced by the [func-call-spacing](func-call-spacing) rule. While it's possible to have whitespace between the name of a function and the parentheses that execute it, such patterns tend to look more like errors. diff --git a/docs/src/rules/no-sparse-arrays.md b/docs/src/rules/no-sparse-arrays.md index 99b967bf016..d948d943b48 100644 --- a/docs/src/rules/no-sparse-arrays.md +++ b/docs/src/rules/no-sparse-arrays.md @@ -9,8 +9,6 @@ further_reading: -Disallows sparse arrays. - Sparse arrays contain empty slots, most frequently due to multiple commas being used in an array literal, such as: ```js diff --git a/docs/src/rules/no-sync.md b/docs/src/rules/no-sync.md index 3f71e387cf7..1e48dd3bb8d 100644 --- a/docs/src/rules/no-sync.md +++ b/docs/src/rules/no-sync.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-sync.md rule_type: suggestion --- -Disallows synchronous methods. This rule was **deprecated** in ESLint v7.0.0. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node). diff --git a/docs/src/rules/no-tabs.md b/docs/src/rules/no-tabs.md index 8782b70b509..756070950ef 100644 --- a/docs/src/rules/no-tabs.md +++ b/docs/src/rules/no-tabs.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-tabs.md rule_type: layout --- -Disallows all tabs. Some style guides don't allow the use of tab characters at all, including within comments. diff --git a/docs/src/rules/no-template-curly-in-string.md b/docs/src/rules/no-template-curly-in-string.md index 6760c0125ee..ff968df3c97 100644 --- a/docs/src/rules/no-template-curly-in-string.md +++ b/docs/src/rules/no-template-curly-in-string.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-template rule_type: problem --- -Disallows template literal placeholder syntax in regular strings. ECMAScript 6 allows programmers to create strings containing variable or expressions using template literals, instead of string concatenation, by writing expressions like `${variable}` between two backtick quotes (\`). It can be easy to use the wrong quotes when wanting to use template literals, by writing `"${variable}"`, and end up with the literal value `"${variable}"` instead of a string containing the value of the injected expressions. diff --git a/docs/src/rules/no-ternary.md b/docs/src/rules/no-ternary.md index b6efa40550f..28c935c8b1b 100644 --- a/docs/src/rules/no-ternary.md +++ b/docs/src/rules/no-ternary.md @@ -8,7 +8,6 @@ related_rules: - no-unneeded-ternary --- -Disallows ternary operators. The ternary operator is used to conditionally assign a value to a variable. Some believe that the use of ternary operators leads to unclear code. diff --git a/docs/src/rules/no-this-before-super.md b/docs/src/rules/no-this-before-super.md index f7642049e40..0493064867c 100644 --- a/docs/src/rules/no-this-before-super.md +++ b/docs/src/rules/no-this-before-super.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows use of `this`/`super` before calling `super()` in constructors. - In the constructor of derived classes, if `this`/`super` are used before `super()` calls, it raises a reference error. This rule checks `this`/`super` keywords in constructors, then reports those that are before `super()`. diff --git a/docs/src/rules/no-throw-literal.md b/docs/src/rules/no-throw-literal.md index 285f858dd52..798d5c80eea 100644 --- a/docs/src/rules/no-throw-literal.md +++ b/docs/src/rules/no-throw-literal.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-throw-li rule_type: suggestion --- -Restricts what can be thrown as an exception. It is considered good practice to only `throw` the `Error` object itself or an object using the `Error` object as base objects for user-defined exceptions. The fundamental benefit of `Error` objects is that they automatically keep track of where they were built and originated. diff --git a/docs/src/rules/no-trailing-spaces.md b/docs/src/rules/no-trailing-spaces.md index c014289d291..40e70c52ca1 100644 --- a/docs/src/rules/no-trailing-spaces.md +++ b/docs/src/rules/no-trailing-spaces.md @@ -7,8 +7,6 @@ rule_type: layout -Disallows trailing whitespace at the end of lines. - Sometimes in the course of editing files, you can end up with extra whitespace at the end of lines. These whitespace differences can be picked up by source control systems and flagged as diffs, causing frustration for developers. While this extra whitespace causes no functional issues, many code conventions require that trailing spaces be removed before check-in. ## Rule Details diff --git a/docs/src/rules/no-undef-init.md b/docs/src/rules/no-undef-init.md index ef724a31762..6bfa7386c8f 100644 --- a/docs/src/rules/no-undef-init.md +++ b/docs/src/rules/no-undef-init.md @@ -10,8 +10,6 @@ related_rules: -Disallows initializing variables to `undefined`. - In JavaScript, a variable that is declared and not initialized to any value automatically gets the value of `undefined`. For example: ```js diff --git a/docs/src/rules/no-undef.md b/docs/src/rules/no-undef.md index 9dee7686d4a..e1e4c6780a2 100644 --- a/docs/src/rules/no-undef.md +++ b/docs/src/rules/no-undef.md @@ -10,8 +10,6 @@ related_rules: -Disallows the use of undeclared variables unless mentioned in `/*global */` comments. - This rule can help you locate potential ReferenceErrors resulting from misspellings of variable and parameter names, or accidental implicit globals (for example, from forgetting the `var` keyword in a `for` loop initializer). ## Rule Details diff --git a/docs/src/rules/no-undefined.md b/docs/src/rules/no-undefined.md index 52961fefb73..e4c561b346e 100644 --- a/docs/src/rules/no-undefined.md +++ b/docs/src/rules/no-undefined.md @@ -14,7 +14,6 @@ further_reading: - https://es5.github.io/#x15.1.1.3 --- -Disallows the use of `undefined` as an identifier. The `undefined` variable in JavaScript is actually a property of the global object. As such, in ECMAScript 3 it was possible to overwrite the value of `undefined`. While ECMAScript 5 disallows overwriting `undefined`, it's still possible to shadow `undefined`, such as: diff --git a/docs/src/rules/no-underscore-dangle.md b/docs/src/rules/no-underscore-dangle.md index ddef65ad274..82c7af71720 100644 --- a/docs/src/rules/no-underscore-dangle.md +++ b/docs/src/rules/no-underscore-dangle.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-undersco rule_type: suggestion --- -Disallows dangling underscores in identifiers. As far as naming conventions for identifiers go, dangling underscores may be the most polarizing in JavaScript. Dangling underscores are underscores at either the beginning or end of an identifier, such as: diff --git a/docs/src/rules/no-unexpected-multiline.md b/docs/src/rules/no-unexpected-multiline.md index f0bae17ca65..5e27842c8e1 100644 --- a/docs/src/rules/no-unexpected-multiline.md +++ b/docs/src/rules/no-unexpected-multiline.md @@ -11,8 +11,6 @@ related_rules: -Disallows confusing multiline expressions. - Semicolons are usually optional in JavaScript, because of automatic semicolon insertion (ASI). You can require or disallow semicolons with the [semi](./semi) rule. The rules for ASI are relatively straightforward: As once described by Isaac Schlueter, a newline character always ends a statement, just like a semicolon, **except** where one of the following is true: diff --git a/docs/src/rules/no-unmodified-loop-condition.md b/docs/src/rules/no-unmodified-loop-condition.md index b27e2d58f53..3deaa86122d 100644 --- a/docs/src/rules/no-unmodified-loop-condition.md +++ b/docs/src/rules/no-unmodified-loop-condition.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-unmodifi rule_type: problem --- -Disallows unmodified conditions of loops. Variables in a loop condition often are modified in the loop. If not, it's possibly a mistake. diff --git a/docs/src/rules/no-unneeded-ternary.md b/docs/src/rules/no-unneeded-ternary.md index 9edef217d98..6bd9d96ae8b 100644 --- a/docs/src/rules/no-unneeded-ternary.md +++ b/docs/src/rules/no-unneeded-ternary.md @@ -10,8 +10,6 @@ related_rules: -Disallows ternary operators when simpler alternatives exist. - It's a common mistake in JavaScript to use a conditional expression to select between two Boolean values instead of using ! to convert the test to a Boolean. Here are some examples: diff --git a/docs/src/rules/no-unreachable-loop.md b/docs/src/rules/no-unreachable-loop.md index f63bc041e14..b5e79ef1d2a 100644 --- a/docs/src/rules/no-unreachable-loop.md +++ b/docs/src/rules/no-unreachable-loop.md @@ -10,7 +10,6 @@ related_rules: - for-direction --- -Disallows loops with a body that allows only one iteration. A loop that can never reach the second iteration is a possible error in the code. diff --git a/docs/src/rules/no-unreachable.md b/docs/src/rules/no-unreachable.md index 78fcfe4b5d3..789815b1c03 100644 --- a/docs/src/rules/no-unreachable.md +++ b/docs/src/rules/no-unreachable.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows unreachable code after `return`, `throw`, `continue`, and `break` statements. - Because the `return`, `throw`, `break`, and `continue` statements unconditionally exit a block of code, any statements after them cannot be executed. Unreachable statements are usually a mistake. ```js diff --git a/docs/src/rules/no-unsafe-finally.md b/docs/src/rules/no-unsafe-finally.md index d02c813e45b..41d4257a472 100644 --- a/docs/src/rules/no-unsafe-finally.md +++ b/docs/src/rules/no-unsafe-finally.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows control flow statements in `finally` blocks. - JavaScript suspends the control flow statements of `try` and `catch` blocks until the execution of `finally` block finishes. So, when `return`, `throw`, `break`, or `continue` is used in `finally`, control flow statements inside `try` and `catch` are overwritten, which is considered as unexpected behavior. Such as: ```js diff --git a/docs/src/rules/no-unsafe-negation.md b/docs/src/rules/no-unsafe-negation.md index 68ff5256a6e..3bbd5b8f5f3 100644 --- a/docs/src/rules/no-unsafe-negation.md +++ b/docs/src/rules/no-unsafe-negation.md @@ -9,8 +9,6 @@ rule_type: problem -Disallows negating the left operand of relational operators. - Just as developers might type `-a + b` when they mean `-(a + b)` for the negative of a sum, they might type `!key in object` by mistake when they almost certainly mean `!(key in object)` to test that a key is not in an object. `!obj instanceof Ctor` is similar. ## Rule Details diff --git a/docs/src/rules/no-unsafe-optional-chaining.md b/docs/src/rules/no-unsafe-optional-chaining.md index 3e62aedb773..a04520df000 100644 --- a/docs/src/rules/no-unsafe-optional-chaining.md +++ b/docs/src/rules/no-unsafe-optional-chaining.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows use of optional chaining in contexts where the `undefined` value is not allowed. - The optional chaining (`?.`) expression can short-circuit with a return value of `undefined`. Therefore, treating an evaluated optional chaining expression as a function, object, number, etc., can cause TypeError or unexpected results. For example: ```js diff --git a/docs/src/rules/no-unused-expressions.md b/docs/src/rules/no-unused-expressions.md index 2fa712d9ef3..769f483527c 100644 --- a/docs/src/rules/no-unused-expressions.md +++ b/docs/src/rules/no-unused-expressions.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-unused-e rule_type: suggestion --- -Disallows unused expressions. An unused expression which has no effect on the state of the program indicates a logic error. diff --git a/docs/src/rules/no-unused-labels.md b/docs/src/rules/no-unused-labels.md index 92ccbbc7bff..5ebd95ca233 100644 --- a/docs/src/rules/no-unused-labels.md +++ b/docs/src/rules/no-unused-labels.md @@ -13,8 +13,6 @@ related_rules: -Disallows unused labels. - Labels that are declared and not used anywhere in the code are most likely an error due to incomplete refactoring. ```js diff --git a/docs/src/rules/no-unused-private-class-members.md b/docs/src/rules/no-unused-private-class-members.md index 6be1e70a791..f277c677eb8 100644 --- a/docs/src/rules/no-unused-private-class-members.md +++ b/docs/src/rules/no-unused-private-class-members.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-unused-p rule_type: problem --- -Disallows unused private class members. Private class members that are declared and not used anywhere in the code are most likely an error due to incomplete refactoring. Such class members take up space in the code and can lead to confusion by readers. diff --git a/docs/src/rules/no-unused-vars.md b/docs/src/rules/no-unused-vars.md index b96508e3cb1..06a83cab24c 100644 --- a/docs/src/rules/no-unused-vars.md +++ b/docs/src/rules/no-unused-vars.md @@ -7,8 +7,6 @@ rule_type: problem -Disallows unused variables. - Variables that are declared and not used anywhere in the code are most likely an error due to incomplete refactoring. Such variables take up space in the code and can lead to confusion by readers. ## Rule Details diff --git a/docs/src/rules/no-use-before-define.md b/docs/src/rules/no-use-before-define.md index f595f327229..01b2c387d6e 100644 --- a/docs/src/rules/no-use-before-define.md +++ b/docs/src/rules/no-use-before-define.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-use-befo rule_type: problem --- -Disallows the use of variables before they are defined. In JavaScript, prior to ES6, variable and function declarations are hoisted to the top of a scope, so it's possible to use identifiers before their formal declarations in code. This can be confusing and some believe it is best to always declare variables and functions before using them. diff --git a/docs/src/rules/no-useless-backreference.md b/docs/src/rules/no-useless-backreference.md index 0ec2dd1e25f..5178a2ec937 100644 --- a/docs/src/rules/no-useless-backreference.md +++ b/docs/src/rules/no-useless-backreference.md @@ -13,8 +13,6 @@ further_reading: -Disallows useless backreferences in regular expressions. - In JavaScript regular expressions, it's syntactically valid to define a backreference to a group that belongs to another alternative part of the pattern, a backreference to a group that appears after the backreference, a backreference to a group that contains that backreference, or a backreference to a group that is inside a negative lookaround. However, by the specification, in any of these cases the backreference always ends up matching only zero-length (the empty string), regardless of the context in which the backreference and the group appear. Backreferences that always successfully match zero-length and cannot match anything else are useless. They are basically ignored and can be removed without changing the behavior of the regular expression. diff --git a/docs/src/rules/no-useless-call.md b/docs/src/rules/no-useless-call.md index 8f1782707a4..1999cf163df 100644 --- a/docs/src/rules/no-useless-call.md +++ b/docs/src/rules/no-useless-call.md @@ -7,7 +7,6 @@ related_rules: - prefer-spread --- -Disallows unnecessary `.call()` and `.apply()`. The function invocation can be written by `Function.prototype.call()` and `Function.prototype.apply()`. But `Function.prototype.call()` and `Function.prototype.apply()` are slower than the normal function invocation. diff --git a/docs/src/rules/no-useless-catch.md b/docs/src/rules/no-useless-catch.md index 91ab6475453..4ca8cc331b0 100644 --- a/docs/src/rules/no-useless-catch.md +++ b/docs/src/rules/no-useless-catch.md @@ -7,8 +7,6 @@ rule_type: suggestion -Disallows unnecessary catch clauses. - A `catch` clause that only rethrows the original error is redundant, and has no effect on the runtime behavior of the program. These redundant clauses can be a source of confusion and code bloat, so it's better to disallow these unnecessary `catch` clauses. ## Rule Details diff --git a/docs/src/rules/no-useless-computed-key.md b/docs/src/rules/no-useless-computed-key.md index e8d52c42899..be4aa353d9f 100644 --- a/docs/src/rules/no-useless-computed-key.md +++ b/docs/src/rules/no-useless-computed-key.md @@ -7,8 +7,6 @@ rule_type: suggestion -Disallows unnecessary computed property keys in objects and classes. - It's unnecessary to use computed properties with literals such as: ```js diff --git a/docs/src/rules/no-useless-concat.md b/docs/src/rules/no-useless-concat.md index 8f7bc26f8c7..57cf297c250 100644 --- a/docs/src/rules/no-useless-concat.md +++ b/docs/src/rules/no-useless-concat.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-useless- rule_type: suggestion --- -Disallows unnecessary concatenation of strings. It's unnecessary to concatenate two strings together, such as: diff --git a/docs/src/rules/no-useless-constructor.md b/docs/src/rules/no-useless-constructor.md index 276222006fa..1830b2e085f 100644 --- a/docs/src/rules/no-useless-constructor.md +++ b/docs/src/rules/no-useless-constructor.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-useless- rule_type: suggestion --- -Disallows unnecessary constructors. ES2015 provides a default class constructor if one is not specified. As such, it is unnecessary to provide an empty constructor or one that simply delegates into its parent class, as in the following examples: diff --git a/docs/src/rules/no-useless-escape.md b/docs/src/rules/no-useless-escape.md index 6e4713d97e6..b52f569d923 100644 --- a/docs/src/rules/no-useless-escape.md +++ b/docs/src/rules/no-useless-escape.md @@ -9,8 +9,6 @@ rule_type: suggestion -Disallows unnecessary escape characters. - Escaping non-special characters in strings, template literals, and regular expressions doesn't have any effect, as demonstrated in the following example: ```js diff --git a/docs/src/rules/no-useless-rename.md b/docs/src/rules/no-useless-rename.md index 56217f6e39f..97ee34c7b30 100644 --- a/docs/src/rules/no-useless-rename.md +++ b/docs/src/rules/no-useless-rename.md @@ -9,8 +9,6 @@ related_rules: -Disallows renaming import, export, and destructured assignments to the same name. - ES2015 allows for the renaming of references in import and export statements as well as destructuring assignments. This gives programmers a concise syntax for performing these operations while renaming these references: ```js diff --git a/docs/src/rules/no-useless-return.md b/docs/src/rules/no-useless-return.md index bd8a2828a4e..e52673601f1 100644 --- a/docs/src/rules/no-useless-return.md +++ b/docs/src/rules/no-useless-return.md @@ -7,8 +7,6 @@ rule_type: suggestion -Disallows redundant return statements. - A `return;` statement with nothing after it is redundant, and has no effect on the runtime behavior of a function. This can be confusing, so it's better to disallow these redundant statements. ## Rule Details diff --git a/docs/src/rules/no-var.md b/docs/src/rules/no-var.md index 007aeca47d3..dbd266b4523 100644 --- a/docs/src/rules/no-var.md +++ b/docs/src/rules/no-var.md @@ -7,8 +7,6 @@ rule_type: suggestion -Requires `let` or `const` instead of `var`. - ECMAScript 6 allows programmers to create variables with block scope instead of function scope using the `let` and `const` keywords. Block scope is common in many other programming languages and helps programmers avoid mistakes such as: diff --git a/docs/src/rules/no-void.md b/docs/src/rules/no-void.md index d740a09b06b..6ca4a15599c 100644 --- a/docs/src/rules/no-void.md +++ b/docs/src/rules/no-void.md @@ -11,7 +11,6 @@ further_reading: - https://oreilly.com/javascript/excerpts/javascript-good-parts/bad-parts.html --- -Disallows use of the void operator. The `void` operator takes an operand and returns `undefined`: `void expression` will evaluate `expression` and return `undefined`. It can be used to ignore any side effects `expression` may produce: diff --git a/docs/src/rules/no-warning-comments.md b/docs/src/rules/no-warning-comments.md index 533c1e05162..6ddef3c5de4 100644 --- a/docs/src/rules/no-warning-comments.md +++ b/docs/src/rules/no-warning-comments.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-warning- rule_type: suggestion --- -Disallows specified warning terms in comments. Developers often add comments to code which is not complete or needs review. Most likely you want to fix or review the code, and then remove the comment, before you consider the code to be production ready. diff --git a/docs/src/rules/no-whitespace-before-property.md b/docs/src/rules/no-whitespace-before-property.md index 07e12bbf488..1a46c56b698 100644 --- a/docs/src/rules/no-whitespace-before-property.md +++ b/docs/src/rules/no-whitespace-before-property.md @@ -7,8 +7,6 @@ rule_type: layout -Disallows whitespace before properties. - JavaScript allows whitespace between objects and their properties. However, inconsistent spacing can make code harder to read and can lead to errors. ```js diff --git a/docs/src/rules/no-with.md b/docs/src/rules/no-with.md index 5c692974458..6e1740acdf3 100644 --- a/docs/src/rules/no-with.md +++ b/docs/src/rules/no-with.md @@ -9,8 +9,6 @@ further_reading: -Disallows `with` statements. - The `with` statement is potentially problematic because it adds members of an object to the current scope, making it impossible to tell what a variable inside the block actually refers to. ## Rule Details diff --git a/docs/src/rules/nonblock-statement-body-position.md b/docs/src/rules/nonblock-statement-body-position.md index 25374ba6c37..6c6c2cfdccb 100644 --- a/docs/src/rules/nonblock-statement-body-position.md +++ b/docs/src/rules/nonblock-statement-body-position.md @@ -9,8 +9,6 @@ further_reading: -Enforces the location of single-line statements. - When writing `if`, `else`, `while`, `do-while`, and `for` statements, the body can be a single statement instead of a block. It can be useful to enforce a consistent location for these single statements. For example, some developers avoid writing code like this: diff --git a/docs/src/rules/object-curly-newline.md b/docs/src/rules/object-curly-newline.md index 7ab66f03b70..6c992c7aa27 100644 --- a/docs/src/rules/object-curly-newline.md +++ b/docs/src/rules/object-curly-newline.md @@ -12,8 +12,6 @@ related_rules: -Enforces consistent line breaks after opening and before closing braces. - A number of style guides require or disallow line breaks inside of object braces and other tokens. ## Rule Details diff --git a/docs/src/rules/object-curly-spacing.md b/docs/src/rules/object-curly-spacing.md index 2434b7ca00e..0b36ade9ea9 100644 --- a/docs/src/rules/object-curly-spacing.md +++ b/docs/src/rules/object-curly-spacing.md @@ -12,8 +12,6 @@ related_rules: -Enforces consistent spacing inside braces. - While formatting preferences are very personal, a number of style guides require or disallow spaces between curly braces in the following situations: diff --git a/docs/src/rules/object-property-newline.md b/docs/src/rules/object-property-newline.md index e317bfe95a3..0b8a657b0b9 100644 --- a/docs/src/rules/object-property-newline.md +++ b/docs/src/rules/object-property-newline.md @@ -12,8 +12,6 @@ related_rules: -Enforces placing object properties on separate lines. - This rule permits you to restrict the locations of property specifications in object literals. You may prohibit any part of any property specification from appearing on the same line as any part of any other property specification. You may make this prohibition absolute, or, by invoking an object option, you may allow an exception, permitting an object literal to have all parts of all of its property specifications on a single line. ## Rule Details diff --git a/docs/src/rules/object-shorthand.md b/docs/src/rules/object-shorthand.md index a4517ebc80f..d4e5f016b6d 100644 --- a/docs/src/rules/object-shorthand.md +++ b/docs/src/rules/object-shorthand.md @@ -11,8 +11,6 @@ further_reading: -Requires or disallows method and property shorthand syntax for object literals. - ECMAScript 6 provides a concise form for defining object literal methods and properties. This syntax can make defining complex object literals much cleaner. diff --git a/docs/src/rules/one-var-declaration-per-line.md b/docs/src/rules/one-var-declaration-per-line.md index 2fce51e67b5..b2b21d447d8 100644 --- a/docs/src/rules/one-var-declaration-per-line.md +++ b/docs/src/rules/one-var-declaration-per-line.md @@ -9,8 +9,6 @@ related_rules: -Requires or disallows newlines around variable declarations. - Some developers declare multiple var statements on the same line: ```js diff --git a/docs/src/rules/one-var.md b/docs/src/rules/one-var.md index 87add7fcb9b..e61b0ae1cd1 100644 --- a/docs/src/rules/one-var.md +++ b/docs/src/rules/one-var.md @@ -7,8 +7,6 @@ rule_type: suggestion -Enforces variables to be declared either together or separately in functions. - Variables can be declared at any point in JavaScript code using `var`, `let`, or `const`. There are many styles and preferences related to the declaration of variables, and one of those is deciding on how many variable declarations should be allowed in a single function. There are two schools of thought in this regard: diff --git a/docs/src/rules/operator-assignment.md b/docs/src/rules/operator-assignment.md index c55a81dab5d..9b6d4e3c9b0 100644 --- a/docs/src/rules/operator-assignment.md +++ b/docs/src/rules/operator-assignment.md @@ -7,8 +7,6 @@ rule_type: suggestion -Requires or disallows assignment operator shorthand where possible. - JavaScript provides shorthand operators that combine variable assignment and some simple mathematical operations. For example, `x = x + 4` can be shortened to `x += 4`. The supported shorthand forms are as follows: ```text diff --git a/docs/src/rules/operator-linebreak.md b/docs/src/rules/operator-linebreak.md index 870b3dfa641..fedb7e92a32 100644 --- a/docs/src/rules/operator-linebreak.md +++ b/docs/src/rules/operator-linebreak.md @@ -9,8 +9,6 @@ related_rules: -Enforces consistent linebreak style for operators. - When a statement is too long to fit on a single line, line breaks are generally inserted next to the operators separating expressions. The first style coming to mind would be to place the operator at the end of the line, following the English punctuation rules. ```js diff --git a/docs/src/rules/padded-blocks.md b/docs/src/rules/padded-blocks.md index b6a6a691113..2665620d4b5 100644 --- a/docs/src/rules/padded-blocks.md +++ b/docs/src/rules/padded-blocks.md @@ -10,8 +10,6 @@ related_rules: -Requires or disallows padding within blocks. - Some style guides require block statements to start and end with blank lines. The goal is to improve readability by visually separating the block content and the surrounding code. diff --git a/docs/src/rules/padding-line-between-statements.md b/docs/src/rules/padding-line-between-statements.md index 037a86fe765..8eef570e1b5 100644 --- a/docs/src/rules/padding-line-between-statements.md +++ b/docs/src/rules/padding-line-between-statements.md @@ -7,8 +7,6 @@ rule_type: layout -Requires or disallows padding lines between statements. - This rule requires or disallows blank lines between the given 2 kinds of statements. Properly blank lines help developers to understand the code. diff --git a/docs/src/rules/prefer-arrow-callback.md b/docs/src/rules/prefer-arrow-callback.md index 6eb990f1ee5..37f5c9d3b21 100644 --- a/docs/src/rules/prefer-arrow-callback.md +++ b/docs/src/rules/prefer-arrow-callback.md @@ -9,8 +9,6 @@ further_reading: -Requires using arrow functions for callbacks. - Arrow functions can be an attractive alternative to function expressions for callbacks or function arguments. For example, arrow functions are automatically bound to their surrounding scope/context. This provides an alternative to the pre-ES6 standard of explicitly binding function expressions to achieve similar behavior. diff --git a/docs/src/rules/prefer-const.md b/docs/src/rules/prefer-const.md index 2b97556951b..1e9268f84c4 100644 --- a/docs/src/rules/prefer-const.md +++ b/docs/src/rules/prefer-const.md @@ -10,8 +10,6 @@ related_rules: -Requires `const` declarations for variables that are never reassigned after declared. - If a variable is never reassigned, using the `const` declaration is better. `const` declaration tells readers, "this variable is never reassigned," reducing cognitive load and improving maintainability. diff --git a/docs/src/rules/prefer-destructuring.md b/docs/src/rules/prefer-destructuring.md index 722fd8b0b11..3ee5a5b74d2 100644 --- a/docs/src/rules/prefer-destructuring.md +++ b/docs/src/rules/prefer-destructuring.md @@ -10,8 +10,6 @@ further_reading: -Requires destructuring from arrays and/or objects. - With JavaScript ES6, a new syntax was added for creating variables from an array index or object property, called [destructuring](#further-reading). This rule enforces usage of destructuring instead of accessing a property through a member expression. ## Rule Details diff --git a/docs/src/rules/prefer-exponentiation-operator.md b/docs/src/rules/prefer-exponentiation-operator.md index 5828dde7adc..c814948366c 100644 --- a/docs/src/rules/prefer-exponentiation-operator.md +++ b/docs/src/rules/prefer-exponentiation-operator.md @@ -10,8 +10,6 @@ further_reading: -Disallows the use of `Math.pow` in favor of the `**` operator. - Introduced in ES2016, the infix exponentiation operator `**` is an alternative for the standard `Math.pow` function. Infix notation is considered to be more readable and thus more preferable than the function notation. diff --git a/docs/src/rules/prefer-named-capture-group.md b/docs/src/rules/prefer-named-capture-group.md index 42197de9700..c67847d2348 100644 --- a/docs/src/rules/prefer-named-capture-group.md +++ b/docs/src/rules/prefer-named-capture-group.md @@ -7,7 +7,6 @@ related_rules: - no-invalid-regexp --- -Suggest using named capture group in regular expression. ## Rule Details diff --git a/docs/src/rules/prefer-numeric-literals.md b/docs/src/rules/prefer-numeric-literals.md index 97d20ee69e6..c0506d1b6b1 100644 --- a/docs/src/rules/prefer-numeric-literals.md +++ b/docs/src/rules/prefer-numeric-literals.md @@ -7,8 +7,6 @@ rule_type: suggestion -Disallows `parseInt()` and `Number.parseInt()` in favor of binary, octal, and hexadecimal literals. - The `parseInt()` and `Number.parseInt()` functions can be used to turn binary, octal, and hexadecimal strings into integers. As binary, octal, and hexadecimal literals are supported in ES6, this rule encourages use of those numeric literals instead of `parseInt()` or `Number.parseInt()`. ```js diff --git a/docs/src/rules/prefer-object-has-own.md b/docs/src/rules/prefer-object-has-own.md index 9c19fcdcd98..3445ae17836 100644 --- a/docs/src/rules/prefer-object-has-own.md +++ b/docs/src/rules/prefer-object-has-own.md @@ -9,8 +9,6 @@ further_reading: -Prefer `Object.hasOwn()` over `Object.prototype.hasOwnProperty.call()`. - It is very common to write code like: ```js diff --git a/docs/src/rules/prefer-object-spread.md b/docs/src/rules/prefer-object-spread.md index 790b46b9c51..73b9aa8c498 100644 --- a/docs/src/rules/prefer-object-spread.md +++ b/docs/src/rules/prefer-object-spread.md @@ -7,8 +7,6 @@ rule_type: suggestion -Prefer use of an object spread over `Object.assign`. - When Object.assign is called using an object literal as the first argument, this rule requires using the object spread syntax instead. This rule also warns on cases where an `Object.assign` call is made using a single argument that is an object literal, in this case, the `Object.assign` call is not needed. Introduced in ES2018, object spread is a declarative alternative which may perform better than the more dynamic, imperative `Object.assign`. diff --git a/docs/src/rules/prefer-promise-reject-errors.md b/docs/src/rules/prefer-promise-reject-errors.md index 5aed65a8a51..9959737a680 100644 --- a/docs/src/rules/prefer-promise-reject-errors.md +++ b/docs/src/rules/prefer-promise-reject-errors.md @@ -9,7 +9,6 @@ further_reading: - http://bluebirdjs.com/docs/warning-explanations.html#warning-a-promise-was-rejected-with-a-non-error --- -Requires using Error objects as Promise rejection reasons. It is considered good practice to only pass instances of the built-in `Error` object to the `reject()` function for user-defined errors in Promises. `Error` objects automatically store a stack trace, which can be used to debug an error by determining where it came from. If a Promise is rejected with a non-`Error` value, it can be difficult to determine where the rejection occurred. diff --git a/docs/src/rules/prefer-reflect.md b/docs/src/rules/prefer-reflect.md index 14348779e9f..2d388c413e4 100644 --- a/docs/src/rules/prefer-reflect.md +++ b/docs/src/rules/prefer-reflect.md @@ -9,7 +9,6 @@ related_rules: - no-delete-var --- -Suggest using Reflect methods where applicable. This rule was **deprecated** in ESLint v3.9.0 and will not be replaced. The original intent of this rule now seems misguided as we have come to understand that `Reflect` methods are not actually intended to replace the `Object` counterparts the rule suggests, but rather exist as low-level primitives to be used with proxies in order to replicate the default behavior of various previously existing functionality. diff --git a/docs/src/rules/prefer-regex-literals.md b/docs/src/rules/prefer-regex-literals.md index 3e6210b16d5..34ac8aaa341 100644 --- a/docs/src/rules/prefer-regex-literals.md +++ b/docs/src/rules/prefer-regex-literals.md @@ -10,8 +10,6 @@ further_reading: -Disallows use of the `RegExp` constructor in favor of regular expression literals. - There are two ways to create a regular expression: * Regular expression literals, e.g., `/abc/u`. diff --git a/docs/src/rules/prefer-rest-params.md b/docs/src/rules/prefer-rest-params.md index e018325a156..2962713ffd8 100644 --- a/docs/src/rules/prefer-rest-params.md +++ b/docs/src/rules/prefer-rest-params.md @@ -7,7 +7,6 @@ related_rules: - prefer-spread --- -Suggests using rest parameters instead of `arguments`. There are rest parameters in ES2015. We can use that feature for variadic functions instead of the `arguments` variable. diff --git a/docs/src/rules/prefer-spread.md b/docs/src/rules/prefer-spread.md index 9d16dd63c82..24febc0841f 100644 --- a/docs/src/rules/prefer-spread.md +++ b/docs/src/rules/prefer-spread.md @@ -7,7 +7,6 @@ related_rules: - no-useless-call --- -Suggests using spread syntax instead of `.apply()`. Before ES2015, one must use `Function.prototype.apply()` to call variadic functions. diff --git a/docs/src/rules/prefer-template.md b/docs/src/rules/prefer-template.md index b62d02068e1..026992e0aec 100644 --- a/docs/src/rules/prefer-template.md +++ b/docs/src/rules/prefer-template.md @@ -10,8 +10,6 @@ related_rules: -Suggests using template literals instead of string concatenation. - In ES2015 (ES6), we can use template literals instead of string concatenation. ```js diff --git a/docs/src/rules/quote-props.md b/docs/src/rules/quote-props.md index 912b70e4e6b..8e93e98ba43 100644 --- a/docs/src/rules/quote-props.md +++ b/docs/src/rules/quote-props.md @@ -10,8 +10,6 @@ further_reading: -Requires quotes around object literal property names. - Object literal property names can be defined in two ways: using literals or using strings. For example, these two objects are equivalent: ```js diff --git a/docs/src/rules/quotes.md b/docs/src/rules/quotes.md index 670539d9af7..9260c442339 100644 --- a/docs/src/rules/quotes.md +++ b/docs/src/rules/quotes.md @@ -7,8 +7,6 @@ rule_type: layout -Enforces the consistent use of either backticks, double, or single quotes. - JavaScript allows you to define strings in one of three ways: double quotes, single quotes, and backticks (as of ECMAScript 6). For example: ```js diff --git a/docs/src/rules/radix.md b/docs/src/rules/radix.md index d02f76ae7c3..e9220d71cab 100644 --- a/docs/src/rules/radix.md +++ b/docs/src/rules/radix.md @@ -9,8 +9,6 @@ further_reading: -Enforces the consistent use of the radix argument when using `parseInt()`. - When using the `parseInt()` function it is common to omit the second argument, the radix, and let the function try to determine from the first argument what type of number it is. By default, `parseInt()` will autodetect decimal and hexadecimal (via `0x` prefix). Prior to ECMAScript 5, `parseInt()` also autodetected octal literals, which caused problems because many developers assumed a leading `0` would be ignored. This confusion led to the suggestion that you always use the radix parameter to `parseInt()` to eliminate unintended consequences. So instead of doing this: diff --git a/docs/src/rules/require-atomic-updates.md b/docs/src/rules/require-atomic-updates.md index c0d0de53f48..43797e5079e 100644 --- a/docs/src/rules/require-atomic-updates.md +++ b/docs/src/rules/require-atomic-updates.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/require-ato rule_type: problem --- -Disallows assignments that can lead to race conditions due to usage of `await` or `yield`. When writing asynchronous code, it is possible to create subtle race condition bugs. Consider the following example: diff --git a/docs/src/rules/require-await.md b/docs/src/rules/require-await.md index 18903c21c75..f2f0bd948a3 100644 --- a/docs/src/rules/require-await.md +++ b/docs/src/rules/require-await.md @@ -7,7 +7,6 @@ related_rules: - require-yield --- -Disallows async functions which have no `await` expression. Asynchronous functions in JavaScript behave differently than other functions in two important ways: diff --git a/docs/src/rules/require-jsdoc.md b/docs/src/rules/require-jsdoc.md index e31d5d05de4..6802a31f107 100644 --- a/docs/src/rules/require-jsdoc.md +++ b/docs/src/rules/require-jsdoc.md @@ -7,7 +7,6 @@ related_rules: - valid-jsdoc --- -Requires JSDoc comments. This rule was [**deprecated**](https://eslint.org/blog/2018/11/jsdoc-end-of-life) in ESLint v5.10.0. diff --git a/docs/src/rules/require-unicode-regexp.md b/docs/src/rules/require-unicode-regexp.md index ac5937e3a37..8b914281232 100644 --- a/docs/src/rules/require-unicode-regexp.md +++ b/docs/src/rules/require-unicode-regexp.md @@ -5,7 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/require-uni rule_type: suggestion --- -Enforces the use of `u` flag on RegExp. RegExp `u` flag has two effects: diff --git a/docs/src/rules/require-yield.md b/docs/src/rules/require-yield.md index 3654579c116..1086eb5a587 100644 --- a/docs/src/rules/require-yield.md +++ b/docs/src/rules/require-yield.md @@ -9,8 +9,6 @@ related_rules: -Disallows generator functions that do not have `yield`. - ## Rule Details This rule generates warnings for generator functions that do not have the `yield` keyword. diff --git a/docs/src/rules/rest-spread-spacing.md b/docs/src/rules/rest-spread-spacing.md index 3af486077d5..c124bb01ee8 100644 --- a/docs/src/rules/rest-spread-spacing.md +++ b/docs/src/rules/rest-spread-spacing.md @@ -9,8 +9,6 @@ further_reading: -Enforces spacing between rest and spread operators and their expressions. - ES2015 introduced the rest and spread operators, which expand an iterable structure into its individual parts. Some examples of their usage are as follows: ```js diff --git a/docs/src/rules/semi-spacing.md b/docs/src/rules/semi-spacing.md index 8b701c11cfb..b7131b40a34 100644 --- a/docs/src/rules/semi-spacing.md +++ b/docs/src/rules/semi-spacing.md @@ -13,8 +13,6 @@ related_rules: -Enforces spacing before and after semicolons. - JavaScript allows you to place unnecessary spaces before or after a semicolon. Disallowing or enforcing space around a semicolon can improve the readability of your program. diff --git a/docs/src/rules/semi-style.md b/docs/src/rules/semi-style.md index 2952e07de95..2082539ffe2 100644 --- a/docs/src/rules/semi-style.md +++ b/docs/src/rules/semi-style.md @@ -11,8 +11,6 @@ related_rules: -Enforces location of semicolons. - Generally, semicolons are at the end of lines. However, in semicolon-less style, semicolons are at the beginning of lines. This rule enforces that semicolons are at the configured location. ## Rule Details diff --git a/docs/src/rules/semi.md b/docs/src/rules/semi.md index 27bbd8e7ee9..cb5a37b0f28 100644 --- a/docs/src/rules/semi.md +++ b/docs/src/rules/semi.md @@ -14,8 +14,6 @@ further_reading: -Requires or disallows semicolons instead of ASI. - JavaScript doesn't require semicolons at the end of each statement. In many cases, the JavaScript engine can determine that a semicolon should be in a certain spot and will automatically add it. This feature is known as **automatic semicolon insertion (ASI)** and is considered one of the more controversial features of JavaScript. For example, the following lines are both valid: ```js diff --git a/docs/src/rules/sort-imports.md b/docs/src/rules/sort-imports.md index 6a0975942fd..1bc499973c5 100644 --- a/docs/src/rules/sort-imports.md +++ b/docs/src/rules/sort-imports.md @@ -10,8 +10,6 @@ related_rules: -Enforces sorted import declarations within modules. - The import statement is used to import members (functions, objects or primitives) that have been exported from an external module. Using a specific member syntax: ```js diff --git a/docs/src/rules/sort-keys.md b/docs/src/rules/sort-keys.md index f2db04b8ef7..a551f4f7ab2 100644 --- a/docs/src/rules/sort-keys.md +++ b/docs/src/rules/sort-keys.md @@ -8,7 +8,6 @@ related_rules: - sort-vars --- -Requires object keys to be sorted. When declaring multiple properties, some developers prefer to sort property names alphabetically to more easily find and/or diff necessary properties at a later time. Others feel that it adds complexity and becomes burden to maintain. diff --git a/docs/src/rules/sort-vars.md b/docs/src/rules/sort-vars.md index 182193eea64..bcb82427471 100644 --- a/docs/src/rules/sort-vars.md +++ b/docs/src/rules/sort-vars.md @@ -10,8 +10,6 @@ related_rules: -Requires variables within the same declaration block to be sorted. - When declaring multiple variables within the same block, some developers prefer to sort variable names alphabetically to be able to find necessary variable easier at the later time. Others feel that it adds complexity and becomes burden to maintain. ## Rule Details diff --git a/docs/src/rules/space-before-blocks.md b/docs/src/rules/space-before-blocks.md index fa254f6046f..742665f529f 100644 --- a/docs/src/rules/space-before-blocks.md +++ b/docs/src/rules/space-before-blocks.md @@ -13,8 +13,6 @@ related_rules: -Requires Or disallows space before blocks. - Consistency is an important part of any style guide. While it is a personal preference where to put the opening brace of blocks, it should be consistent across a whole project. diff --git a/docs/src/rules/space-before-function-paren.md b/docs/src/rules/space-before-function-paren.md index 0a5ca2678db..f825ee9d779 100644 --- a/docs/src/rules/space-before-function-paren.md +++ b/docs/src/rules/space-before-function-paren.md @@ -10,8 +10,6 @@ related_rules: -Requires or disallows a space before function parenthesis. - When formatting a function, whitespace is allowed between the function name or `function` keyword and the opening paren. Named functions also require a space between the `function` keyword and the function name, but anonymous functions require no whitespace. For example: ```js diff --git a/docs/src/rules/space-in-parens.md b/docs/src/rules/space-in-parens.md index 821bbf2bbd9..fea11f6e857 100644 --- a/docs/src/rules/space-in-parens.md +++ b/docs/src/rules/space-in-parens.md @@ -11,8 +11,6 @@ related_rules: -Disallows or enforce spaces inside of parentheses. - Some style guides require or disallow spaces inside of parentheses: ```js diff --git a/docs/src/rules/space-infix-ops.md b/docs/src/rules/space-infix-ops.md index 5d075082572..c7a7d4ad444 100644 --- a/docs/src/rules/space-infix-ops.md +++ b/docs/src/rules/space-infix-ops.md @@ -7,8 +7,6 @@ rule_type: layout -Requires spacing around infix operators. - While formatting preferences are very personal, a number of style guides require spaces around operators, such as: ```js diff --git a/docs/src/rules/space-unary-ops.md b/docs/src/rules/space-unary-ops.md index e3d5cac34ab..00a00149683 100644 --- a/docs/src/rules/space-unary-ops.md +++ b/docs/src/rules/space-unary-ops.md @@ -7,8 +7,6 @@ rule_type: layout -Requires or disallow spaces before/after unary operators. - Some style guides require or disallow spaces before or after unary operators. This is mainly a stylistic issue, however, some JavaScript expressions can be written without spacing which makes it harder to read and maintain. ## Rule Details diff --git a/docs/src/rules/spaced-comment.md b/docs/src/rules/spaced-comment.md index df8fe3806ff..ecc1f02a780 100644 --- a/docs/src/rules/spaced-comment.md +++ b/docs/src/rules/spaced-comment.md @@ -9,8 +9,6 @@ related_rules: -Enforces consistent spacing after the `//` or `/*` in a comment. - Some style guides require or disallow a whitespace immediately after the initial `//` or `/*` of a comment. Whitespace after the `//` or `/*` makes it easier to read text in comments. On the other hand, commenting out code is easier without having to put a whitespace right after the `//` or `/*`. diff --git a/docs/src/rules/strict.md b/docs/src/rules/strict.md index 81b06309660..94042a6dbdc 100644 --- a/docs/src/rules/strict.md +++ b/docs/src/rules/strict.md @@ -7,8 +7,6 @@ rule_type: suggestion -Requires or disallow strict mode directives. - A strict mode directive is a `"use strict"` literal at the beginning of a script or function body. It enables strict mode semantics. When a directive occurs in global scope, strict mode applies to the entire script: diff --git a/docs/src/rules/switch-colon-spacing.md b/docs/src/rules/switch-colon-spacing.md index daf45d9af8f..4dfff02896d 100644 --- a/docs/src/rules/switch-colon-spacing.md +++ b/docs/src/rules/switch-colon-spacing.md @@ -7,8 +7,6 @@ rule_type: layout -Enforces spacing around colons of switch statements. - Spacing around colons improves readability of `case`/`default` clauses. ## Rule Details diff --git a/docs/src/rules/symbol-description.md b/docs/src/rules/symbol-description.md index 3a458d7ed41..44be78bd783 100644 --- a/docs/src/rules/symbol-description.md +++ b/docs/src/rules/symbol-description.md @@ -7,7 +7,6 @@ further_reading: - https://www.ecma-international.org/ecma-262/6.0/#sec-symbol-description --- -Requires symbol descriptions. The `Symbol` function may have an optional description: diff --git a/docs/src/rules/template-curly-spacing.md b/docs/src/rules/template-curly-spacing.md index bca7b0dc7f9..4eca3b980e3 100644 --- a/docs/src/rules/template-curly-spacing.md +++ b/docs/src/rules/template-curly-spacing.md @@ -7,8 +7,6 @@ rule_type: layout -Enforces usage of spacing in template strings. - We can embed expressions in template strings with using a pair of `${` and `}`. This rule can force usage of spacing _within_ the curly brace pair according to style guides. diff --git a/docs/src/rules/template-tag-spacing.md b/docs/src/rules/template-tag-spacing.md index 3c200cdf06d..7289ddf27f4 100644 --- a/docs/src/rules/template-tag-spacing.md +++ b/docs/src/rules/template-tag-spacing.md @@ -10,8 +10,6 @@ further_reading: -Requires or disallow spacing between template tags and their literals. - With ES6, it's possible to create functions called [tagged template literals](#further-reading) where the function parameters consist of a template literal's strings and expressions. When using tagged template literals, it's possible to insert whitespace between the tag function and the template literal. Since this whitespace is optional, the following lines are equivalent: diff --git a/docs/src/rules/unicode-bom.md b/docs/src/rules/unicode-bom.md index 2d67f42d07c..fb9857e2cab 100644 --- a/docs/src/rules/unicode-bom.md +++ b/docs/src/rules/unicode-bom.md @@ -7,8 +7,6 @@ rule_type: layout -Requires or disallows the Unicode Byte Order Mark (BOM). - The Unicode Byte Order Mark (BOM) is used to specify whether code units are big endian or little endian. That is, whether the most significant or least significant bytes come first. UTF-8 does not require a BOM because byte ordering diff --git a/docs/src/rules/use-isnan.md b/docs/src/rules/use-isnan.md index 5454e1bb8d4..cb27f751df2 100644 --- a/docs/src/rules/use-isnan.md +++ b/docs/src/rules/use-isnan.md @@ -7,8 +7,6 @@ rule_type: problem -Requires calls to `isNaN()` when checking for `NaN`. - In JavaScript, `NaN` is a special value of the `Number` type. It's used to represent any of the "not-a-number" values represented by the double-precision 64-bit format as specified by the IEEE Standard for Binary Floating-Point Arithmetic. Because `NaN` is unique in JavaScript by not being equal to anything, including itself, the results of comparisons to `NaN` are confusing: diff --git a/docs/src/rules/valid-jsdoc.md b/docs/src/rules/valid-jsdoc.md index 8522a4922f5..b12f6b96f47 100644 --- a/docs/src/rules/valid-jsdoc.md +++ b/docs/src/rules/valid-jsdoc.md @@ -11,8 +11,6 @@ further_reading: -Enforces valid JSDoc comments. - This rule was [**deprecated**](https://eslint.org/blog/2018/11/jsdoc-end-of-life) in ESLint v5.10.0. [JSDoc](http://usejsdoc.org) generates application programming interface (API) documentation from specially-formatted comments in JavaScript code. For example, this is a JSDoc comment for a function: diff --git a/docs/src/rules/valid-typeof.md b/docs/src/rules/valid-typeof.md index 78919cd0815..45a30a3f368 100644 --- a/docs/src/rules/valid-typeof.md +++ b/docs/src/rules/valid-typeof.md @@ -11,8 +11,6 @@ further_reading: -Enforces comparing `typeof` expressions against valid strings. - For a vast majority of use cases, the result of the `typeof` operator is one of the following string literals: `"undefined"`, `"object"`, `"boolean"`, `"number"`, `"string"`, `"function"`, `"symbol"`, and `"bigint"`. It is usually a typing mistake to compare the result of a `typeof` operator to other string literals. ## Rule Details diff --git a/docs/src/rules/vars-on-top.md b/docs/src/rules/vars-on-top.md index 921801df427..cd92e2592f4 100644 --- a/docs/src/rules/vars-on-top.md +++ b/docs/src/rules/vars-on-top.md @@ -10,7 +10,6 @@ further_reading: - https://benalman.com/news/2012/05/multiple-var-statements-javascript/ --- -Requires variable declarations to be at the top of their scope. The `vars-on-top` rule generates warnings when variable declarations are not used serially at the top of a function scope or the top of a program. By default variable declarations are always moved (“hoisted”) invisibly to the top of their containing scope by the JavaScript interpreter. diff --git a/docs/src/rules/wrap-iife.md b/docs/src/rules/wrap-iife.md index 516cc3b364c..3c6158f64c8 100644 --- a/docs/src/rules/wrap-iife.md +++ b/docs/src/rules/wrap-iife.md @@ -7,8 +7,6 @@ rule_type: layout -Requires IIFEs to be wrapped. - You can immediately invoke function expressions, but not function declarations. A common technique to create an immediately-invoked function expression (IIFE) is to wrap a function declaration in parentheses. The opening parentheses causes the contained function to be parsed as an expression, rather than a declaration. ```js diff --git a/docs/src/rules/wrap-regex.md b/docs/src/rules/wrap-regex.md index f3ce0e469cc..7b0204ed47d 100644 --- a/docs/src/rules/wrap-regex.md +++ b/docs/src/rules/wrap-regex.md @@ -7,8 +7,6 @@ rule_type: layout -Requires regex literals to be wrapped. - When a regular expression is used in certain situations, it can end up looking like a division operator. For example: ```js diff --git a/docs/src/rules/yield-star-spacing.md b/docs/src/rules/yield-star-spacing.md index 86ce476a504..d1d1ee5f291 100644 --- a/docs/src/rules/yield-star-spacing.md +++ b/docs/src/rules/yield-star-spacing.md @@ -9,8 +9,6 @@ further_reading: -Enforces spacing around the `*` in `yield*` expressions. - ## Rule Details This rule enforces spacing around the `*` in `yield*` expressions. diff --git a/docs/src/rules/yoda.md b/docs/src/rules/yoda.md index fe7a11e9a6f..4d2ba28cc53 100644 --- a/docs/src/rules/yoda.md +++ b/docs/src/rules/yoda.md @@ -10,8 +10,6 @@ further_reading: -Requires or disallows "Yoda" conditions. - Yoda conditions are so named because the literal value of the condition comes first while the variable comes second. For example, the following is a Yoda condition: ```js diff --git a/lib/rules/accessor-pairs.js b/lib/rules/accessor-pairs.js index 33887affef2..112d0ddb8c1 100644 --- a/lib/rules/accessor-pairs.js +++ b/lib/rules/accessor-pairs.js @@ -140,7 +140,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce getter and setter pairs in objects and classes", + description: "Enforce getter and setter pairs in objects and classes", recommended: false, url: "https://eslint.org/docs/rules/accessor-pairs" }, diff --git a/lib/rules/array-bracket-newline.js b/lib/rules/array-bracket-newline.js index 0beb138c4e2..deeae818fb5 100644 --- a/lib/rules/array-bracket-newline.js +++ b/lib/rules/array-bracket-newline.js @@ -17,7 +17,7 @@ module.exports = { type: "layout", docs: { - description: "enforce linebreaks after opening and before closing array brackets", + description: "Enforce linebreaks after opening and before closing array brackets", recommended: false, url: "https://eslint.org/docs/rules/array-bracket-newline" }, diff --git a/lib/rules/array-bracket-spacing.js b/lib/rules/array-bracket-spacing.js index e4912ec17a1..5e7cea9ba58 100644 --- a/lib/rules/array-bracket-spacing.js +++ b/lib/rules/array-bracket-spacing.js @@ -16,7 +16,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing inside array brackets", + description: "Enforce consistent spacing inside array brackets", recommended: false, url: "https://eslint.org/docs/rules/array-bracket-spacing" }, diff --git a/lib/rules/array-callback-return.js b/lib/rules/array-callback-return.js index fba414c1ef4..eb5aa474b27 100644 --- a/lib/rules/array-callback-return.js +++ b/lib/rules/array-callback-return.js @@ -139,7 +139,7 @@ module.exports = { type: "problem", docs: { - description: "enforce `return` statements in callbacks of array methods", + description: "Enforce `return` statements in callbacks of array methods", recommended: false, url: "https://eslint.org/docs/rules/array-callback-return" }, diff --git a/lib/rules/array-element-newline.js b/lib/rules/array-element-newline.js index 77f5fc9e9ce..c762755bd83 100644 --- a/lib/rules/array-element-newline.js +++ b/lib/rules/array-element-newline.js @@ -17,7 +17,7 @@ module.exports = { type: "layout", docs: { - description: "enforce line breaks after each array element", + description: "Enforce line breaks after each array element", recommended: false, url: "https://eslint.org/docs/rules/array-element-newline" }, diff --git a/lib/rules/arrow-body-style.js b/lib/rules/arrow-body-style.js index 7a141b0d788..8bb9e8c4ffa 100644 --- a/lib/rules/arrow-body-style.js +++ b/lib/rules/arrow-body-style.js @@ -20,7 +20,7 @@ module.exports = { type: "suggestion", docs: { - description: "require braces around arrow function bodies", + description: "Require braces around arrow function bodies", recommended: false, url: "https://eslint.org/docs/rules/arrow-body-style" }, diff --git a/lib/rules/arrow-parens.js b/lib/rules/arrow-parens.js index 779ab6fe9c9..05012fc37b7 100644 --- a/lib/rules/arrow-parens.js +++ b/lib/rules/arrow-parens.js @@ -33,7 +33,7 @@ module.exports = { type: "layout", docs: { - description: "require parentheses around arrow function arguments", + description: "Require parentheses around arrow function arguments", recommended: false, url: "https://eslint.org/docs/rules/arrow-parens" }, diff --git a/lib/rules/arrow-spacing.js b/lib/rules/arrow-spacing.js index 9fdcdd58ba7..2dcc175da06 100644 --- a/lib/rules/arrow-spacing.js +++ b/lib/rules/arrow-spacing.js @@ -20,7 +20,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing before and after the arrow in arrow functions", + description: "Enforce consistent spacing before and after the arrow in arrow functions", recommended: false, url: "https://eslint.org/docs/rules/arrow-spacing" }, diff --git a/lib/rules/block-scoped-var.js b/lib/rules/block-scoped-var.js index 3a277863ef2..731d06d0f3b 100644 --- a/lib/rules/block-scoped-var.js +++ b/lib/rules/block-scoped-var.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce the use of variables within the scope they are defined", + description: "Enforce the use of variables within the scope they are defined", recommended: false, url: "https://eslint.org/docs/rules/block-scoped-var" }, diff --git a/lib/rules/block-spacing.js b/lib/rules/block-spacing.js index 53303a9b004..9fbf1594c47 100644 --- a/lib/rules/block-spacing.js +++ b/lib/rules/block-spacing.js @@ -17,7 +17,7 @@ module.exports = { type: "layout", docs: { - description: "disallow or enforce spaces inside of blocks after opening block and before closing block", + description: "Disallow or enforce spaces inside of blocks after opening block and before closing block", recommended: false, url: "https://eslint.org/docs/rules/block-spacing" }, diff --git a/lib/rules/brace-style.js b/lib/rules/brace-style.js index f4adb9490eb..52d89201b9e 100644 --- a/lib/rules/brace-style.js +++ b/lib/rules/brace-style.js @@ -17,7 +17,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent brace style for blocks", + description: "Enforce consistent brace style for blocks", recommended: false, url: "https://eslint.org/docs/rules/brace-style" }, diff --git a/lib/rules/callback-return.js b/lib/rules/callback-return.js index 34b74631f0c..fe5b649b582 100644 --- a/lib/rules/callback-return.js +++ b/lib/rules/callback-return.js @@ -19,7 +19,7 @@ module.exports = { type: "suggestion", docs: { - description: "require `return` statements after callbacks", + description: "Require `return` statements after callbacks", recommended: false, url: "https://eslint.org/docs/rules/callback-return" }, diff --git a/lib/rules/camelcase.js b/lib/rules/camelcase.js index e4761466902..ee1b6bf598d 100644 --- a/lib/rules/camelcase.js +++ b/lib/rules/camelcase.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce camelcase naming convention", + description: "Enforce camelcase naming convention", recommended: false, url: "https://eslint.org/docs/rules/camelcase" }, diff --git a/lib/rules/capitalized-comments.js b/lib/rules/capitalized-comments.js index dffe9565003..ba798d42858 100644 --- a/lib/rules/capitalized-comments.js +++ b/lib/rules/capitalized-comments.js @@ -105,7 +105,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce or disallow capitalization of the first letter of a comment", + description: "Enforce or disallow capitalization of the first letter of a comment", recommended: false, url: "https://eslint.org/docs/rules/capitalized-comments" }, diff --git a/lib/rules/class-methods-use-this.js b/lib/rules/class-methods-use-this.js index 1af6084ed8b..05a915867c3 100644 --- a/lib/rules/class-methods-use-this.js +++ b/lib/rules/class-methods-use-this.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce that class methods utilize `this`", + description: "Enforce that class methods utilize `this`", recommended: false, url: "https://eslint.org/docs/rules/class-methods-use-this" }, diff --git a/lib/rules/comma-dangle.js b/lib/rules/comma-dangle.js index 063e1cb697f..9518da90e9e 100644 --- a/lib/rules/comma-dangle.js +++ b/lib/rules/comma-dangle.js @@ -76,7 +76,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow trailing commas", + description: "Require or disallow trailing commas", recommended: false, url: "https://eslint.org/docs/rules/comma-dangle" }, diff --git a/lib/rules/comma-spacing.js b/lib/rules/comma-spacing.js index 23a51752814..8cc8059b5ff 100644 --- a/lib/rules/comma-spacing.js +++ b/lib/rules/comma-spacing.js @@ -16,7 +16,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing before and after commas", + description: "Enforce consistent spacing before and after commas", recommended: false, url: "https://eslint.org/docs/rules/comma-spacing" }, diff --git a/lib/rules/comma-style.js b/lib/rules/comma-style.js index cbcbe3ae15b..4969f59d7ef 100644 --- a/lib/rules/comma-style.js +++ b/lib/rules/comma-style.js @@ -17,7 +17,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent comma style", + description: "Enforce consistent comma style", recommended: false, url: "https://eslint.org/docs/rules/comma-style" }, diff --git a/lib/rules/complexity.js b/lib/rules/complexity.js index b2355556af9..541d3a9bb9a 100644 --- a/lib/rules/complexity.js +++ b/lib/rules/complexity.js @@ -23,7 +23,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce a maximum cyclomatic complexity allowed in a program", + description: "Enforce a maximum cyclomatic complexity allowed in a program", recommended: false, url: "https://eslint.org/docs/rules/complexity" }, diff --git a/lib/rules/computed-property-spacing.js b/lib/rules/computed-property-spacing.js index 4850a8b651f..3d033fc00bd 100644 --- a/lib/rules/computed-property-spacing.js +++ b/lib/rules/computed-property-spacing.js @@ -16,7 +16,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing inside computed property brackets", + description: "Enforce consistent spacing inside computed property brackets", recommended: false, url: "https://eslint.org/docs/rules/computed-property-spacing" }, diff --git a/lib/rules/consistent-return.js b/lib/rules/consistent-return.js index fffb4357b65..f0072974d11 100644 --- a/lib/rules/consistent-return.js +++ b/lib/rules/consistent-return.js @@ -46,7 +46,7 @@ module.exports = { type: "suggestion", docs: { - description: "require `return` statements to either always or never specify values", + description: "Require `return` statements to either always or never specify values", recommended: false, url: "https://eslint.org/docs/rules/consistent-return" }, diff --git a/lib/rules/consistent-this.js b/lib/rules/consistent-this.js index 2aa07914638..947873b8e4a 100644 --- a/lib/rules/consistent-this.js +++ b/lib/rules/consistent-this.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce consistent naming when capturing the current execution context", + description: "Enforce consistent naming when capturing the current execution context", recommended: false, url: "https://eslint.org/docs/rules/consistent-this" }, diff --git a/lib/rules/constructor-super.js b/lib/rules/constructor-super.js index defdb91d69d..fff658471b0 100644 --- a/lib/rules/constructor-super.js +++ b/lib/rules/constructor-super.js @@ -122,7 +122,7 @@ module.exports = { type: "problem", docs: { - description: "require `super()` calls in constructors", + description: "Require `super()` calls in constructors", recommended: true, url: "https://eslint.org/docs/rules/constructor-super" }, diff --git a/lib/rules/curly.js b/lib/rules/curly.js index 29e73953da6..7b5d140fe66 100644 --- a/lib/rules/curly.js +++ b/lib/rules/curly.js @@ -20,7 +20,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce consistent brace style for all control statements", + description: "Enforce consistent brace style for all control statements", recommended: false, url: "https://eslint.org/docs/rules/curly" }, diff --git a/lib/rules/default-case-last.js b/lib/rules/default-case-last.js index 34be2894e41..313a0d8c904 100644 --- a/lib/rules/default-case-last.js +++ b/lib/rules/default-case-last.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce default clauses in switch statements to be last", + description: "Enforce default clauses in switch statements to be last", recommended: false, url: "https://eslint.org/docs/rules/default-case-last" }, diff --git a/lib/rules/default-case.js b/lib/rules/default-case.js index 6ce238529d0..f28de1af906 100644 --- a/lib/rules/default-case.js +++ b/lib/rules/default-case.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "require `default` cases in `switch` statements", + description: "Require `default` cases in `switch` statements", recommended: false, url: "https://eslint.org/docs/rules/default-case" }, diff --git a/lib/rules/default-param-last.js b/lib/rules/default-param-last.js index ea12a2a558a..61df5f6d2eb 100644 --- a/lib/rules/default-param-last.js +++ b/lib/rules/default-param-last.js @@ -11,7 +11,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce default parameters to be last", + description: "Enforce default parameters to be last", recommended: false, url: "https://eslint.org/docs/rules/default-param-last" }, diff --git a/lib/rules/dot-location.js b/lib/rules/dot-location.js index 9dea4f25cf7..36b50b284cf 100644 --- a/lib/rules/dot-location.js +++ b/lib/rules/dot-location.js @@ -17,7 +17,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent newlines before and after dots", + description: "Enforce consistent newlines before and after dots", recommended: false, url: "https://eslint.org/docs/rules/dot-location" }, diff --git a/lib/rules/dot-notation.js b/lib/rules/dot-notation.js index 90ba6d83b76..5f6e818cb49 100644 --- a/lib/rules/dot-notation.js +++ b/lib/rules/dot-notation.js @@ -26,7 +26,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce dot notation whenever possible", + description: "Enforce dot notation whenever possible", recommended: false, url: "https://eslint.org/docs/rules/dot-notation" }, diff --git a/lib/rules/eol-last.js b/lib/rules/eol-last.js index 393b934125e..fb87971fc73 100644 --- a/lib/rules/eol-last.js +++ b/lib/rules/eol-last.js @@ -14,7 +14,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow newline at the end of files", + description: "Require or disallow newline at the end of files", recommended: false, url: "https://eslint.org/docs/rules/eol-last" }, diff --git a/lib/rules/eqeqeq.js b/lib/rules/eqeqeq.js index b5d784dad6e..b3990e214d0 100644 --- a/lib/rules/eqeqeq.js +++ b/lib/rules/eqeqeq.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "require the use of `===` and `!==`", + description: "Require the use of `===` and `!==`", recommended: false, url: "https://eslint.org/docs/rules/eqeqeq" }, diff --git a/lib/rules/for-direction.js b/lib/rules/for-direction.js index d3d825a5766..7df3d7e4802 100644 --- a/lib/rules/for-direction.js +++ b/lib/rules/for-direction.js @@ -15,7 +15,7 @@ module.exports = { type: "problem", docs: { - description: "enforce \"for\" loop update clause moving the counter in the right direction.", + description: "Enforce \"for\" loop update clause moving the counter in the right direction.", recommended: true, url: "https://eslint.org/docs/rules/for-direction" }, diff --git a/lib/rules/func-call-spacing.js b/lib/rules/func-call-spacing.js index 0391d99c763..fec6763a2cd 100644 --- a/lib/rules/func-call-spacing.js +++ b/lib/rules/func-call-spacing.js @@ -21,7 +21,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow spacing between function identifiers and their invocations", + description: "Require or disallow spacing between function identifiers and their invocations", recommended: false, url: "https://eslint.org/docs/rules/func-call-spacing" }, diff --git a/lib/rules/func-name-matching.js b/lib/rules/func-name-matching.js index 9cee5fe019a..391b2a27836 100644 --- a/lib/rules/func-name-matching.js +++ b/lib/rules/func-name-matching.js @@ -74,7 +74,7 @@ module.exports = { type: "suggestion", docs: { - description: "require function names to match the name of the variable or property to which they are assigned", + description: "Require function names to match the name of the variable or property to which they are assigned", recommended: false, url: "https://eslint.org/docs/rules/func-name-matching" }, diff --git a/lib/rules/func-names.js b/lib/rules/func-names.js index c7b2072e177..ee4664592f2 100644 --- a/lib/rules/func-names.js +++ b/lib/rules/func-names.js @@ -30,7 +30,7 @@ module.exports = { type: "suggestion", docs: { - description: "require or disallow named `function` expressions", + description: "Require or disallow named `function` expressions", recommended: false, url: "https://eslint.org/docs/rules/func-names" }, diff --git a/lib/rules/func-style.js b/lib/rules/func-style.js index f71574890c8..0e1ba9fab0e 100644 --- a/lib/rules/func-style.js +++ b/lib/rules/func-style.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce the consistent use of either `function` declarations or expressions", + description: "Enforce the consistent use of either `function` declarations or expressions", recommended: false, url: "https://eslint.org/docs/rules/func-style" }, diff --git a/lib/rules/function-call-argument-newline.js b/lib/rules/function-call-argument-newline.js index f3cfeee703a..46610914622 100644 --- a/lib/rules/function-call-argument-newline.js +++ b/lib/rules/function-call-argument-newline.js @@ -15,7 +15,7 @@ module.exports = { type: "layout", docs: { - description: "enforce line breaks between arguments of a function call", + description: "Enforce line breaks between arguments of a function call", recommended: false, url: "https://eslint.org/docs/rules/function-call-argument-newline" }, diff --git a/lib/rules/function-paren-newline.js b/lib/rules/function-paren-newline.js index cad27b9927d..e61d17be603 100644 --- a/lib/rules/function-paren-newline.js +++ b/lib/rules/function-paren-newline.js @@ -20,7 +20,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent line breaks inside function parentheses", + description: "Enforce consistent line breaks inside function parentheses", recommended: false, url: "https://eslint.org/docs/rules/function-paren-newline" }, diff --git a/lib/rules/generator-star-spacing.js b/lib/rules/generator-star-spacing.js index 28e81013fcb..d32b21fff5c 100644 --- a/lib/rules/generator-star-spacing.js +++ b/lib/rules/generator-star-spacing.js @@ -31,7 +31,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing around `*` operators in generator functions", + description: "Enforce consistent spacing around `*` operators in generator functions", recommended: false, url: "https://eslint.org/docs/rules/generator-star-spacing" }, diff --git a/lib/rules/getter-return.js b/lib/rules/getter-return.js index 03cfce2cf1a..5209ab1504b 100644 --- a/lib/rules/getter-return.js +++ b/lib/rules/getter-return.js @@ -35,7 +35,7 @@ module.exports = { type: "problem", docs: { - description: "enforce `return` statements in getters", + description: "Enforce `return` statements in getters", recommended: true, url: "https://eslint.org/docs/rules/getter-return" }, diff --git a/lib/rules/global-require.js b/lib/rules/global-require.js index 71a2bf1ac49..77ce5d10827 100644 --- a/lib/rules/global-require.js +++ b/lib/rules/global-require.js @@ -58,7 +58,7 @@ module.exports = { type: "suggestion", docs: { - description: "require `require()` calls to be placed at top-level module scope", + description: "Require `require()` calls to be placed at top-level module scope", recommended: false, url: "https://eslint.org/docs/rules/global-require" }, diff --git a/lib/rules/grouped-accessor-pairs.js b/lib/rules/grouped-accessor-pairs.js index 0fe6f91e4db..21374be2101 100644 --- a/lib/rules/grouped-accessor-pairs.js +++ b/lib/rules/grouped-accessor-pairs.js @@ -96,7 +96,7 @@ module.exports = { type: "suggestion", docs: { - description: "require grouped accessor pairs in object literals and classes", + description: "Require grouped accessor pairs in object literals and classes", recommended: false, url: "https://eslint.org/docs/rules/grouped-accessor-pairs" }, diff --git a/lib/rules/guard-for-in.js b/lib/rules/guard-for-in.js index 1c52af7d4cd..3b99143fe21 100644 --- a/lib/rules/guard-for-in.js +++ b/lib/rules/guard-for-in.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "require `for-in` loops to include an `if` statement", + description: "Require `for-in` loops to include an `if` statement", recommended: false, url: "https://eslint.org/docs/rules/guard-for-in" }, diff --git a/lib/rules/handle-callback-err.js b/lib/rules/handle-callback-err.js index f370407743a..5189564b668 100644 --- a/lib/rules/handle-callback-err.js +++ b/lib/rules/handle-callback-err.js @@ -20,7 +20,7 @@ module.exports = { type: "suggestion", docs: { - description: "require error handling in callbacks", + description: "Require error handling in callbacks", recommended: false, url: "https://eslint.org/docs/rules/handle-callback-err" }, diff --git a/lib/rules/id-blacklist.js b/lib/rules/id-blacklist.js index f7e04ae7376..5ea61e94f69 100644 --- a/lib/rules/id-blacklist.js +++ b/lib/rules/id-blacklist.js @@ -119,7 +119,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow specified identifiers", + description: "Disallow specified identifiers", recommended: false, url: "https://eslint.org/docs/rules/id-blacklist" }, diff --git a/lib/rules/id-denylist.js b/lib/rules/id-denylist.js index a0b1f416f46..fe0a0b50bd2 100644 --- a/lib/rules/id-denylist.js +++ b/lib/rules/id-denylist.js @@ -99,7 +99,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow specified identifiers", + description: "Disallow specified identifiers", recommended: false, url: "https://eslint.org/docs/rules/id-denylist" }, diff --git a/lib/rules/id-length.js b/lib/rules/id-length.js index 3701c66e347..99f833fc73b 100644 --- a/lib/rules/id-length.js +++ b/lib/rules/id-length.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce minimum and maximum identifier lengths", + description: "Enforce minimum and maximum identifier lengths", recommended: false, url: "https://eslint.org/docs/rules/id-length" }, diff --git a/lib/rules/id-match.js b/lib/rules/id-match.js index 8713a5f9f8b..ec87af18d5b 100644 --- a/lib/rules/id-match.js +++ b/lib/rules/id-match.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "require identifiers to match a specified regular expression", + description: "Require identifiers to match a specified regular expression", recommended: false, url: "https://eslint.org/docs/rules/id-match" }, diff --git a/lib/rules/implicit-arrow-linebreak.js b/lib/rules/implicit-arrow-linebreak.js index 71b2437eef8..c765960267f 100644 --- a/lib/rules/implicit-arrow-linebreak.js +++ b/lib/rules/implicit-arrow-linebreak.js @@ -15,7 +15,7 @@ module.exports = { type: "layout", docs: { - description: "enforce the location of arrow function bodies", + description: "Enforce the location of arrow function bodies", recommended: false, url: "https://eslint.org/docs/rules/implicit-arrow-linebreak" }, diff --git a/lib/rules/indent-legacy.js b/lib/rules/indent-legacy.js index c5be4a5d134..06de8c9a754 100644 --- a/lib/rules/indent-legacy.js +++ b/lib/rules/indent-legacy.js @@ -26,7 +26,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent indentation", + description: "Enforce consistent indentation", recommended: false, url: "https://eslint.org/docs/rules/indent-legacy" }, diff --git a/lib/rules/indent.js b/lib/rules/indent.js index bc6aa9e5c0c..56eccdeb6e7 100644 --- a/lib/rules/indent.js +++ b/lib/rules/indent.js @@ -500,7 +500,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent indentation", + description: "Enforce consistent indentation", recommended: false, url: "https://eslint.org/docs/rules/indent" }, diff --git a/lib/rules/init-declarations.js b/lib/rules/init-declarations.js index d952b8925ed..b2ddf64fb4b 100644 --- a/lib/rules/init-declarations.js +++ b/lib/rules/init-declarations.js @@ -48,7 +48,7 @@ module.exports = { type: "suggestion", docs: { - description: "require or disallow initialization in variable declarations", + description: "Require or disallow initialization in variable declarations", recommended: false, url: "https://eslint.org/docs/rules/init-declarations" }, diff --git a/lib/rules/jsx-quotes.js b/lib/rules/jsx-quotes.js index f63dfd608bc..6745bb64b36 100644 --- a/lib/rules/jsx-quotes.js +++ b/lib/rules/jsx-quotes.js @@ -42,7 +42,7 @@ module.exports = { type: "layout", docs: { - description: "enforce the consistent use of either double or single quotes in JSX attributes", + description: "Enforce the consistent use of either double or single quotes in JSX attributes", recommended: false, url: "https://eslint.org/docs/rules/jsx-quotes" }, diff --git a/lib/rules/key-spacing.js b/lib/rules/key-spacing.js index ce8bad5bb35..a33ef29891e 100644 --- a/lib/rules/key-spacing.js +++ b/lib/rules/key-spacing.js @@ -139,7 +139,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing between keys and values in object literal properties", + description: "Enforce consistent spacing between keys and values in object literal properties", recommended: false, url: "https://eslint.org/docs/rules/key-spacing" }, diff --git a/lib/rules/keyword-spacing.js b/lib/rules/keyword-spacing.js index 16a65d78696..59a500f5bfc 100644 --- a/lib/rules/keyword-spacing.js +++ b/lib/rules/keyword-spacing.js @@ -67,7 +67,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing before and after keywords", + description: "Enforce consistent spacing before and after keywords", recommended: false, url: "https://eslint.org/docs/rules/keyword-spacing" }, diff --git a/lib/rules/line-comment-position.js b/lib/rules/line-comment-position.js index 9ce2831dec6..0631ebe6f32 100644 --- a/lib/rules/line-comment-position.js +++ b/lib/rules/line-comment-position.js @@ -16,7 +16,7 @@ module.exports = { type: "layout", docs: { - description: "enforce position of line comments", + description: "Enforce position of line comments", recommended: false, url: "https://eslint.org/docs/rules/line-comment-position" }, diff --git a/lib/rules/linebreak-style.js b/lib/rules/linebreak-style.js index 483788aa6ef..a5dc39d7967 100644 --- a/lib/rules/linebreak-style.js +++ b/lib/rules/linebreak-style.js @@ -21,7 +21,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent linebreak style", + description: "Enforce consistent linebreak style", recommended: false, url: "https://eslint.org/docs/rules/linebreak-style" }, diff --git a/lib/rules/lines-around-comment.js b/lib/rules/lines-around-comment.js index 6b1cd5f848b..974de21ed1d 100644 --- a/lib/rules/lines-around-comment.js +++ b/lib/rules/lines-around-comment.js @@ -55,7 +55,7 @@ module.exports = { type: "layout", docs: { - description: "require empty lines around comments", + description: "Require empty lines around comments", recommended: false, url: "https://eslint.org/docs/rules/lines-around-comment" }, diff --git a/lib/rules/lines-around-directive.js b/lib/rules/lines-around-directive.js index 21884f162e8..816efc979b7 100644 --- a/lib/rules/lines-around-directive.js +++ b/lib/rules/lines-around-directive.js @@ -18,7 +18,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow newlines around directives", + description: "Require or disallow newlines around directives", recommended: false, url: "https://eslint.org/docs/rules/lines-around-directive" }, diff --git a/lib/rules/lines-between-class-members.js b/lib/rules/lines-between-class-members.js index 1d6b7e7693e..26357aa3dde 100644 --- a/lib/rules/lines-between-class-members.js +++ b/lib/rules/lines-between-class-members.js @@ -20,7 +20,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow an empty line between class members", + description: "Require or disallow an empty line between class members", recommended: false, url: "https://eslint.org/docs/rules/lines-between-class-members" }, diff --git a/lib/rules/max-classes-per-file.js b/lib/rules/max-classes-per-file.js index 2157bebe4a9..0bd626fe6e8 100644 --- a/lib/rules/max-classes-per-file.js +++ b/lib/rules/max-classes-per-file.js @@ -19,7 +19,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce a maximum number of classes per file", + description: "Enforce a maximum number of classes per file", recommended: false, url: "https://eslint.org/docs/rules/max-classes-per-file" }, diff --git a/lib/rules/max-depth.js b/lib/rules/max-depth.js index 8006ffdef75..6b428ced763 100644 --- a/lib/rules/max-depth.js +++ b/lib/rules/max-depth.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce a maximum depth that blocks can be nested", + description: "Enforce a maximum depth that blocks can be nested", recommended: false, url: "https://eslint.org/docs/rules/max-depth" }, diff --git a/lib/rules/max-len.js b/lib/rules/max-len.js index d05559e5baf..0d3b2af7026 100644 --- a/lib/rules/max-len.js +++ b/lib/rules/max-len.js @@ -69,7 +69,7 @@ module.exports = { type: "layout", docs: { - description: "enforce a maximum line length", + description: "Enforce a maximum line length", recommended: false, url: "https://eslint.org/docs/rules/max-len" }, diff --git a/lib/rules/max-lines-per-function.js b/lib/rules/max-lines-per-function.js index 5985a739e4b..fad646cc0c3 100644 --- a/lib/rules/max-lines-per-function.js +++ b/lib/rules/max-lines-per-function.js @@ -71,7 +71,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce a maximum number of lines of code in a function", + description: "Enforce a maximum number of lines of code in a function", recommended: false, url: "https://eslint.org/docs/rules/max-lines-per-function" }, diff --git a/lib/rules/max-lines.js b/lib/rules/max-lines.js index 772f02aff08..d0e5bad3b2b 100644 --- a/lib/rules/max-lines.js +++ b/lib/rules/max-lines.js @@ -34,7 +34,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce a maximum number of lines per file", + description: "Enforce a maximum number of lines per file", recommended: false, url: "https://eslint.org/docs/rules/max-lines" }, diff --git a/lib/rules/max-nested-callbacks.js b/lib/rules/max-nested-callbacks.js index 0d430507790..3764d5dee95 100644 --- a/lib/rules/max-nested-callbacks.js +++ b/lib/rules/max-nested-callbacks.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce a maximum depth that callbacks can be nested", + description: "Enforce a maximum depth that callbacks can be nested", recommended: false, url: "https://eslint.org/docs/rules/max-nested-callbacks" }, diff --git a/lib/rules/max-params.js b/lib/rules/max-params.js index 72379d217d6..8de1ab44b8a 100644 --- a/lib/rules/max-params.js +++ b/lib/rules/max-params.js @@ -22,7 +22,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce a maximum number of parameters in function definitions", + description: "Enforce a maximum number of parameters in function definitions", recommended: false, url: "https://eslint.org/docs/rules/max-params" }, diff --git a/lib/rules/max-statements-per-line.js b/lib/rules/max-statements-per-line.js index 61b508cf6cd..ada9cf0fe5e 100644 --- a/lib/rules/max-statements-per-line.js +++ b/lib/rules/max-statements-per-line.js @@ -20,7 +20,7 @@ module.exports = { type: "layout", docs: { - description: "enforce a maximum number of statements allowed per line", + description: "Enforce a maximum number of statements allowed per line", recommended: false, url: "https://eslint.org/docs/rules/max-statements-per-line" }, diff --git a/lib/rules/max-statements.js b/lib/rules/max-statements.js index 1f627b6843e..c598b1059d0 100644 --- a/lib/rules/max-statements.js +++ b/lib/rules/max-statements.js @@ -22,7 +22,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce a maximum number of statements allowed in function blocks", + description: "Enforce a maximum number of statements allowed in function blocks", recommended: false, url: "https://eslint.org/docs/rules/max-statements" }, diff --git a/lib/rules/multiline-comment-style.js b/lib/rules/multiline-comment-style.js index 7985bc86270..68cd666532d 100644 --- a/lib/rules/multiline-comment-style.js +++ b/lib/rules/multiline-comment-style.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce a particular style for multiline comments", + description: "Enforce a particular style for multiline comments", recommended: false, url: "https://eslint.org/docs/rules/multiline-comment-style" }, diff --git a/lib/rules/multiline-ternary.js b/lib/rules/multiline-ternary.js index 91aa5a10031..62c84bbfed8 100644 --- a/lib/rules/multiline-ternary.js +++ b/lib/rules/multiline-ternary.js @@ -17,7 +17,7 @@ module.exports = { type: "layout", docs: { - description: "enforce newlines between operands of ternary expressions", + description: "Enforce newlines between operands of ternary expressions", recommended: false, url: "https://eslint.org/docs/rules/multiline-ternary" }, diff --git a/lib/rules/new-cap.js b/lib/rules/new-cap.js index 466cfd4c585..ad59fd90621 100644 --- a/lib/rules/new-cap.js +++ b/lib/rules/new-cap.js @@ -82,7 +82,7 @@ module.exports = { type: "suggestion", docs: { - description: "require constructor names to begin with a capital letter", + description: "Require constructor names to begin with a capital letter", recommended: false, url: "https://eslint.org/docs/rules/new-cap" }, diff --git a/lib/rules/new-parens.js b/lib/rules/new-parens.js index 8ee4a2e1d19..f5a98a45d4d 100644 --- a/lib/rules/new-parens.js +++ b/lib/rules/new-parens.js @@ -25,7 +25,7 @@ module.exports = { type: "layout", docs: { - description: "enforce or disallow parentheses when invoking a constructor with no arguments", + description: "Enforce or disallow parentheses when invoking a constructor with no arguments", recommended: false, url: "https://eslint.org/docs/rules/new-parens" }, diff --git a/lib/rules/newline-after-var.js b/lib/rules/newline-after-var.js index e519a3afb6b..2b4d8584656 100644 --- a/lib/rules/newline-after-var.js +++ b/lib/rules/newline-after-var.js @@ -22,7 +22,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow an empty line after variable declarations", + description: "Require or disallow an empty line after variable declarations", recommended: false, url: "https://eslint.org/docs/rules/newline-after-var" }, diff --git a/lib/rules/newline-before-return.js b/lib/rules/newline-before-return.js index d07c23658ed..007d9427363 100644 --- a/lib/rules/newline-before-return.js +++ b/lib/rules/newline-before-return.js @@ -15,7 +15,7 @@ module.exports = { type: "layout", docs: { - description: "require an empty line before `return` statements", + description: "Require an empty line before `return` statements", recommended: false, url: "https://eslint.org/docs/rules/newline-before-return" }, diff --git a/lib/rules/newline-per-chained-call.js b/lib/rules/newline-per-chained-call.js index 818bf703d2b..83844a52b35 100644 --- a/lib/rules/newline-per-chained-call.js +++ b/lib/rules/newline-per-chained-call.js @@ -18,7 +18,7 @@ module.exports = { type: "layout", docs: { - description: "require a newline after each call in a method chain", + description: "Require a newline after each call in a method chain", recommended: false, url: "https://eslint.org/docs/rules/newline-per-chained-call" }, diff --git a/lib/rules/no-alert.js b/lib/rules/no-alert.js index c6f7ddf38db..ba0125c877b 100644 --- a/lib/rules/no-alert.js +++ b/lib/rules/no-alert.js @@ -88,7 +88,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of `alert`, `confirm`, and `prompt`", + description: "Disallow the use of `alert`, `confirm`, and `prompt`", recommended: false, url: "https://eslint.org/docs/rules/no-alert" }, diff --git a/lib/rules/no-array-constructor.js b/lib/rules/no-array-constructor.js index 02e6114dadc..93b79abfd89 100644 --- a/lib/rules/no-array-constructor.js +++ b/lib/rules/no-array-constructor.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `Array` constructors", + description: "Disallow `Array` constructors", recommended: false, url: "https://eslint.org/docs/rules/no-array-constructor" }, diff --git a/lib/rules/no-async-promise-executor.js b/lib/rules/no-async-promise-executor.js index f940f152e3c..52c51862feb 100644 --- a/lib/rules/no-async-promise-executor.js +++ b/lib/rules/no-async-promise-executor.js @@ -14,7 +14,7 @@ module.exports = { type: "problem", docs: { - description: "disallow using an async function as a Promise executor", + description: "Disallow using an async function as a Promise executor", recommended: true, url: "https://eslint.org/docs/rules/no-async-promise-executor" }, diff --git a/lib/rules/no-await-in-loop.js b/lib/rules/no-await-in-loop.js index 3aea39a16b9..905a793c830 100644 --- a/lib/rules/no-await-in-loop.js +++ b/lib/rules/no-await-in-loop.js @@ -59,7 +59,7 @@ module.exports = { type: "problem", docs: { - description: "disallow `await` inside of loops", + description: "Disallow `await` inside of loops", recommended: false, url: "https://eslint.org/docs/rules/no-await-in-loop" }, diff --git a/lib/rules/no-bitwise.js b/lib/rules/no-bitwise.js index 43a1e764edc..172ea046bbe 100644 --- a/lib/rules/no-bitwise.js +++ b/lib/rules/no-bitwise.js @@ -26,7 +26,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow bitwise operators", + description: "Disallow bitwise operators", recommended: false, url: "https://eslint.org/docs/rules/no-bitwise" }, diff --git a/lib/rules/no-buffer-constructor.js b/lib/rules/no-buffer-constructor.js index 678d7032ab4..93003928815 100644 --- a/lib/rules/no-buffer-constructor.js +++ b/lib/rules/no-buffer-constructor.js @@ -19,7 +19,7 @@ module.exports = { type: "problem", docs: { - description: "disallow use of the `Buffer()` constructor", + description: "Disallow use of the `Buffer()` constructor", recommended: false, url: "https://eslint.org/docs/rules/no-buffer-constructor" }, diff --git a/lib/rules/no-caller.js b/lib/rules/no-caller.js index a6ad94f2fe6..884a02bdcf6 100644 --- a/lib/rules/no-caller.js +++ b/lib/rules/no-caller.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of `arguments.caller` or `arguments.callee`", + description: "Disallow the use of `arguments.caller` or `arguments.callee`", recommended: false, url: "https://eslint.org/docs/rules/no-caller" }, diff --git a/lib/rules/no-case-declarations.js b/lib/rules/no-case-declarations.js index d722f0cf584..6557ba3a03d 100644 --- a/lib/rules/no-case-declarations.js +++ b/lib/rules/no-case-declarations.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow lexical declarations in case clauses", + description: "Disallow lexical declarations in case clauses", recommended: true, url: "https://eslint.org/docs/rules/no-case-declarations" }, diff --git a/lib/rules/no-catch-shadow.js b/lib/rules/no-catch-shadow.js index d09c9134968..49f1ba9649b 100644 --- a/lib/rules/no-catch-shadow.js +++ b/lib/rules/no-catch-shadow.js @@ -22,7 +22,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `catch` clause parameters from shadowing variables in the outer scope", + description: "Disallow `catch` clause parameters from shadowing variables in the outer scope", recommended: false, url: "https://eslint.org/docs/rules/no-catch-shadow" }, diff --git a/lib/rules/no-class-assign.js b/lib/rules/no-class-assign.js index f679d4263e8..32e48e21188 100644 --- a/lib/rules/no-class-assign.js +++ b/lib/rules/no-class-assign.js @@ -17,7 +17,7 @@ module.exports = { type: "problem", docs: { - description: "disallow reassigning class members", + description: "Disallow reassigning class members", recommended: true, url: "https://eslint.org/docs/rules/no-class-assign" }, diff --git a/lib/rules/no-compare-neg-zero.js b/lib/rules/no-compare-neg-zero.js index fb56b99c58b..9715c2f0f37 100644 --- a/lib/rules/no-compare-neg-zero.js +++ b/lib/rules/no-compare-neg-zero.js @@ -14,7 +14,7 @@ module.exports = { type: "problem", docs: { - description: "disallow comparing against -0", + description: "Disallow comparing against -0", recommended: true, url: "https://eslint.org/docs/rules/no-compare-neg-zero" }, diff --git a/lib/rules/no-cond-assign.js b/lib/rules/no-cond-assign.js index 30d5b3bdaee..59efb341f09 100644 --- a/lib/rules/no-cond-assign.js +++ b/lib/rules/no-cond-assign.js @@ -34,7 +34,7 @@ module.exports = { type: "problem", docs: { - description: "disallow assignment operators in conditional expressions", + description: "Disallow assignment operators in conditional expressions", recommended: true, url: "https://eslint.org/docs/rules/no-cond-assign" }, diff --git a/lib/rules/no-confusing-arrow.js b/lib/rules/no-confusing-arrow.js index 9cdd0a85dbb..d2b6641b74f 100644 --- a/lib/rules/no-confusing-arrow.js +++ b/lib/rules/no-confusing-arrow.js @@ -31,7 +31,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow arrow functions where they could be confused with comparisons", + description: "Disallow arrow functions where they could be confused with comparisons", recommended: false, url: "https://eslint.org/docs/rules/no-confusing-arrow" }, diff --git a/lib/rules/no-console.js b/lib/rules/no-console.js index 464d5647cc3..bad6b6f4ee8 100644 --- a/lib/rules/no-console.js +++ b/lib/rules/no-console.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of `console`", + description: "Disallow the use of `console`", recommended: false, url: "https://eslint.org/docs/rules/no-console" }, diff --git a/lib/rules/no-const-assign.js b/lib/rules/no-const-assign.js index b5f7c37a98f..55e40c8849f 100644 --- a/lib/rules/no-const-assign.js +++ b/lib/rules/no-const-assign.js @@ -17,7 +17,7 @@ module.exports = { type: "problem", docs: { - description: "disallow reassigning `const` variables", + description: "Disallow reassigning `const` variables", recommended: true, url: "https://eslint.org/docs/rules/no-const-assign" }, diff --git a/lib/rules/no-constant-binary-expression.js b/lib/rules/no-constant-binary-expression.js index 6cad0eff3e5..dccfa2f5826 100644 --- a/lib/rules/no-constant-binary-expression.js +++ b/lib/rules/no-constant-binary-expression.js @@ -432,7 +432,7 @@ module.exports = { meta: { type: "problem", docs: { - description: "disallow expressions where the operation doesn't affect the value", + description: "Disallow expressions where the operation doesn't affect the value", recommended: false, url: "https://eslint.org/docs/rules/no-constant-binary-expression" }, diff --git a/lib/rules/no-constant-condition.js b/lib/rules/no-constant-condition.js index a0871fe972d..2ef687f6dca 100644 --- a/lib/rules/no-constant-condition.js +++ b/lib/rules/no-constant-condition.js @@ -21,7 +21,7 @@ module.exports = { type: "problem", docs: { - description: "disallow constant expressions in conditions", + description: "Disallow constant expressions in conditions", recommended: true, url: "https://eslint.org/docs/rules/no-constant-condition" }, diff --git a/lib/rules/no-constructor-return.js b/lib/rules/no-constructor-return.js index f8a717c75e5..911a32abcae 100644 --- a/lib/rules/no-constructor-return.js +++ b/lib/rules/no-constructor-return.js @@ -15,7 +15,7 @@ module.exports = { type: "problem", docs: { - description: "disallow returning value from constructor", + description: "Disallow returning value from constructor", recommended: false, url: "https://eslint.org/docs/rules/no-constructor-return" }, diff --git a/lib/rules/no-continue.js b/lib/rules/no-continue.js index 8658a7984bb..80381fc3f84 100644 --- a/lib/rules/no-continue.js +++ b/lib/rules/no-continue.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `continue` statements", + description: "Disallow `continue` statements", recommended: false, url: "https://eslint.org/docs/rules/no-continue" }, diff --git a/lib/rules/no-control-regex.js b/lib/rules/no-control-regex.js index 00278f5c145..ba108437257 100644 --- a/lib/rules/no-control-regex.js +++ b/lib/rules/no-control-regex.js @@ -54,7 +54,7 @@ module.exports = { type: "problem", docs: { - description: "disallow control characters in regular expressions", + description: "Disallow control characters in regular expressions", recommended: true, url: "https://eslint.org/docs/rules/no-control-regex" }, diff --git a/lib/rules/no-debugger.js b/lib/rules/no-debugger.js index e62db1b7393..3b88079a0fb 100644 --- a/lib/rules/no-debugger.js +++ b/lib/rules/no-debugger.js @@ -15,7 +15,7 @@ module.exports = { type: "problem", docs: { - description: "disallow the use of `debugger`", + description: "Disallow the use of `debugger`", recommended: true, url: "https://eslint.org/docs/rules/no-debugger" }, diff --git a/lib/rules/no-delete-var.js b/lib/rules/no-delete-var.js index 1d1c710b098..41021bd46a7 100644 --- a/lib/rules/no-delete-var.js +++ b/lib/rules/no-delete-var.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow deleting variables", + description: "Disallow deleting variables", recommended: true, url: "https://eslint.org/docs/rules/no-delete-var" }, diff --git a/lib/rules/no-div-regex.js b/lib/rules/no-div-regex.js index 175f6c20104..dd1c5782a58 100644 --- a/lib/rules/no-div-regex.js +++ b/lib/rules/no-div-regex.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow division operators explicitly at the beginning of regular expressions", + description: "Disallow division operators explicitly at the beginning of regular expressions", recommended: false, url: "https://eslint.org/docs/rules/no-div-regex" }, diff --git a/lib/rules/no-dupe-args.js b/lib/rules/no-dupe-args.js index 13090e19a87..faf253793ec 100644 --- a/lib/rules/no-dupe-args.js +++ b/lib/rules/no-dupe-args.js @@ -15,7 +15,7 @@ module.exports = { type: "problem", docs: { - description: "disallow duplicate arguments in `function` definitions", + description: "Disallow duplicate arguments in `function` definitions", recommended: true, url: "https://eslint.org/docs/rules/no-dupe-args" }, diff --git a/lib/rules/no-dupe-class-members.js b/lib/rules/no-dupe-class-members.js index ae61f164ca9..8eca7878a46 100644 --- a/lib/rules/no-dupe-class-members.js +++ b/lib/rules/no-dupe-class-members.js @@ -17,7 +17,7 @@ module.exports = { type: "problem", docs: { - description: "disallow duplicate class members", + description: "Disallow duplicate class members", recommended: true, url: "https://eslint.org/docs/rules/no-dupe-class-members" }, diff --git a/lib/rules/no-dupe-else-if.js b/lib/rules/no-dupe-else-if.js index 1e1d549185d..49db5ec7c6c 100644 --- a/lib/rules/no-dupe-else-if.js +++ b/lib/rules/no-dupe-else-if.js @@ -52,7 +52,7 @@ module.exports = { type: "problem", docs: { - description: "disallow duplicate conditions in if-else-if chains", + description: "Disallow duplicate conditions in if-else-if chains", recommended: true, url: "https://eslint.org/docs/rules/no-dupe-else-if" }, diff --git a/lib/rules/no-dupe-keys.js b/lib/rules/no-dupe-keys.js index dac13cf9e09..65c34bc5fd1 100644 --- a/lib/rules/no-dupe-keys.js +++ b/lib/rules/no-dupe-keys.js @@ -88,7 +88,7 @@ module.exports = { type: "problem", docs: { - description: "disallow duplicate keys in object literals", + description: "Disallow duplicate keys in object literals", recommended: true, url: "https://eslint.org/docs/rules/no-dupe-keys" }, diff --git a/lib/rules/no-duplicate-case.js b/lib/rules/no-duplicate-case.js index a0c0b31308b..d436afdd007 100644 --- a/lib/rules/no-duplicate-case.js +++ b/lib/rules/no-duplicate-case.js @@ -22,7 +22,7 @@ module.exports = { type: "problem", docs: { - description: "disallow duplicate case labels", + description: "Disallow duplicate case labels", recommended: true, url: "https://eslint.org/docs/rules/no-duplicate-case" }, diff --git a/lib/rules/no-duplicate-imports.js b/lib/rules/no-duplicate-imports.js index 947bb30c2e1..619e2588e91 100644 --- a/lib/rules/no-duplicate-imports.js +++ b/lib/rules/no-duplicate-imports.js @@ -233,7 +233,7 @@ module.exports = { type: "problem", docs: { - description: "disallow duplicate module imports", + description: "Disallow duplicate module imports", recommended: false, url: "https://eslint.org/docs/rules/no-duplicate-imports" }, diff --git a/lib/rules/no-else-return.js b/lib/rules/no-else-return.js index 3662fc8c6e7..d1da3aa49cb 100644 --- a/lib/rules/no-else-return.js +++ b/lib/rules/no-else-return.js @@ -22,7 +22,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `else` blocks after `return` statements in `if` statements", + description: "Disallow `else` blocks after `return` statements in `if` statements", recommended: false, url: "https://eslint.org/docs/rules/no-else-return" }, diff --git a/lib/rules/no-empty-character-class.js b/lib/rules/no-empty-character-class.js index f75f59191aa..2d294f4bded 100644 --- a/lib/rules/no-empty-character-class.js +++ b/lib/rules/no-empty-character-class.js @@ -30,7 +30,7 @@ module.exports = { type: "problem", docs: { - description: "disallow empty character classes in regular expressions", + description: "Disallow empty character classes in regular expressions", recommended: true, url: "https://eslint.org/docs/rules/no-empty-character-class" }, diff --git a/lib/rules/no-empty-function.js b/lib/rules/no-empty-function.js index e23b69e537b..4c9daa931e2 100644 --- a/lib/rules/no-empty-function.js +++ b/lib/rules/no-empty-function.js @@ -95,7 +95,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow empty functions", + description: "Disallow empty functions", recommended: false, url: "https://eslint.org/docs/rules/no-empty-function" }, diff --git a/lib/rules/no-empty-pattern.js b/lib/rules/no-empty-pattern.js index 2de575fcf08..5a497f03972 100644 --- a/lib/rules/no-empty-pattern.js +++ b/lib/rules/no-empty-pattern.js @@ -14,7 +14,7 @@ module.exports = { type: "problem", docs: { - description: "disallow empty destructuring patterns", + description: "Disallow empty destructuring patterns", recommended: true, url: "https://eslint.org/docs/rules/no-empty-pattern" }, diff --git a/lib/rules/no-empty.js b/lib/rules/no-empty.js index f04ee2cb320..459140a2e70 100644 --- a/lib/rules/no-empty.js +++ b/lib/rules/no-empty.js @@ -20,7 +20,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow empty block statements", + description: "Disallow empty block statements", recommended: true, url: "https://eslint.org/docs/rules/no-empty" }, diff --git a/lib/rules/no-eq-null.js b/lib/rules/no-eq-null.js index b693737126d..9a886803dc5 100644 --- a/lib/rules/no-eq-null.js +++ b/lib/rules/no-eq-null.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `null` comparisons without type-checking operators", + description: "Disallow `null` comparisons without type-checking operators", recommended: false, url: "https://eslint.org/docs/rules/no-eq-null" }, diff --git a/lib/rules/no-eval.js b/lib/rules/no-eval.js index 7af8dfac7fa..03f7b1f691c 100644 --- a/lib/rules/no-eval.js +++ b/lib/rules/no-eval.js @@ -43,7 +43,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of `eval()`", + description: "Disallow the use of `eval()`", recommended: false, url: "https://eslint.org/docs/rules/no-eval" }, diff --git a/lib/rules/no-ex-assign.js b/lib/rules/no-ex-assign.js index 3db14206b0b..4c77b1128ad 100644 --- a/lib/rules/no-ex-assign.js +++ b/lib/rules/no-ex-assign.js @@ -17,7 +17,7 @@ module.exports = { type: "problem", docs: { - description: "disallow reassigning exceptions in `catch` clauses", + description: "Disallow reassigning exceptions in `catch` clauses", recommended: true, url: "https://eslint.org/docs/rules/no-ex-assign" }, diff --git a/lib/rules/no-extend-native.js b/lib/rules/no-extend-native.js index 771200f26f7..52c6bd31103 100644 --- a/lib/rules/no-extend-native.js +++ b/lib/rules/no-extend-native.js @@ -22,7 +22,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow extending native types", + description: "Disallow extending native types", recommended: false, url: "https://eslint.org/docs/rules/no-extend-native" }, diff --git a/lib/rules/no-extra-bind.js b/lib/rules/no-extra-bind.js index 561cb1a33f8..caf6d8b1f80 100644 --- a/lib/rules/no-extra-bind.js +++ b/lib/rules/no-extra-bind.js @@ -26,7 +26,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary calls to `.bind()`", + description: "Disallow unnecessary calls to `.bind()`", recommended: false, url: "https://eslint.org/docs/rules/no-extra-bind" }, diff --git a/lib/rules/no-extra-boolean-cast.js b/lib/rules/no-extra-boolean-cast.js index ddb1d8330d5..1c2bc4e5032 100644 --- a/lib/rules/no-extra-boolean-cast.js +++ b/lib/rules/no-extra-boolean-cast.js @@ -24,7 +24,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary boolean casts", + description: "Disallow unnecessary boolean casts", recommended: true, url: "https://eslint.org/docs/rules/no-extra-boolean-cast" }, diff --git a/lib/rules/no-extra-label.js b/lib/rules/no-extra-label.js index 9186a9faca1..bda3dd0efb0 100644 --- a/lib/rules/no-extra-label.js +++ b/lib/rules/no-extra-label.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary labels", + description: "Disallow unnecessary labels", recommended: false, url: "https://eslint.org/docs/rules/no-extra-label" }, diff --git a/lib/rules/no-extra-parens.js b/lib/rules/no-extra-parens.js index 5b54ae26fe3..5ae9af8fd54 100644 --- a/lib/rules/no-extra-parens.js +++ b/lib/rules/no-extra-parens.js @@ -17,7 +17,7 @@ module.exports = { type: "layout", docs: { - description: "disallow unnecessary parentheses", + description: "Disallow unnecessary parentheses", recommended: false, url: "https://eslint.org/docs/rules/no-extra-parens" }, diff --git a/lib/rules/no-extra-semi.js b/lib/rules/no-extra-semi.js index 625310eea69..c61ad37dce8 100644 --- a/lib/rules/no-extra-semi.js +++ b/lib/rules/no-extra-semi.js @@ -22,7 +22,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary semicolons", + description: "Disallow unnecessary semicolons", recommended: true, url: "https://eslint.org/docs/rules/no-extra-semi" }, diff --git a/lib/rules/no-fallthrough.js b/lib/rules/no-fallthrough.js index f3b7c8554ad..b51faa87bae 100644 --- a/lib/rules/no-fallthrough.js +++ b/lib/rules/no-fallthrough.js @@ -64,7 +64,7 @@ module.exports = { type: "problem", docs: { - description: "disallow fallthrough of `case` statements", + description: "Disallow fallthrough of `case` statements", recommended: true, url: "https://eslint.org/docs/rules/no-fallthrough" }, diff --git a/lib/rules/no-floating-decimal.js b/lib/rules/no-floating-decimal.js index 8831bb824d0..cce50bf9dad 100644 --- a/lib/rules/no-floating-decimal.js +++ b/lib/rules/no-floating-decimal.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow leading or trailing decimal points in numeric literals", + description: "Disallow leading or trailing decimal points in numeric literals", recommended: false, url: "https://eslint.org/docs/rules/no-floating-decimal" }, diff --git a/lib/rules/no-func-assign.js b/lib/rules/no-func-assign.js index 04a7dd37055..2c8fa6a8e08 100644 --- a/lib/rules/no-func-assign.js +++ b/lib/rules/no-func-assign.js @@ -17,7 +17,7 @@ module.exports = { type: "problem", docs: { - description: "disallow reassigning `function` declarations", + description: "Disallow reassigning `function` declarations", recommended: true, url: "https://eslint.org/docs/rules/no-func-assign" }, diff --git a/lib/rules/no-global-assign.js b/lib/rules/no-global-assign.js index 1225baec5de..9f2f0ee3642 100644 --- a/lib/rules/no-global-assign.js +++ b/lib/rules/no-global-assign.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow assignments to native objects or read-only global variables", + description: "Disallow assignments to native objects or read-only global variables", recommended: true, url: "https://eslint.org/docs/rules/no-global-assign" }, diff --git a/lib/rules/no-implicit-coercion.js b/lib/rules/no-implicit-coercion.js index 428f63b81db..c2367715d9d 100644 --- a/lib/rules/no-implicit-coercion.js +++ b/lib/rules/no-implicit-coercion.js @@ -173,7 +173,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow shorthand type conversions", + description: "Disallow shorthand type conversions", recommended: false, url: "https://eslint.org/docs/rules/no-implicit-coercion" }, diff --git a/lib/rules/no-implicit-globals.js b/lib/rules/no-implicit-globals.js index 5dd6aa71acd..934630ea070 100644 --- a/lib/rules/no-implicit-globals.js +++ b/lib/rules/no-implicit-globals.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow declarations in the global scope", + description: "Disallow declarations in the global scope", recommended: false, url: "https://eslint.org/docs/rules/no-implicit-globals" }, diff --git a/lib/rules/no-implied-eval.js b/lib/rules/no-implied-eval.js index 38de5b31ccc..44f146171aa 100644 --- a/lib/rules/no-implied-eval.js +++ b/lib/rules/no-implied-eval.js @@ -22,7 +22,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of `eval()`-like methods", + description: "Disallow the use of `eval()`-like methods", recommended: false, url: "https://eslint.org/docs/rules/no-implied-eval" }, diff --git a/lib/rules/no-import-assign.js b/lib/rules/no-import-assign.js index 385386e9a43..fc104fe6c46 100644 --- a/lib/rules/no-import-assign.js +++ b/lib/rules/no-import-assign.js @@ -180,7 +180,7 @@ module.exports = { type: "problem", docs: { - description: "disallow assigning to imported bindings", + description: "Disallow assigning to imported bindings", recommended: true, url: "https://eslint.org/docs/rules/no-import-assign" }, diff --git a/lib/rules/no-inline-comments.js b/lib/rules/no-inline-comments.js index 2ed7feb46b8..366f567f670 100644 --- a/lib/rules/no-inline-comments.js +++ b/lib/rules/no-inline-comments.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow inline comments after code", + description: "Disallow inline comments after code", recommended: false, url: "https://eslint.org/docs/rules/no-inline-comments" }, diff --git a/lib/rules/no-inner-declarations.js b/lib/rules/no-inner-declarations.js index 3b0feb71a3f..932816641e0 100644 --- a/lib/rules/no-inner-declarations.js +++ b/lib/rules/no-inner-declarations.js @@ -48,7 +48,7 @@ module.exports = { type: "problem", docs: { - description: "disallow variable or `function` declarations in nested blocks", + description: "Disallow variable or `function` declarations in nested blocks", recommended: true, url: "https://eslint.org/docs/rules/no-inner-declarations" }, diff --git a/lib/rules/no-invalid-regexp.js b/lib/rules/no-invalid-regexp.js index 92ac5125e60..0f1d9c7bedc 100644 --- a/lib/rules/no-invalid-regexp.js +++ b/lib/rules/no-invalid-regexp.js @@ -23,7 +23,7 @@ module.exports = { type: "problem", docs: { - description: "disallow invalid regular expression strings in `RegExp` constructors", + description: "Disallow invalid regular expression strings in `RegExp` constructors", recommended: true, url: "https://eslint.org/docs/rules/no-invalid-regexp" }, diff --git a/lib/rules/no-invalid-this.js b/lib/rules/no-invalid-this.js index a97696b8562..b9cb43af5d7 100644 --- a/lib/rules/no-invalid-this.js +++ b/lib/rules/no-invalid-this.js @@ -36,7 +36,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow use of `this` in contexts where the value of `this` is `undefined`", + description: "Disallow use of `this` in contexts where the value of `this` is `undefined`", recommended: false, url: "https://eslint.org/docs/rules/no-invalid-this" }, diff --git a/lib/rules/no-irregular-whitespace.js b/lib/rules/no-irregular-whitespace.js index 65c4d67285c..d1646c7b8a1 100644 --- a/lib/rules/no-irregular-whitespace.js +++ b/lib/rules/no-irregular-whitespace.js @@ -31,7 +31,7 @@ module.exports = { type: "problem", docs: { - description: "disallow irregular whitespace", + description: "Disallow irregular whitespace", recommended: true, url: "https://eslint.org/docs/rules/no-irregular-whitespace" }, diff --git a/lib/rules/no-iterator.js b/lib/rules/no-iterator.js index d11267286c8..3550c7b111b 100644 --- a/lib/rules/no-iterator.js +++ b/lib/rules/no-iterator.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of the `__iterator__` property", + description: "Disallow the use of the `__iterator__` property", recommended: false, url: "https://eslint.org/docs/rules/no-iterator" }, diff --git a/lib/rules/no-label-var.js b/lib/rules/no-label-var.js index 50211811ac8..a07d283f522 100644 --- a/lib/rules/no-label-var.js +++ b/lib/rules/no-label-var.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow labels that share a name with a variable", + description: "Disallow labels that share a name with a variable", recommended: false, url: "https://eslint.org/docs/rules/no-label-var" }, diff --git a/lib/rules/no-labels.js b/lib/rules/no-labels.js index 2e79f378a9b..6112d04affb 100644 --- a/lib/rules/no-labels.js +++ b/lib/rules/no-labels.js @@ -20,7 +20,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow labeled statements", + description: "Disallow labeled statements", recommended: false, url: "https://eslint.org/docs/rules/no-labels" }, diff --git a/lib/rules/no-lone-blocks.js b/lib/rules/no-lone-blocks.js index f9fe9514dd7..486a76ffdc9 100644 --- a/lib/rules/no-lone-blocks.js +++ b/lib/rules/no-lone-blocks.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary nested blocks", + description: "Disallow unnecessary nested blocks", recommended: false, url: "https://eslint.org/docs/rules/no-lone-blocks" }, diff --git a/lib/rules/no-lonely-if.js b/lib/rules/no-lonely-if.js index 9abd4650b56..0774b9fa30f 100644 --- a/lib/rules/no-lonely-if.js +++ b/lib/rules/no-lonely-if.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `if` statements as the only statement in `else` blocks", + description: "Disallow `if` statements as the only statement in `else` blocks", recommended: false, url: "https://eslint.org/docs/rules/no-lonely-if" }, diff --git a/lib/rules/no-loop-func.js b/lib/rules/no-loop-func.js index d087974e64b..f81a7133680 100644 --- a/lib/rules/no-loop-func.js +++ b/lib/rules/no-loop-func.js @@ -154,7 +154,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow function declarations that contain unsafe references inside loop statements", + description: "Disallow function declarations that contain unsafe references inside loop statements", recommended: false, url: "https://eslint.org/docs/rules/no-loop-func" }, diff --git a/lib/rules/no-loss-of-precision.js b/lib/rules/no-loss-of-precision.js index fefc7b768fe..6dc6d864dcd 100644 --- a/lib/rules/no-loss-of-precision.js +++ b/lib/rules/no-loss-of-precision.js @@ -15,7 +15,7 @@ module.exports = { type: "problem", docs: { - description: "disallow literal numbers that lose precision", + description: "Disallow literal numbers that lose precision", recommended: true, url: "https://eslint.org/docs/rules/no-loss-of-precision" }, diff --git a/lib/rules/no-magic-numbers.js b/lib/rules/no-magic-numbers.js index 6b4cf77c326..9b085881556 100644 --- a/lib/rules/no-magic-numbers.js +++ b/lib/rules/no-magic-numbers.js @@ -32,7 +32,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow magic numbers", + description: "Disallow magic numbers", recommended: false, url: "https://eslint.org/docs/rules/no-magic-numbers" }, diff --git a/lib/rules/no-misleading-character-class.js b/lib/rules/no-misleading-character-class.js index d3d9d382ac5..667d066e81c 100644 --- a/lib/rules/no-misleading-character-class.js +++ b/lib/rules/no-misleading-character-class.js @@ -107,7 +107,7 @@ module.exports = { type: "problem", docs: { - description: "disallow characters which are made with multiple code points in character class syntax", + description: "Disallow characters which are made with multiple code points in character class syntax", recommended: true, url: "https://eslint.org/docs/rules/no-misleading-character-class" }, diff --git a/lib/rules/no-mixed-operators.js b/lib/rules/no-mixed-operators.js index 0cace7ea910..cb6e9363c15 100644 --- a/lib/rules/no-mixed-operators.js +++ b/lib/rules/no-mixed-operators.js @@ -88,7 +88,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow mixed binary operators", + description: "Disallow mixed binary operators", recommended: false, url: "https://eslint.org/docs/rules/no-mixed-operators" }, diff --git a/lib/rules/no-mixed-requires.js b/lib/rules/no-mixed-requires.js index 97064243ed3..4e970574416 100644 --- a/lib/rules/no-mixed-requires.js +++ b/lib/rules/no-mixed-requires.js @@ -20,7 +20,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `require` calls to be mixed with regular variable declarations", + description: "Disallow `require` calls to be mixed with regular variable declarations", recommended: false, url: "https://eslint.org/docs/rules/no-mixed-requires" }, diff --git a/lib/rules/no-mixed-spaces-and-tabs.js b/lib/rules/no-mixed-spaces-and-tabs.js index f82a352caa4..b2d5a040b84 100644 --- a/lib/rules/no-mixed-spaces-and-tabs.js +++ b/lib/rules/no-mixed-spaces-and-tabs.js @@ -14,7 +14,7 @@ module.exports = { type: "layout", docs: { - description: "disallow mixed spaces and tabs for indentation", + description: "Disallow mixed spaces and tabs for indentation", recommended: true, url: "https://eslint.org/docs/rules/no-mixed-spaces-and-tabs" }, diff --git a/lib/rules/no-multi-assign.js b/lib/rules/no-multi-assign.js index be4d41f33d6..392b33ffd2d 100644 --- a/lib/rules/no-multi-assign.js +++ b/lib/rules/no-multi-assign.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow use of chained assignment expressions", + description: "Disallow use of chained assignment expressions", recommended: false, url: "https://eslint.org/docs/rules/no-multi-assign" }, diff --git a/lib/rules/no-multi-spaces.js b/lib/rules/no-multi-spaces.js index 6fac7e3ca7e..d8d3c6509cc 100644 --- a/lib/rules/no-multi-spaces.js +++ b/lib/rules/no-multi-spaces.js @@ -17,7 +17,7 @@ module.exports = { type: "layout", docs: { - description: "disallow multiple spaces", + description: "Disallow multiple spaces", recommended: false, url: "https://eslint.org/docs/rules/no-multi-spaces" }, diff --git a/lib/rules/no-multi-str.js b/lib/rules/no-multi-str.js index 6a17d581b98..c4400f45ee6 100644 --- a/lib/rules/no-multi-str.js +++ b/lib/rules/no-multi-str.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow multiline strings", + description: "Disallow multiline strings", recommended: false, url: "https://eslint.org/docs/rules/no-multi-str" }, diff --git a/lib/rules/no-multiple-empty-lines.js b/lib/rules/no-multiple-empty-lines.js index d012303cc33..e8b0f9859c0 100644 --- a/lib/rules/no-multiple-empty-lines.js +++ b/lib/rules/no-multiple-empty-lines.js @@ -15,7 +15,7 @@ module.exports = { type: "layout", docs: { - description: "disallow multiple empty lines", + description: "Disallow multiple empty lines", recommended: false, url: "https://eslint.org/docs/rules/no-multiple-empty-lines" }, diff --git a/lib/rules/no-native-reassign.js b/lib/rules/no-native-reassign.js index 5f396e404c6..634fea93308 100644 --- a/lib/rules/no-native-reassign.js +++ b/lib/rules/no-native-reassign.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow assignments to native objects or read-only global variables", + description: "Disallow assignments to native objects or read-only global variables", recommended: false, url: "https://eslint.org/docs/rules/no-native-reassign" }, diff --git a/lib/rules/no-negated-condition.js b/lib/rules/no-negated-condition.js index a2870137f57..387617767fa 100644 --- a/lib/rules/no-negated-condition.js +++ b/lib/rules/no-negated-condition.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow negated conditions", + description: "Disallow negated conditions", recommended: false, url: "https://eslint.org/docs/rules/no-negated-condition" }, diff --git a/lib/rules/no-negated-in-lhs.js b/lib/rules/no-negated-in-lhs.js index 95ab58a080f..975a8d75cb1 100644 --- a/lib/rules/no-negated-in-lhs.js +++ b/lib/rules/no-negated-in-lhs.js @@ -16,7 +16,7 @@ module.exports = { type: "problem", docs: { - description: "disallow negating the left operand in `in` expressions", + description: "Disallow negating the left operand in `in` expressions", recommended: false, url: "https://eslint.org/docs/rules/no-negated-in-lhs" }, diff --git a/lib/rules/no-nested-ternary.js b/lib/rules/no-nested-ternary.js index c87875e4040..fe97823416b 100644 --- a/lib/rules/no-nested-ternary.js +++ b/lib/rules/no-nested-ternary.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow nested ternary expressions", + description: "Disallow nested ternary expressions", recommended: false, url: "https://eslint.org/docs/rules/no-nested-ternary" }, diff --git a/lib/rules/no-new-func.js b/lib/rules/no-new-func.js index 3b599433519..4759f380b29 100644 --- a/lib/rules/no-new-func.js +++ b/lib/rules/no-new-func.js @@ -27,7 +27,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `new` operators with the `Function` object", + description: "Disallow `new` operators with the `Function` object", recommended: false, url: "https://eslint.org/docs/rules/no-new-func" }, diff --git a/lib/rules/no-new-object.js b/lib/rules/no-new-object.js index 02ff772678c..4dbe8db7365 100644 --- a/lib/rules/no-new-object.js +++ b/lib/rules/no-new-object.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `Object` constructors", + description: "Disallow `Object` constructors", recommended: false, url: "https://eslint.org/docs/rules/no-new-object" }, diff --git a/lib/rules/no-new-require.js b/lib/rules/no-new-require.js index 5dadf6c2538..63ca057b741 100644 --- a/lib/rules/no-new-require.js +++ b/lib/rules/no-new-require.js @@ -20,7 +20,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `new` operators with calls to `require`", + description: "Disallow `new` operators with calls to `require`", recommended: false, url: "https://eslint.org/docs/rules/no-new-require" }, diff --git a/lib/rules/no-new-symbol.js b/lib/rules/no-new-symbol.js index 6acfca94358..534201c0ba6 100644 --- a/lib/rules/no-new-symbol.js +++ b/lib/rules/no-new-symbol.js @@ -15,7 +15,7 @@ module.exports = { type: "problem", docs: { - description: "disallow `new` operators with the `Symbol` object", + description: "Disallow `new` operators with the `Symbol` object", recommended: true, url: "https://eslint.org/docs/rules/no-new-symbol" }, diff --git a/lib/rules/no-new-wrappers.js b/lib/rules/no-new-wrappers.js index 1fe06c1943e..ff44efc5930 100644 --- a/lib/rules/no-new-wrappers.js +++ b/lib/rules/no-new-wrappers.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `new` operators with the `String`, `Number`, and `Boolean` objects", + description: "Disallow `new` operators with the `String`, `Number`, and `Boolean` objects", recommended: false, url: "https://eslint.org/docs/rules/no-new-wrappers" }, diff --git a/lib/rules/no-new.js b/lib/rules/no-new.js index 5b0976534d6..c4345057588 100644 --- a/lib/rules/no-new.js +++ b/lib/rules/no-new.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `new` operators outside of assignments or comparisons", + description: "Disallow `new` operators outside of assignments or comparisons", recommended: false, url: "https://eslint.org/docs/rules/no-new" }, diff --git a/lib/rules/no-nonoctal-decimal-escape.js b/lib/rules/no-nonoctal-decimal-escape.js index 3edd269faeb..63e2264b33a 100644 --- a/lib/rules/no-nonoctal-decimal-escape.js +++ b/lib/rules/no-nonoctal-decimal-escape.js @@ -30,7 +30,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `\\8` and `\\9` escape sequences in string literals", + description: "Disallow `\\8` and `\\9` escape sequences in string literals", recommended: true, url: "https://eslint.org/docs/rules/no-nonoctal-decimal-escape" }, diff --git a/lib/rules/no-obj-calls.js b/lib/rules/no-obj-calls.js index 667ba69d803..86355d85d36 100644 --- a/lib/rules/no-obj-calls.js +++ b/lib/rules/no-obj-calls.js @@ -43,7 +43,7 @@ module.exports = { type: "problem", docs: { - description: "disallow calling global object properties as functions", + description: "Disallow calling global object properties as functions", recommended: true, url: "https://eslint.org/docs/rules/no-obj-calls" }, diff --git a/lib/rules/no-octal-escape.js b/lib/rules/no-octal-escape.js index 9ac56ab7bea..81a8a74cddb 100644 --- a/lib/rules/no-octal-escape.js +++ b/lib/rules/no-octal-escape.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow octal escape sequences in string literals", + description: "Disallow octal escape sequences in string literals", recommended: false, url: "https://eslint.org/docs/rules/no-octal-escape" }, diff --git a/lib/rules/no-octal.js b/lib/rules/no-octal.js index 9d05455cdac..eec56919f1e 100644 --- a/lib/rules/no-octal.js +++ b/lib/rules/no-octal.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow octal literals", + description: "Disallow octal literals", recommended: true, url: "https://eslint.org/docs/rules/no-octal" }, diff --git a/lib/rules/no-param-reassign.js b/lib/rules/no-param-reassign.js index 87a6b702382..f89435c8675 100644 --- a/lib/rules/no-param-reassign.js +++ b/lib/rules/no-param-reassign.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow reassigning `function` parameters", + description: "Disallow reassigning `function` parameters", recommended: false, url: "https://eslint.org/docs/rules/no-param-reassign" }, diff --git a/lib/rules/no-path-concat.js b/lib/rules/no-path-concat.js index 8d570a3778f..8502c511ed9 100644 --- a/lib/rules/no-path-concat.js +++ b/lib/rules/no-path-concat.js @@ -19,7 +19,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow string concatenation with `__dirname` and `__filename`", + description: "Disallow string concatenation with `__dirname` and `__filename`", recommended: false, url: "https://eslint.org/docs/rules/no-path-concat" }, diff --git a/lib/rules/no-plusplus.js b/lib/rules/no-plusplus.js index 2565da43231..cda6b05bfa8 100644 --- a/lib/rules/no-plusplus.js +++ b/lib/rules/no-plusplus.js @@ -51,7 +51,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the unary operators `++` and `--`", + description: "Disallow the unary operators `++` and `--`", recommended: false, url: "https://eslint.org/docs/rules/no-plusplus" }, diff --git a/lib/rules/no-process-env.js b/lib/rules/no-process-env.js index f7c2c718fd0..5db7c94b13b 100644 --- a/lib/rules/no-process-env.js +++ b/lib/rules/no-process-env.js @@ -19,7 +19,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of `process.env`", + description: "Disallow the use of `process.env`", recommended: false, url: "https://eslint.org/docs/rules/no-process-env" }, diff --git a/lib/rules/no-process-exit.js b/lib/rules/no-process-exit.js index 251044b31c9..ca3ecfe6f5f 100644 --- a/lib/rules/no-process-exit.js +++ b/lib/rules/no-process-exit.js @@ -19,7 +19,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of `process.exit()`", + description: "Disallow the use of `process.exit()`", recommended: false, url: "https://eslint.org/docs/rules/no-process-exit" }, diff --git a/lib/rules/no-promise-executor-return.js b/lib/rules/no-promise-executor-return.js index e40d4bcb3f5..caa195ffa07 100644 --- a/lib/rules/no-promise-executor-return.js +++ b/lib/rules/no-promise-executor-return.js @@ -69,7 +69,7 @@ module.exports = { type: "problem", docs: { - description: "disallow returning values from Promise executor functions", + description: "Disallow returning values from Promise executor functions", recommended: false, url: "https://eslint.org/docs/rules/no-promise-executor-return" }, diff --git a/lib/rules/no-proto.js b/lib/rules/no-proto.js index e6659e59c6b..771d206a88d 100644 --- a/lib/rules/no-proto.js +++ b/lib/rules/no-proto.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of the `__proto__` property", + description: "Disallow the use of the `__proto__` property", recommended: false, url: "https://eslint.org/docs/rules/no-proto" }, diff --git a/lib/rules/no-prototype-builtins.js b/lib/rules/no-prototype-builtins.js index dc12669c87d..ea2763396d0 100644 --- a/lib/rules/no-prototype-builtins.js +++ b/lib/rules/no-prototype-builtins.js @@ -20,7 +20,7 @@ module.exports = { type: "problem", docs: { - description: "disallow calling some `Object.prototype` methods directly on objects", + description: "Disallow calling some `Object.prototype` methods directly on objects", recommended: true, url: "https://eslint.org/docs/rules/no-prototype-builtins" }, diff --git a/lib/rules/no-redeclare.js b/lib/rules/no-redeclare.js index cc71a612349..59749cb6643 100644 --- a/lib/rules/no-redeclare.js +++ b/lib/rules/no-redeclare.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow variable redeclaration", + description: "Disallow variable redeclaration", recommended: true, url: "https://eslint.org/docs/rules/no-redeclare" }, diff --git a/lib/rules/no-regex-spaces.js b/lib/rules/no-regex-spaces.js index 400c72b5027..6d74aabe263 100644 --- a/lib/rules/no-regex-spaces.js +++ b/lib/rules/no-regex-spaces.js @@ -39,7 +39,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow multiple spaces in regular expressions", + description: "Disallow multiple spaces in regular expressions", recommended: true, url: "https://eslint.org/docs/rules/no-regex-spaces" }, diff --git a/lib/rules/no-restricted-exports.js b/lib/rules/no-restricted-exports.js index 5166cecaef2..d99e8928209 100644 --- a/lib/rules/no-restricted-exports.js +++ b/lib/rules/no-restricted-exports.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow specified names in exports", + description: "Disallow specified names in exports", recommended: false, url: "https://eslint.org/docs/rules/no-restricted-exports" }, diff --git a/lib/rules/no-restricted-globals.js b/lib/rules/no-restricted-globals.js index 09d347890ca..b666238382d 100644 --- a/lib/rules/no-restricted-globals.js +++ b/lib/rules/no-restricted-globals.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow specified global variables", + description: "Disallow specified global variables", recommended: false, url: "https://eslint.org/docs/rules/no-restricted-globals" }, diff --git a/lib/rules/no-restricted-imports.js b/lib/rules/no-restricted-imports.js index 3bb45d715ff..60a25e5d1e1 100644 --- a/lib/rules/no-restricted-imports.js +++ b/lib/rules/no-restricted-imports.js @@ -88,7 +88,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow specified modules when loaded by `import`", + description: "Disallow specified modules when loaded by `import`", recommended: false, url: "https://eslint.org/docs/rules/no-restricted-imports" }, diff --git a/lib/rules/no-restricted-modules.js b/lib/rules/no-restricted-modules.js index d92aa7a86bc..c37694f9046 100644 --- a/lib/rules/no-restricted-modules.js +++ b/lib/rules/no-restricted-modules.js @@ -49,7 +49,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow specified modules when loaded by `require`", + description: "Disallow specified modules when loaded by `require`", recommended: false, url: "https://eslint.org/docs/rules/no-restricted-modules" }, diff --git a/lib/rules/no-restricted-properties.js b/lib/rules/no-restricted-properties.js index 1e8c7a89aed..7c03498563f 100644 --- a/lib/rules/no-restricted-properties.js +++ b/lib/rules/no-restricted-properties.js @@ -17,7 +17,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow certain properties on certain objects", + description: "Disallow certain properties on certain objects", recommended: false, url: "https://eslint.org/docs/rules/no-restricted-properties" }, diff --git a/lib/rules/no-restricted-syntax.js b/lib/rules/no-restricted-syntax.js index 713d1157c4d..76369cfd539 100644 --- a/lib/rules/no-restricted-syntax.js +++ b/lib/rules/no-restricted-syntax.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow specified syntax", + description: "Disallow specified syntax", recommended: false, url: "https://eslint.org/docs/rules/no-restricted-syntax" }, diff --git a/lib/rules/no-return-assign.js b/lib/rules/no-return-assign.js index 4fd7a3ddba5..ccaf2c1c158 100644 --- a/lib/rules/no-return-assign.js +++ b/lib/rules/no-return-assign.js @@ -26,7 +26,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow assignment operators in `return` statements", + description: "Disallow assignment operators in `return` statements", recommended: false, url: "https://eslint.org/docs/rules/no-return-assign" }, diff --git a/lib/rules/no-return-await.js b/lib/rules/no-return-await.js index 191bf42dcf9..3007c8c877d 100644 --- a/lib/rules/no-return-await.js +++ b/lib/rules/no-return-await.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary `return await`", + description: "Disallow unnecessary `return await`", recommended: false, diff --git a/lib/rules/no-script-url.js b/lib/rules/no-script-url.js index 0eef2541840..41479006ee9 100644 --- a/lib/rules/no-script-url.js +++ b/lib/rules/no-script-url.js @@ -18,7 +18,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `javascript:` urls", + description: "Disallow `javascript:` urls", recommended: false, url: "https://eslint.org/docs/rules/no-script-url" }, diff --git a/lib/rules/no-self-assign.js b/lib/rules/no-self-assign.js index 060cc8e353e..348ee8dfc5f 100644 --- a/lib/rules/no-self-assign.js +++ b/lib/rules/no-self-assign.js @@ -130,7 +130,7 @@ module.exports = { type: "problem", docs: { - description: "disallow assignments where both sides are exactly the same", + description: "Disallow assignments where both sides are exactly the same", recommended: true, url: "https://eslint.org/docs/rules/no-self-assign" }, diff --git a/lib/rules/no-self-compare.js b/lib/rules/no-self-compare.js index c3512895e13..dab0db4b917 100644 --- a/lib/rules/no-self-compare.js +++ b/lib/rules/no-self-compare.js @@ -16,7 +16,7 @@ module.exports = { type: "problem", docs: { - description: "disallow comparisons where both sides are exactly the same", + description: "Disallow comparisons where both sides are exactly the same", recommended: false, url: "https://eslint.org/docs/rules/no-self-compare" }, diff --git a/lib/rules/no-sequences.js b/lib/rules/no-sequences.js index 376aec37988..2c0c27c3fea 100644 --- a/lib/rules/no-sequences.js +++ b/lib/rules/no-sequences.js @@ -29,7 +29,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow comma operators", + description: "Disallow comma operators", recommended: false, url: "https://eslint.org/docs/rules/no-sequences" }, diff --git a/lib/rules/no-setter-return.js b/lib/rules/no-setter-return.js index 7204e5c0c4d..25e8f1428b2 100644 --- a/lib/rules/no-setter-return.js +++ b/lib/rules/no-setter-return.js @@ -142,7 +142,7 @@ module.exports = { type: "problem", docs: { - description: "disallow returning values from setters", + description: "Disallow returning values from setters", recommended: true, url: "https://eslint.org/docs/rules/no-setter-return" }, diff --git a/lib/rules/no-shadow-restricted-names.js b/lib/rules/no-shadow-restricted-names.js index 52620e58d1c..a7d6d00f164 100644 --- a/lib/rules/no-shadow-restricted-names.js +++ b/lib/rules/no-shadow-restricted-names.js @@ -27,7 +27,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow identifiers from shadowing restricted names", + description: "Disallow identifiers from shadowing restricted names", recommended: true, url: "https://eslint.org/docs/rules/no-shadow-restricted-names" }, diff --git a/lib/rules/no-shadow.js b/lib/rules/no-shadow.js index b4ef334efdd..3af9354ebd7 100644 --- a/lib/rules/no-shadow.js +++ b/lib/rules/no-shadow.js @@ -30,7 +30,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow variable declarations from shadowing variables declared in the outer scope", + description: "Disallow variable declarations from shadowing variables declared in the outer scope", recommended: false, url: "https://eslint.org/docs/rules/no-shadow" }, diff --git a/lib/rules/no-spaced-func.js b/lib/rules/no-spaced-func.js index 1d2994333e1..97e2da06b0f 100644 --- a/lib/rules/no-spaced-func.js +++ b/lib/rules/no-spaced-func.js @@ -16,7 +16,7 @@ module.exports = { type: "layout", docs: { - description: "disallow spacing between function identifiers and their applications (deprecated)", + description: "Disallow spacing between function identifiers and their applications (deprecated)", recommended: false, url: "https://eslint.org/docs/rules/no-spaced-func" }, diff --git a/lib/rules/no-sparse-arrays.js b/lib/rules/no-sparse-arrays.js index ff5c2cf9978..0e95fe4af7b 100644 --- a/lib/rules/no-sparse-arrays.js +++ b/lib/rules/no-sparse-arrays.js @@ -14,7 +14,7 @@ module.exports = { type: "problem", docs: { - description: "disallow sparse arrays", + description: "Disallow sparse arrays", recommended: true, url: "https://eslint.org/docs/rules/no-sparse-arrays" }, diff --git a/lib/rules/no-sync.js b/lib/rules/no-sync.js index 3536d9f2a39..71360c6bd32 100644 --- a/lib/rules/no-sync.js +++ b/lib/rules/no-sync.js @@ -20,7 +20,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow synchronous methods", + description: "Disallow synchronous methods", recommended: false, url: "https://eslint.org/docs/rules/no-sync" }, diff --git a/lib/rules/no-tabs.js b/lib/rules/no-tabs.js index 9758b850be1..1b4834e09a7 100644 --- a/lib/rules/no-tabs.js +++ b/lib/rules/no-tabs.js @@ -22,7 +22,7 @@ module.exports = { type: "layout", docs: { - description: "disallow all tabs", + description: "Disallow all tabs", recommended: false, url: "https://eslint.org/docs/rules/no-tabs" }, diff --git a/lib/rules/no-template-curly-in-string.js b/lib/rules/no-template-curly-in-string.js index 1901460f3d2..4f4e9ee17e9 100644 --- a/lib/rules/no-template-curly-in-string.js +++ b/lib/rules/no-template-curly-in-string.js @@ -14,7 +14,7 @@ module.exports = { type: "problem", docs: { - description: "disallow template literal placeholder syntax in regular strings", + description: "Disallow template literal placeholder syntax in regular strings", recommended: false, url: "https://eslint.org/docs/rules/no-template-curly-in-string" }, diff --git a/lib/rules/no-ternary.js b/lib/rules/no-ternary.js index b0dc626832b..a185808a69a 100644 --- a/lib/rules/no-ternary.js +++ b/lib/rules/no-ternary.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow ternary operators", + description: "Disallow ternary operators", recommended: false, url: "https://eslint.org/docs/rules/no-ternary" }, diff --git a/lib/rules/no-this-before-super.js b/lib/rules/no-this-before-super.js index 929eded2443..b4e48e86264 100644 --- a/lib/rules/no-this-before-super.js +++ b/lib/rules/no-this-before-super.js @@ -40,7 +40,7 @@ module.exports = { type: "problem", docs: { - description: "disallow `this`/`super` before calling `super()` in constructors", + description: "Disallow `this`/`super` before calling `super()` in constructors", recommended: true, url: "https://eslint.org/docs/rules/no-this-before-super" }, diff --git a/lib/rules/no-throw-literal.js b/lib/rules/no-throw-literal.js index c670ed9e5e1..3656c83a3ff 100644 --- a/lib/rules/no-throw-literal.js +++ b/lib/rules/no-throw-literal.js @@ -17,7 +17,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow throwing literals as exceptions", + description: "Disallow throwing literals as exceptions", recommended: false, url: "https://eslint.org/docs/rules/no-throw-literal" }, diff --git a/lib/rules/no-trailing-spaces.js b/lib/rules/no-trailing-spaces.js index 9e720ad32e8..a02a880e1d6 100644 --- a/lib/rules/no-trailing-spaces.js +++ b/lib/rules/no-trailing-spaces.js @@ -20,7 +20,7 @@ module.exports = { type: "layout", docs: { - description: "disallow trailing whitespace at the end of lines", + description: "Disallow trailing whitespace at the end of lines", recommended: false, url: "https://eslint.org/docs/rules/no-trailing-spaces" }, diff --git a/lib/rules/no-undef-init.js b/lib/rules/no-undef-init.js index 2c2204cf0fe..2cb1c3f3710 100644 --- a/lib/rules/no-undef-init.js +++ b/lib/rules/no-undef-init.js @@ -17,7 +17,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow initializing variables to `undefined`", + description: "Disallow initializing variables to `undefined`", recommended: false, url: "https://eslint.org/docs/rules/no-undef-init" }, diff --git a/lib/rules/no-undef.js b/lib/rules/no-undef.js index f65903245c8..e920ce6c288 100644 --- a/lib/rules/no-undef.js +++ b/lib/rules/no-undef.js @@ -29,7 +29,7 @@ module.exports = { type: "problem", docs: { - description: "disallow the use of undeclared variables unless mentioned in `/*global */` comments", + description: "Disallow the use of undeclared variables unless mentioned in `/*global */` comments", recommended: true, url: "https://eslint.org/docs/rules/no-undef" }, diff --git a/lib/rules/no-undefined.js b/lib/rules/no-undefined.js index de396d889c0..e006320b522 100644 --- a/lib/rules/no-undefined.js +++ b/lib/rules/no-undefined.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of `undefined` as an identifier", + description: "Disallow the use of `undefined` as an identifier", recommended: false, url: "https://eslint.org/docs/rules/no-undefined" }, diff --git a/lib/rules/no-underscore-dangle.js b/lib/rules/no-underscore-dangle.js index a3a9f650032..eb3e404a66d 100644 --- a/lib/rules/no-underscore-dangle.js +++ b/lib/rules/no-underscore-dangle.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow dangling underscores in identifiers", + description: "Disallow dangling underscores in identifiers", recommended: false, url: "https://eslint.org/docs/rules/no-underscore-dangle" }, diff --git a/lib/rules/no-unexpected-multiline.js b/lib/rules/no-unexpected-multiline.js index 60d8f3164cd..2ca6731bc67 100644 --- a/lib/rules/no-unexpected-multiline.js +++ b/lib/rules/no-unexpected-multiline.js @@ -20,7 +20,7 @@ module.exports = { type: "problem", docs: { - description: "disallow confusing multiline expressions", + description: "Disallow confusing multiline expressions", recommended: true, url: "https://eslint.org/docs/rules/no-unexpected-multiline" }, diff --git a/lib/rules/no-unmodified-loop-condition.js b/lib/rules/no-unmodified-loop-condition.js index 5b8da26f2d2..12f61e98e6a 100644 --- a/lib/rules/no-unmodified-loop-condition.js +++ b/lib/rules/no-unmodified-loop-condition.js @@ -162,7 +162,7 @@ module.exports = { type: "problem", docs: { - description: "disallow unmodified loop conditions", + description: "Disallow unmodified loop conditions", recommended: false, url: "https://eslint.org/docs/rules/no-unmodified-loop-condition" }, diff --git a/lib/rules/no-unneeded-ternary.js b/lib/rules/no-unneeded-ternary.js index e00d5270a2a..c193282fa70 100644 --- a/lib/rules/no-unneeded-ternary.js +++ b/lib/rules/no-unneeded-ternary.js @@ -29,7 +29,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow ternary operators when simpler alternatives exist", + description: "Disallow ternary operators when simpler alternatives exist", recommended: false, url: "https://eslint.org/docs/rules/no-unneeded-ternary" }, diff --git a/lib/rules/no-unreachable-loop.js b/lib/rules/no-unreachable-loop.js index f100263308f..c42c922e0c4 100644 --- a/lib/rules/no-unreachable-loop.js +++ b/lib/rules/no-unreachable-loop.js @@ -59,7 +59,7 @@ module.exports = { type: "problem", docs: { - description: "disallow loops with a body that allows only one iteration", + description: "Disallow loops with a body that allows only one iteration", recommended: false, url: "https://eslint.org/docs/rules/no-unreachable-loop" }, diff --git a/lib/rules/no-unreachable.js b/lib/rules/no-unreachable.js index 4dda51f11b9..dea86815aac 100644 --- a/lib/rules/no-unreachable.js +++ b/lib/rules/no-unreachable.js @@ -111,7 +111,7 @@ module.exports = { type: "problem", docs: { - description: "disallow unreachable code after `return`, `throw`, `continue`, and `break` statements", + description: "Disallow unreachable code after `return`, `throw`, `continue`, and `break` statements", recommended: true, url: "https://eslint.org/docs/rules/no-unreachable" }, diff --git a/lib/rules/no-unsafe-finally.js b/lib/rules/no-unsafe-finally.js index 26c05eab8b0..80adb0fea46 100644 --- a/lib/rules/no-unsafe-finally.js +++ b/lib/rules/no-unsafe-finally.js @@ -24,7 +24,7 @@ module.exports = { type: "problem", docs: { - description: "disallow control flow statements in `finally` blocks", + description: "Disallow control flow statements in `finally` blocks", recommended: true, url: "https://eslint.org/docs/rules/no-unsafe-finally" }, diff --git a/lib/rules/no-unsafe-negation.js b/lib/rules/no-unsafe-negation.js index 057b1742acc..5dd150f8788 100644 --- a/lib/rules/no-unsafe-negation.js +++ b/lib/rules/no-unsafe-negation.js @@ -52,7 +52,7 @@ module.exports = { type: "problem", docs: { - description: "disallow negating the left operand of relational operators", + description: "Disallow negating the left operand of relational operators", recommended: true, url: "https://eslint.org/docs/rules/no-unsafe-negation" }, diff --git a/lib/rules/no-unsafe-optional-chaining.js b/lib/rules/no-unsafe-optional-chaining.js index 8556ccbd79d..99139078198 100644 --- a/lib/rules/no-unsafe-optional-chaining.js +++ b/lib/rules/no-unsafe-optional-chaining.js @@ -24,7 +24,7 @@ module.exports = { type: "problem", docs: { - description: "disallow use of optional chaining in contexts where the `undefined` value is not allowed", + description: "Disallow use of optional chaining in contexts where the `undefined` value is not allowed", recommended: true, url: "https://eslint.org/docs/rules/no-unsafe-optional-chaining" }, diff --git a/lib/rules/no-unused-expressions.js b/lib/rules/no-unused-expressions.js index e90099d6201..d34d5844d97 100644 --- a/lib/rules/no-unused-expressions.js +++ b/lib/rules/no-unused-expressions.js @@ -30,7 +30,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unused expressions", + description: "Disallow unused expressions", recommended: false, url: "https://eslint.org/docs/rules/no-unused-expressions" }, diff --git a/lib/rules/no-unused-labels.js b/lib/rules/no-unused-labels.js index f309dd12b12..305226a4df2 100644 --- a/lib/rules/no-unused-labels.js +++ b/lib/rules/no-unused-labels.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unused labels", + description: "Disallow unused labels", recommended: true, url: "https://eslint.org/docs/rules/no-unused-labels" }, diff --git a/lib/rules/no-unused-private-class-members.js b/lib/rules/no-unused-private-class-members.js index 754c36002eb..e62a9ed5968 100644 --- a/lib/rules/no-unused-private-class-members.js +++ b/lib/rules/no-unused-private-class-members.js @@ -15,7 +15,7 @@ module.exports = { type: "problem", docs: { - description: "disallow unused private class members", + description: "Disallow unused private class members", recommended: false, url: "https://eslint.org/docs/rules/no-unused-private-class-members" }, diff --git a/lib/rules/no-unused-vars.js b/lib/rules/no-unused-vars.js index 2114e6f6aac..778889a7676 100644 --- a/lib/rules/no-unused-vars.js +++ b/lib/rules/no-unused-vars.js @@ -33,7 +33,7 @@ module.exports = { type: "problem", docs: { - description: "disallow unused variables", + description: "Disallow unused variables", recommended: true, url: "https://eslint.org/docs/rules/no-unused-vars" }, diff --git a/lib/rules/no-use-before-define.js b/lib/rules/no-use-before-define.js index 0dc4d76817b..592c083589c 100644 --- a/lib/rules/no-use-before-define.js +++ b/lib/rules/no-use-before-define.js @@ -226,7 +226,7 @@ module.exports = { type: "problem", docs: { - description: "disallow the use of variables before they are defined", + description: "Disallow the use of variables before they are defined", recommended: false, url: "https://eslint.org/docs/rules/no-use-before-define" }, diff --git a/lib/rules/no-useless-backreference.js b/lib/rules/no-useless-backreference.js index 1a09988b809..f23535bc359 100644 --- a/lib/rules/no-useless-backreference.js +++ b/lib/rules/no-useless-backreference.js @@ -64,7 +64,7 @@ module.exports = { type: "problem", docs: { - description: "disallow useless backreferences in regular expressions", + description: "Disallow useless backreferences in regular expressions", recommended: true, url: "https://eslint.org/docs/rules/no-useless-backreference" }, diff --git a/lib/rules/no-useless-call.js b/lib/rules/no-useless-call.js index 8c57cd5cc9a..2d3ae4e84ae 100644 --- a/lib/rules/no-useless-call.js +++ b/lib/rules/no-useless-call.js @@ -55,7 +55,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary calls to `.call()` and `.apply()`", + description: "Disallow unnecessary calls to `.call()` and `.apply()`", recommended: false, url: "https://eslint.org/docs/rules/no-useless-call" }, diff --git a/lib/rules/no-useless-catch.js b/lib/rules/no-useless-catch.js index 325a2e58117..36c356ecb42 100644 --- a/lib/rules/no-useless-catch.js +++ b/lib/rules/no-useless-catch.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary `catch` clauses", + description: "Disallow unnecessary `catch` clauses", recommended: true, url: "https://eslint.org/docs/rules/no-useless-catch" }, diff --git a/lib/rules/no-useless-computed-key.js b/lib/rules/no-useless-computed-key.js index 7ebbe09de26..e7a3dc1db6d 100644 --- a/lib/rules/no-useless-computed-key.js +++ b/lib/rules/no-useless-computed-key.js @@ -91,7 +91,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary computed property keys in objects and classes", + description: "Disallow unnecessary computed property keys in objects and classes", recommended: false, url: "https://eslint.org/docs/rules/no-useless-computed-key" }, diff --git a/lib/rules/no-useless-concat.js b/lib/rules/no-useless-concat.js index 36ca84f90cb..26c5206df36 100644 --- a/lib/rules/no-useless-concat.js +++ b/lib/rules/no-useless-concat.js @@ -70,7 +70,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary concatenation of literals or template literals", + description: "Disallow unnecessary concatenation of literals or template literals", recommended: false, url: "https://eslint.org/docs/rules/no-useless-concat" }, diff --git a/lib/rules/no-useless-constructor.js b/lib/rules/no-useless-constructor.js index 6512c8b1fef..38c3bc3a05c 100644 --- a/lib/rules/no-useless-constructor.js +++ b/lib/rules/no-useless-constructor.js @@ -138,7 +138,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary constructors", + description: "Disallow unnecessary constructors", recommended: false, url: "https://eslint.org/docs/rules/no-useless-constructor" }, diff --git a/lib/rules/no-useless-escape.js b/lib/rules/no-useless-escape.js index 123bc5b8a01..2046a148a17 100644 --- a/lib/rules/no-useless-escape.js +++ b/lib/rules/no-useless-escape.js @@ -84,7 +84,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow unnecessary escape characters", + description: "Disallow unnecessary escape characters", recommended: true, url: "https://eslint.org/docs/rules/no-useless-escape" }, diff --git a/lib/rules/no-useless-rename.js b/lib/rules/no-useless-rename.js index 2489f57bcf5..908605f74cb 100644 --- a/lib/rules/no-useless-rename.js +++ b/lib/rules/no-useless-rename.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow renaming import, export, and destructured assignments to the same name", + description: "Disallow renaming import, export, and destructured assignments to the same name", recommended: false, url: "https://eslint.org/docs/rules/no-useless-rename" }, diff --git a/lib/rules/no-useless-return.js b/lib/rules/no-useless-return.js index 0baa6b2942d..be8d4dfd3a5 100644 --- a/lib/rules/no-useless-return.js +++ b/lib/rules/no-useless-return.js @@ -67,7 +67,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow redundant return statements", + description: "Disallow redundant return statements", recommended: false, url: "https://eslint.org/docs/rules/no-useless-return" }, diff --git a/lib/rules/no-var.js b/lib/rules/no-var.js index 83a1f62eb6f..2185610ea10 100644 --- a/lib/rules/no-var.js +++ b/lib/rules/no-var.js @@ -185,7 +185,7 @@ module.exports = { type: "suggestion", docs: { - description: "require `let` or `const` instead of `var`", + description: "Require `let` or `const` instead of `var`", recommended: false, url: "https://eslint.org/docs/rules/no-var" }, diff --git a/lib/rules/no-void.js b/lib/rules/no-void.js index 8631caf70cf..15c4730612d 100644 --- a/lib/rules/no-void.js +++ b/lib/rules/no-void.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `void` operators", + description: "Disallow `void` operators", recommended: false, url: "https://eslint.org/docs/rules/no-void" }, diff --git a/lib/rules/no-warning-comments.js b/lib/rules/no-warning-comments.js index 5f3ea21d7d0..40c89b19eb6 100644 --- a/lib/rules/no-warning-comments.js +++ b/lib/rules/no-warning-comments.js @@ -20,7 +20,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow specified warning terms in comments", + description: "Disallow specified warning terms in comments", recommended: false, url: "https://eslint.org/docs/rules/no-warning-comments" }, diff --git a/lib/rules/no-whitespace-before-property.js b/lib/rules/no-whitespace-before-property.js index 95e920f27ea..67323816f85 100644 --- a/lib/rules/no-whitespace-before-property.js +++ b/lib/rules/no-whitespace-before-property.js @@ -20,7 +20,7 @@ module.exports = { type: "layout", docs: { - description: "disallow whitespace before properties", + description: "Disallow whitespace before properties", recommended: false, url: "https://eslint.org/docs/rules/no-whitespace-before-property" }, diff --git a/lib/rules/no-with.js b/lib/rules/no-with.js index fc93f199f87..33de68d9c05 100644 --- a/lib/rules/no-with.js +++ b/lib/rules/no-with.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `with` statements", + description: "Disallow `with` statements", recommended: true, url: "https://eslint.org/docs/rules/no-with" }, diff --git a/lib/rules/nonblock-statement-body-position.js b/lib/rules/nonblock-statement-body-position.js index c177cf34cee..cefecf302a6 100644 --- a/lib/rules/nonblock-statement-body-position.js +++ b/lib/rules/nonblock-statement-body-position.js @@ -16,7 +16,7 @@ module.exports = { type: "layout", docs: { - description: "enforce the location of single-line statements", + description: "Enforce the location of single-line statements", recommended: false, url: "https://eslint.org/docs/rules/nonblock-statement-body-position" }, diff --git a/lib/rules/object-curly-newline.js b/lib/rules/object-curly-newline.js index e052cd86493..2f8004918a9 100644 --- a/lib/rules/object-curly-newline.js +++ b/lib/rules/object-curly-newline.js @@ -150,7 +150,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent line breaks after opening and before closing braces", + description: "Enforce consistent line breaks after opening and before closing braces", recommended: false, url: "https://eslint.org/docs/rules/object-curly-newline" }, diff --git a/lib/rules/object-curly-spacing.js b/lib/rules/object-curly-spacing.js index 9122da3ef3d..d6a8e5956ae 100644 --- a/lib/rules/object-curly-spacing.js +++ b/lib/rules/object-curly-spacing.js @@ -16,7 +16,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing inside braces", + description: "Enforce consistent spacing inside braces", recommended: false, url: "https://eslint.org/docs/rules/object-curly-spacing" }, diff --git a/lib/rules/object-property-newline.js b/lib/rules/object-property-newline.js index dac084c3f65..bc079a16f45 100644 --- a/lib/rules/object-property-newline.js +++ b/lib/rules/object-property-newline.js @@ -15,7 +15,7 @@ module.exports = { type: "layout", docs: { - description: "enforce placing object properties on separate lines", + description: "Enforce placing object properties on separate lines", recommended: false, url: "https://eslint.org/docs/rules/object-property-newline" }, diff --git a/lib/rules/object-shorthand.js b/lib/rules/object-shorthand.js index aa03450d071..8cd3978ca35 100644 --- a/lib/rules/object-shorthand.js +++ b/lib/rules/object-shorthand.js @@ -28,7 +28,7 @@ module.exports = { type: "suggestion", docs: { - description: "require or disallow method and property shorthand syntax for object literals", + description: "Require or disallow method and property shorthand syntax for object literals", recommended: false, url: "https://eslint.org/docs/rules/object-shorthand" }, diff --git a/lib/rules/one-var-declaration-per-line.js b/lib/rules/one-var-declaration-per-line.js index 440146b92c1..65be0929e71 100644 --- a/lib/rules/one-var-declaration-per-line.js +++ b/lib/rules/one-var-declaration-per-line.js @@ -14,7 +14,7 @@ module.exports = { type: "suggestion", docs: { - description: "require or disallow newlines around variable declarations", + description: "Require or disallow newlines around variable declarations", recommended: false, url: "https://eslint.org/docs/rules/one-var-declaration-per-line" }, diff --git a/lib/rules/one-var.js b/lib/rules/one-var.js index 1818c02e6e1..a8e2a1de05a 100644 --- a/lib/rules/one-var.js +++ b/lib/rules/one-var.js @@ -34,7 +34,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce variables to be declared either together or separately in functions", + description: "Enforce variables to be declared either together or separately in functions", recommended: false, url: "https://eslint.org/docs/rules/one-var" }, diff --git a/lib/rules/operator-assignment.js b/lib/rules/operator-assignment.js index 8b9fb5bd73b..ed9cb963bf2 100644 --- a/lib/rules/operator-assignment.js +++ b/lib/rules/operator-assignment.js @@ -63,7 +63,7 @@ module.exports = { type: "suggestion", docs: { - description: "require or disallow assignment operator shorthand where possible", + description: "Require or disallow assignment operator shorthand where possible", recommended: false, url: "https://eslint.org/docs/rules/operator-assignment" }, diff --git a/lib/rules/operator-linebreak.js b/lib/rules/operator-linebreak.js index a04f85bdea9..03b603e7584 100644 --- a/lib/rules/operator-linebreak.js +++ b/lib/rules/operator-linebreak.js @@ -21,7 +21,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent linebreak style for operators", + description: "Enforce consistent linebreak style for operators", recommended: false, url: "https://eslint.org/docs/rules/operator-linebreak" }, diff --git a/lib/rules/padded-blocks.js b/lib/rules/padded-blocks.js index 336adac9a02..5faf4343874 100644 --- a/lib/rules/padded-blocks.js +++ b/lib/rules/padded-blocks.js @@ -21,7 +21,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow padding within blocks", + description: "Require or disallow padding within blocks", recommended: false, url: "https://eslint.org/docs/rules/padded-blocks" }, diff --git a/lib/rules/padding-line-between-statements.js b/lib/rules/padding-line-between-statements.js index 7b442bff64a..9d730bffcd9 100644 --- a/lib/rules/padding-line-between-statements.js +++ b/lib/rules/padding-line-between-statements.js @@ -431,7 +431,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow padding lines between statements", + description: "Require or disallow padding lines between statements", recommended: false, url: "https://eslint.org/docs/rules/padding-line-between-statements" }, diff --git a/lib/rules/prefer-arrow-callback.js b/lib/rules/prefer-arrow-callback.js index 55a098a6097..9667139a88d 100644 --- a/lib/rules/prefer-arrow-callback.js +++ b/lib/rules/prefer-arrow-callback.js @@ -151,7 +151,7 @@ module.exports = { type: "suggestion", docs: { - description: "require using arrow functions for callbacks", + description: "Require using arrow functions for callbacks", recommended: false, url: "https://eslint.org/docs/rules/prefer-arrow-callback" }, diff --git a/lib/rules/prefer-const.js b/lib/rules/prefer-const.js index cf07d6ce714..08f4492aaea 100644 --- a/lib/rules/prefer-const.js +++ b/lib/rules/prefer-const.js @@ -332,7 +332,7 @@ module.exports = { type: "suggestion", docs: { - description: "require `const` declarations for variables that are never reassigned after declared", + description: "Require `const` declarations for variables that are never reassigned after declared", recommended: false, url: "https://eslint.org/docs/rules/prefer-const" }, diff --git a/lib/rules/prefer-destructuring.js b/lib/rules/prefer-destructuring.js index 1f68313d6b1..fdf46f65f59 100644 --- a/lib/rules/prefer-destructuring.js +++ b/lib/rules/prefer-destructuring.js @@ -26,7 +26,7 @@ module.exports = { type: "suggestion", docs: { - description: "require destructuring from arrays and/or objects", + description: "Require destructuring from arrays and/or objects", recommended: false, url: "https://eslint.org/docs/rules/prefer-destructuring" }, diff --git a/lib/rules/prefer-exponentiation-operator.js b/lib/rules/prefer-exponentiation-operator.js index a291e8dec15..fec5319723e 100644 --- a/lib/rules/prefer-exponentiation-operator.js +++ b/lib/rules/prefer-exponentiation-operator.js @@ -90,7 +90,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow the use of `Math.pow` in favor of the `**` operator", + description: "Disallow the use of `Math.pow` in favor of the `**` operator", recommended: false, url: "https://eslint.org/docs/rules/prefer-exponentiation-operator" }, diff --git a/lib/rules/prefer-named-capture-group.js b/lib/rules/prefer-named-capture-group.js index cff2d8f45d2..1a13ffa8582 100644 --- a/lib/rules/prefer-named-capture-group.js +++ b/lib/rules/prefer-named-capture-group.js @@ -33,7 +33,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce using named capture group in regular expression", + description: "Enforce using named capture group in regular expression", recommended: false, url: "https://eslint.org/docs/rules/prefer-named-capture-group" }, diff --git a/lib/rules/prefer-numeric-literals.js b/lib/rules/prefer-numeric-literals.js index 53a51536896..5f70158126c 100644 --- a/lib/rules/prefer-numeric-literals.js +++ b/lib/rules/prefer-numeric-literals.js @@ -45,7 +45,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow `parseInt()` and `Number.parseInt()` in favor of binary, octal, and hexadecimal literals", + description: "Disallow `parseInt()` and `Number.parseInt()` in favor of binary, octal, and hexadecimal literals", recommended: false, url: "https://eslint.org/docs/rules/prefer-numeric-literals" }, diff --git a/lib/rules/prefer-object-has-own.js b/lib/rules/prefer-object-has-own.js index 19abdb31565..023d0a64f4c 100644 --- a/lib/rules/prefer-object-has-own.js +++ b/lib/rules/prefer-object-has-own.js @@ -50,7 +50,7 @@ module.exports = { type: "suggestion", docs: { description: - "disallow use of `Object.prototype.hasOwnProperty.call()` and prefer use of `Object.hasOwn()`", + "Disallow use of `Object.prototype.hasOwnProperty.call()` and prefer use of `Object.hasOwn()`", recommended: false, url: "https://eslint.org/docs/rules/prefer-object-has-own" }, diff --git a/lib/rules/prefer-object-spread.js b/lib/rules/prefer-object-spread.js index b63474ef2bd..08192001a2b 100644 --- a/lib/rules/prefer-object-spread.js +++ b/lib/rules/prefer-object-spread.js @@ -247,7 +247,7 @@ module.exports = { docs: { description: - "disallow using Object.assign with an object literal as the first argument and prefer the use of object spread instead.", + "Disallow using Object.assign with an object literal as the first argument and prefer the use of object spread instead.", recommended: false, url: "https://eslint.org/docs/rules/prefer-object-spread" }, diff --git a/lib/rules/prefer-promise-reject-errors.js b/lib/rules/prefer-promise-reject-errors.js index 60e72f45101..bd7bdcbf5b7 100644 --- a/lib/rules/prefer-promise-reject-errors.js +++ b/lib/rules/prefer-promise-reject-errors.js @@ -16,7 +16,7 @@ module.exports = { type: "suggestion", docs: { - description: "require using Error objects as Promise rejection reasons", + description: "Require using Error objects as Promise rejection reasons", recommended: false, url: "https://eslint.org/docs/rules/prefer-promise-reject-errors" }, diff --git a/lib/rules/prefer-reflect.js b/lib/rules/prefer-reflect.js index 377268900b4..68ffa88b352 100644 --- a/lib/rules/prefer-reflect.js +++ b/lib/rules/prefer-reflect.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "require `Reflect` methods where applicable", + description: "Require `Reflect` methods where applicable", recommended: false, url: "https://eslint.org/docs/rules/prefer-reflect" }, diff --git a/lib/rules/prefer-regex-literals.js b/lib/rules/prefer-regex-literals.js index aa7258997c5..f30eddbf8c5 100644 --- a/lib/rules/prefer-regex-literals.js +++ b/lib/rules/prefer-regex-literals.js @@ -123,7 +123,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow use of the `RegExp` constructor in favor of regular expression literals", + description: "Disallow use of the `RegExp` constructor in favor of regular expression literals", recommended: false, url: "https://eslint.org/docs/rules/prefer-regex-literals" }, diff --git a/lib/rules/prefer-rest-params.js b/lib/rules/prefer-rest-params.js index 371a28964f2..df1be55879a 100644 --- a/lib/rules/prefer-rest-params.js +++ b/lib/rules/prefer-rest-params.js @@ -65,7 +65,7 @@ module.exports = { type: "suggestion", docs: { - description: "require rest parameters instead of `arguments`", + description: "Require rest parameters instead of `arguments`", recommended: false, url: "https://eslint.org/docs/rules/prefer-rest-params" }, diff --git a/lib/rules/prefer-spread.js b/lib/rules/prefer-spread.js index c5f9e1e6cbf..c8909fc0612 100644 --- a/lib/rules/prefer-spread.js +++ b/lib/rules/prefer-spread.js @@ -49,7 +49,7 @@ module.exports = { type: "suggestion", docs: { - description: "require spread operators instead of `.apply()`", + description: "Require spread operators instead of `.apply()`", recommended: false, url: "https://eslint.org/docs/rules/prefer-spread" }, diff --git a/lib/rules/prefer-template.js b/lib/rules/prefer-template.js index e61eac1d65d..167c187db6f 100644 --- a/lib/rules/prefer-template.js +++ b/lib/rules/prefer-template.js @@ -128,7 +128,7 @@ module.exports = { type: "suggestion", docs: { - description: "require template literals instead of string concatenation", + description: "Require template literals instead of string concatenation", recommended: false, url: "https://eslint.org/docs/rules/prefer-template" }, diff --git a/lib/rules/quote-props.js b/lib/rules/quote-props.js index 0b66d761c47..db9423978bb 100644 --- a/lib/rules/quote-props.js +++ b/lib/rules/quote-props.js @@ -22,7 +22,7 @@ module.exports = { type: "suggestion", docs: { - description: "require quotes around object literal property names", + description: "Require quotes around object literal property names", recommended: false, url: "https://eslint.org/docs/rules/quote-props" }, diff --git a/lib/rules/quotes.js b/lib/rules/quotes.js index f1d30a044bc..ab7b38b90bf 100644 --- a/lib/rules/quotes.js +++ b/lib/rules/quotes.js @@ -80,7 +80,7 @@ module.exports = { type: "layout", docs: { - description: "enforce the consistent use of either backticks, double, or single quotes", + description: "Enforce the consistent use of either backticks, double, or single quotes", recommended: false, url: "https://eslint.org/docs/rules/quotes" }, diff --git a/lib/rules/radix.js b/lib/rules/radix.js index f83c762c11d..0618d9844ad 100644 --- a/lib/rules/radix.js +++ b/lib/rules/radix.js @@ -80,7 +80,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce the consistent use of the radix argument when using `parseInt()`", + description: "Enforce the consistent use of the radix argument when using `parseInt()`", recommended: false, url: "https://eslint.org/docs/rules/radix" }, diff --git a/lib/rules/require-atomic-updates.js b/lib/rules/require-atomic-updates.js index 4dbd48dfc58..7a5f822ab28 100644 --- a/lib/rules/require-atomic-updates.js +++ b/lib/rules/require-atomic-updates.js @@ -171,7 +171,7 @@ module.exports = { type: "problem", docs: { - description: "disallow assignments that can lead to race conditions due to usage of `await` or `yield`", + description: "Disallow assignments that can lead to race conditions due to usage of `await` or `yield`", recommended: false, url: "https://eslint.org/docs/rules/require-atomic-updates" }, diff --git a/lib/rules/require-await.js b/lib/rules/require-await.js index 1b17de0e197..1add2552e58 100644 --- a/lib/rules/require-await.js +++ b/lib/rules/require-await.js @@ -34,7 +34,7 @@ module.exports = { type: "suggestion", docs: { - description: "disallow async functions which have no `await` expression", + description: "Disallow async functions which have no `await` expression", recommended: false, url: "https://eslint.org/docs/rules/require-await" }, diff --git a/lib/rules/require-jsdoc.js b/lib/rules/require-jsdoc.js index 169b6f52413..755f6df5fee 100644 --- a/lib/rules/require-jsdoc.js +++ b/lib/rules/require-jsdoc.js @@ -11,7 +11,7 @@ module.exports = { type: "suggestion", docs: { - description: "require JSDoc comments", + description: "Require JSDoc comments", recommended: false, url: "https://eslint.org/docs/rules/require-jsdoc" }, diff --git a/lib/rules/require-unicode-regexp.js b/lib/rules/require-unicode-regexp.js index 577ae6cf827..4236af6db47 100644 --- a/lib/rules/require-unicode-regexp.js +++ b/lib/rules/require-unicode-regexp.js @@ -26,7 +26,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce the use of `u` flag on RegExp", + description: "Enforce the use of `u` flag on RegExp", recommended: false, url: "https://eslint.org/docs/rules/require-unicode-regexp" }, diff --git a/lib/rules/require-yield.js b/lib/rules/require-yield.js index aba06140672..ffb2229790d 100644 --- a/lib/rules/require-yield.js +++ b/lib/rules/require-yield.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "require generator functions to contain `yield`", + description: "Require generator functions to contain `yield`", recommended: true, url: "https://eslint.org/docs/rules/require-yield" }, diff --git a/lib/rules/rest-spread-spacing.js b/lib/rules/rest-spread-spacing.js index ace1ec52141..17f9aa0c3c5 100644 --- a/lib/rules/rest-spread-spacing.js +++ b/lib/rules/rest-spread-spacing.js @@ -15,7 +15,7 @@ module.exports = { type: "layout", docs: { - description: "enforce spacing between rest and spread operators and their expressions", + description: "Enforce spacing between rest and spread operators and their expressions", recommended: false, url: "https://eslint.org/docs/rules/rest-spread-spacing" }, diff --git a/lib/rules/semi-spacing.js b/lib/rules/semi-spacing.js index 4f0afbb11a3..875cb62443d 100644 --- a/lib/rules/semi-spacing.js +++ b/lib/rules/semi-spacing.js @@ -17,7 +17,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing before and after semicolons", + description: "Enforce consistent spacing before and after semicolons", recommended: false, url: "https://eslint.org/docs/rules/semi-spacing" }, diff --git a/lib/rules/semi-style.js b/lib/rules/semi-style.js index 7952a9adff1..424858b4ba1 100644 --- a/lib/rules/semi-style.js +++ b/lib/rules/semi-style.js @@ -73,7 +73,7 @@ module.exports = { type: "layout", docs: { - description: "enforce location of semicolons", + description: "Enforce location of semicolons", recommended: false, url: "https://eslint.org/docs/rules/semi-style" }, diff --git a/lib/rules/semi.js b/lib/rules/semi.js index 86ff8d74ee1..1e49273c2e9 100644 --- a/lib/rules/semi.js +++ b/lib/rules/semi.js @@ -21,7 +21,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow semicolons instead of ASI", + description: "Require or disallow semicolons instead of ASI", recommended: false, url: "https://eslint.org/docs/rules/semi" }, diff --git a/lib/rules/sort-imports.js b/lib/rules/sort-imports.js index 13cb63681cb..bfb0765baa5 100644 --- a/lib/rules/sort-imports.js +++ b/lib/rules/sort-imports.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce sorted import declarations within modules", + description: "Enforce sorted import declarations within modules", recommended: false, url: "https://eslint.org/docs/rules/sort-imports" }, diff --git a/lib/rules/sort-keys.js b/lib/rules/sort-keys.js index 2fc19635271..5cda81d0a7d 100644 --- a/lib/rules/sort-keys.js +++ b/lib/rules/sort-keys.js @@ -81,7 +81,7 @@ module.exports = { type: "suggestion", docs: { - description: "require object keys to be sorted", + description: "Require object keys to be sorted", recommended: false, url: "https://eslint.org/docs/rules/sort-keys" }, diff --git a/lib/rules/sort-vars.js b/lib/rules/sort-vars.js index 8246558c547..ec0718ee578 100644 --- a/lib/rules/sort-vars.js +++ b/lib/rules/sort-vars.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "require variables within the same declaration block to be sorted", + description: "Require variables within the same declaration block to be sorted", recommended: false, url: "https://eslint.org/docs/rules/sort-vars" }, diff --git a/lib/rules/space-before-blocks.js b/lib/rules/space-before-blocks.js index 5cc7266654f..ffd33ddcaea 100644 --- a/lib/rules/space-before-blocks.js +++ b/lib/rules/space-before-blocks.js @@ -40,7 +40,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing before blocks", + description: "Enforce consistent spacing before blocks", recommended: false, url: "https://eslint.org/docs/rules/space-before-blocks" }, diff --git a/lib/rules/space-before-function-paren.js b/lib/rules/space-before-function-paren.js index fdd45be241d..b56ac3c52c7 100644 --- a/lib/rules/space-before-function-paren.js +++ b/lib/rules/space-before-function-paren.js @@ -20,7 +20,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing before `function` definition opening parenthesis", + description: "Enforce consistent spacing before `function` definition opening parenthesis", recommended: false, url: "https://eslint.org/docs/rules/space-before-function-paren" }, diff --git a/lib/rules/space-in-parens.js b/lib/rules/space-in-parens.js index 1509d600f1d..42d9bb58e7e 100644 --- a/lib/rules/space-in-parens.js +++ b/lib/rules/space-in-parens.js @@ -16,7 +16,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing inside parentheses", + description: "Enforce consistent spacing inside parentheses", recommended: false, url: "https://eslint.org/docs/rules/space-in-parens" }, diff --git a/lib/rules/space-infix-ops.js b/lib/rules/space-infix-ops.js index c526b7e2b0a..141c269df6b 100644 --- a/lib/rules/space-infix-ops.js +++ b/lib/rules/space-infix-ops.js @@ -16,7 +16,7 @@ module.exports = { type: "layout", docs: { - description: "require spacing around infix operators", + description: "Require spacing around infix operators", recommended: false, url: "https://eslint.org/docs/rules/space-infix-ops" }, diff --git a/lib/rules/space-unary-ops.js b/lib/rules/space-unary-ops.js index 04487c49e0d..1d9141d2b97 100644 --- a/lib/rules/space-unary-ops.js +++ b/lib/rules/space-unary-ops.js @@ -20,7 +20,7 @@ module.exports = { type: "layout", docs: { - description: "enforce consistent spacing before or after unary operators", + description: "Enforce consistent spacing before or after unary operators", recommended: false, url: "https://eslint.org/docs/rules/space-unary-ops" }, diff --git a/lib/rules/spaced-comment.js b/lib/rules/spaced-comment.js index d858fc47cf8..6aedeae871d 100644 --- a/lib/rules/spaced-comment.js +++ b/lib/rules/spaced-comment.js @@ -152,7 +152,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce consistent spacing after the `//` or `/*` in a comment", + description: "Enforce consistent spacing after the `//` or `/*` in a comment", recommended: false, url: "https://eslint.org/docs/rules/spaced-comment" }, diff --git a/lib/rules/strict.js b/lib/rules/strict.js index 0ea1da5677e..e677c95e717 100644 --- a/lib/rules/strict.js +++ b/lib/rules/strict.js @@ -69,7 +69,7 @@ module.exports = { type: "suggestion", docs: { - description: "require or disallow strict mode directives", + description: "Require or disallow strict mode directives", recommended: false, url: "https://eslint.org/docs/rules/strict" }, diff --git a/lib/rules/switch-colon-spacing.js b/lib/rules/switch-colon-spacing.js index cd2ca7018d2..c1df496fd94 100644 --- a/lib/rules/switch-colon-spacing.js +++ b/lib/rules/switch-colon-spacing.js @@ -21,7 +21,7 @@ module.exports = { type: "layout", docs: { - description: "enforce spacing around colons of switch statements", + description: "Enforce spacing around colons of switch statements", recommended: false, url: "https://eslint.org/docs/rules/switch-colon-spacing" }, diff --git a/lib/rules/symbol-description.js b/lib/rules/symbol-description.js index 07bb8cd2735..1c8a364986c 100644 --- a/lib/rules/symbol-description.js +++ b/lib/rules/symbol-description.js @@ -22,7 +22,7 @@ module.exports = { type: "suggestion", docs: { - description: "require symbol descriptions", + description: "Require symbol descriptions", recommended: false, url: "https://eslint.org/docs/rules/symbol-description" }, diff --git a/lib/rules/template-curly-spacing.js b/lib/rules/template-curly-spacing.js index c842b76a41f..35d4bbab4d7 100644 --- a/lib/rules/template-curly-spacing.js +++ b/lib/rules/template-curly-spacing.js @@ -21,7 +21,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow spacing around embedded expressions of template strings", + description: "Require or disallow spacing around embedded expressions of template strings", recommended: false, url: "https://eslint.org/docs/rules/template-curly-spacing" }, diff --git a/lib/rules/template-tag-spacing.js b/lib/rules/template-tag-spacing.js index fa1a613b894..3140fa0eed7 100644 --- a/lib/rules/template-tag-spacing.js +++ b/lib/rules/template-tag-spacing.js @@ -15,7 +15,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow spacing between template tags and their literals", + description: "Require or disallow spacing between template tags and their literals", recommended: false, url: "https://eslint.org/docs/rules/template-tag-spacing" }, diff --git a/lib/rules/unicode-bom.js b/lib/rules/unicode-bom.js index d480f1bcdc8..482d3bbf50b 100644 --- a/lib/rules/unicode-bom.js +++ b/lib/rules/unicode-bom.js @@ -14,7 +14,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow Unicode byte order mark (BOM)", + description: "Require or disallow Unicode byte order mark (BOM)", recommended: false, url: "https://eslint.org/docs/rules/unicode-bom" }, diff --git a/lib/rules/use-isnan.js b/lib/rules/use-isnan.js index 92903500c18..219d695374e 100644 --- a/lib/rules/use-isnan.js +++ b/lib/rules/use-isnan.js @@ -37,7 +37,7 @@ module.exports = { type: "problem", docs: { - description: "require calls to `isNaN()` when checking for `NaN`", + description: "Require calls to `isNaN()` when checking for `NaN`", recommended: true, url: "https://eslint.org/docs/rules/use-isnan" }, diff --git a/lib/rules/valid-jsdoc.js b/lib/rules/valid-jsdoc.js index 8662bf0eae7..25be39fdd51 100644 --- a/lib/rules/valid-jsdoc.js +++ b/lib/rules/valid-jsdoc.js @@ -21,7 +21,7 @@ module.exports = { type: "suggestion", docs: { - description: "enforce valid JSDoc comments", + description: "Enforce valid JSDoc comments", recommended: false, url: "https://eslint.org/docs/rules/valid-jsdoc" }, diff --git a/lib/rules/valid-typeof.js b/lib/rules/valid-typeof.js index 2286d8926cc..908d5725e22 100644 --- a/lib/rules/valid-typeof.js +++ b/lib/rules/valid-typeof.js @@ -14,7 +14,7 @@ module.exports = { type: "problem", docs: { - description: "enforce comparing `typeof` expressions against valid strings", + description: "Enforce comparing `typeof` expressions against valid strings", recommended: true, url: "https://eslint.org/docs/rules/valid-typeof" }, diff --git a/lib/rules/vars-on-top.js b/lib/rules/vars-on-top.js index 09e9932b4ca..99e2b4ac0dd 100644 --- a/lib/rules/vars-on-top.js +++ b/lib/rules/vars-on-top.js @@ -15,7 +15,7 @@ module.exports = { type: "suggestion", docs: { - description: "require `var` declarations be placed at the top of their containing scope", + description: "Require `var` declarations be placed at the top of their containing scope", recommended: false, url: "https://eslint.org/docs/rules/vars-on-top" }, diff --git a/lib/rules/wrap-iife.js b/lib/rules/wrap-iife.js index 8523796722a..4c2c9275d87 100644 --- a/lib/rules/wrap-iife.js +++ b/lib/rules/wrap-iife.js @@ -43,7 +43,7 @@ module.exports = { type: "layout", docs: { - description: "require parentheses around immediate `function` invocations", + description: "Require parentheses around immediate `function` invocations", recommended: false, url: "https://eslint.org/docs/rules/wrap-iife" }, diff --git a/lib/rules/wrap-regex.js b/lib/rules/wrap-regex.js index b10f2ec53bd..b24d36025ed 100644 --- a/lib/rules/wrap-regex.js +++ b/lib/rules/wrap-regex.js @@ -15,7 +15,7 @@ module.exports = { type: "layout", docs: { - description: "require parenthesis around regex literals", + description: "Require parenthesis around regex literals", recommended: false, url: "https://eslint.org/docs/rules/wrap-regex" }, diff --git a/lib/rules/yield-star-spacing.js b/lib/rules/yield-star-spacing.js index 884a3a4ed01..c2e07aaaa22 100644 --- a/lib/rules/yield-star-spacing.js +++ b/lib/rules/yield-star-spacing.js @@ -15,7 +15,7 @@ module.exports = { type: "layout", docs: { - description: "require or disallow spacing around the `*` in `yield*` expressions", + description: "Require or disallow spacing around the `*` in `yield*` expressions", recommended: false, url: "https://eslint.org/docs/rules/yield-star-spacing" }, diff --git a/lib/rules/yoda.js b/lib/rules/yoda.js index 5b64287a151..eb9a32ad5c3 100644 --- a/lib/rules/yoda.js +++ b/lib/rules/yoda.js @@ -121,7 +121,7 @@ module.exports = { type: "suggestion", docs: { - description: 'require or disallow "Yoda" conditions', + description: 'Require or disallow "Yoda" conditions', recommended: false, url: "https://eslint.org/docs/rules/yoda" }, diff --git a/tools/internal-rules/no-invalid-meta.js b/tools/internal-rules/no-invalid-meta.js index 2bfa2e21a4a..7fd62f5c7ac 100644 --- a/tools/internal-rules/no-invalid-meta.js +++ b/tools/internal-rules/no-invalid-meta.js @@ -92,7 +92,7 @@ function checkMetaValidity(context, exportsNode) { module.exports = { meta: { docs: { - description: "enforce correct use of `meta` property in core rules", + description: "Enforce correct use of `meta` property in core rules", recommended: false }, type: "problem",