@typescript-eslint/eslint-plugin 8.9.1-alpha.6 → 8.9.1-alpha.7

package/docs/rules/restrict-template-expressions.mdx

@@ -55,7 +55,7 @@ const msg3 = `stringWithKindProp = ${stringWithKindProp}`;
 
 ### `allowNumber`
 
-Whether to allow `number` typed values in template expressions.
+{/* insert option description */}
 
 Examples of additional **correct** code for this rule with `{ allowNumber: true }`:
 
@@ -73,7 +73,7 @@ Consider using [`.toFixed()`](https://developer.mozilla.org/en-US/docs/Web/JavaS
 
 ### `allowBoolean`
 
-Whether to allow Boolean typed values in template expressions.
+{/* insert option description */}
 
 Examples of additional **correct** code for this rule with `{ allowBoolean: true }`:
 
@@ -85,7 +85,7 @@ const msg2 = `arg = ${arg || 'not truthy'}`;
 
 ### `allowAny`
 
-Whether to allow `any` typed values in template expressions.
+{/* insert option description */}
 
 Examples of additional **correct** code for this rule with `{ allowAny: true }`:
 
@@ -97,7 +97,7 @@ const msg2 = `arg = ${user.name || 'the user with no name'}`;
 
 ### `allowNullish`
 
-Whether to allow `null` or `undefined` typed values in template expressions.
+{/* insert option description */}
 
 Examples of additional **correct** code for this rule with `{ allowNullish: true }`:
 
@@ -108,7 +108,7 @@ const msg1 = `arg = ${arg}`;
 
 ### `allowRegExp`
 
-Whether to allow `RegExp` typed values in template expressions.
+{/* insert option description */}
 
 Examples of additional **correct** code for this rule with `{ allowRegExp: true }`:
 
@@ -124,7 +124,7 @@ const msg1 = `arg = ${arg}`;
 
 ### `allowNever`
 
-Whether to allow `never` typed values in template expressions.
+{/* insert option description */}
 
 Examples of additional **correct** code for this rule with `{ allowNever: true }`:
 
@@ -135,7 +135,7 @@ const msg1 = typeof arg === 'string' ? arg : `arg = ${arg}`;
 
 ### `allowArray`
 
-Whether to allow `Array` typed values in template expressions.
+{/* insert option description */}
 
 Examples of additional **correct** code for this rule with `{ allowArray: true }`:
 
@@ -146,6 +146,8 @@ const msg1 = `arg = ${arg}`;
 
 ### `allow`
 
+{/* insert option description */}
+
 Whether to allow additional types in template expressions.
 
 This option takes the shared [`TypeOrValueSpecifier` format](/packages/type-utils/type-or-value-specifier).

package/docs/rules/return-await.mdx

@@ -189,6 +189,8 @@ async function validInTryCatch7() {
 
 ### `always`
 
+{/* insert option description */}
+
 Requires that all returned promises be awaited.
 
 This is a good option if you like the consistency of simply always awaiting promises, or prefer not having to consider the distinction between error-handling contexts and ordinary contexts.
@@ -268,6 +270,8 @@ async function asyncFunction(): Promise<void> {
 
 ### `never`
 
+{/* insert option description */}
+
 Disallows awaiting any returned promises.
 
 :::warning

package/docs/rules/sort-type-constituents.mdx

@@ -96,7 +96,7 @@ type T4 =
 
 ### `caseSensitive`
 
-Whether to sort using case sensitive string comparisons.
+{/* insert option description */}
 
 Examples of code with `{ "caseSensitive": true }`:
 
@@ -119,7 +119,7 @@ type T = 'DeleteForever' | 'DeletedAt';
 
 ### `checkIntersections`
 
-Whether to check intersection types (`&`).
+{/* insert option description */}
 
 Examples of code with `{ "checkIntersections": true }` (the default):
 
@@ -142,7 +142,7 @@ type ExampleIntersection = A & B;
 
 ### `checkUnions`
 
-Whether to check union types (`|`).
+{/* insert option description */}
 
 Examples of code with `{ "checkUnions": true }` (the default):
 
@@ -165,6 +165,8 @@ type ExampleUnion = A | B;
 
 ### `groupOrder`
 
+{/* insert option description */}
+
 Each constituent of the type is placed into a group, and then the rule sorts alphabetically within each group.
 The ordering of groups is determined by this option.
 

package/docs/rules/strict-boolean-expressions.mdx

@@ -95,55 +95,65 @@ const foo = (arg: any) => (Boolean(arg) ? 1 : 0);
 
 ### `allowString`
 
-Allows `string` in a boolean context.
-This is safe because strings have only one falsy value (`""`).
+{/* insert option description */}
+
+This can be safe because strings have only one falsy value (`""`).
 Set this to `false` if you prefer the explicit `str != ""` or `str.length > 0` style.
 
 ### `allowNumber`
 
-Allows `number` in a boolean context.
-This is safe because numbers have only two falsy values (`0` and `NaN`).
+{/* insert option description */}
+
+This can be safe because numbers have only two falsy values (`0` and `NaN`).
 Set this to `false` if you prefer the explicit `num != 0` and `!Number.isNaN(num)` style.
 
 ### `allowNullableObject`
 
-Allows `object | function | symbol | null | undefined` in a boolean context.
-This is safe because objects, functions and symbols don't have falsy values.
+{/* insert option description */}
+
+This can be safe because objects, functions, and symbols don't have falsy values.
 Set this to `false` if you prefer the explicit `obj != null` style.
 
 ### `allowNullableBoolean`
 
-Allows `boolean | null | undefined` in a boolean context.
+{/* insert option description */}
+
 This is unsafe because nullable booleans can be either `false` or nullish.
 Set this to `false` if you want to enforce explicit `bool ?? false` or `bool ?? true` style.
 Set this to `true` if you don't mind implicitly treating false the same as a nullish value.
 
 ### `allowNullableString`
 
-Allows `string | null | undefined` in a boolean context.
+{/* insert option description */}
+
 This is unsafe because nullable strings can be either an empty string or nullish.
 Set this to `true` if you don't mind implicitly treating an empty string the same as a nullish value.
 
 ### `allowNullableNumber`
 
-Allows `number | null | undefined` in a boolean context.
+{/* insert option description */}
+
 This is unsafe because nullable numbers can be either a falsy number or nullish.
 Set this to `true` if you don't mind implicitly treating zero or NaN the same as a nullish value.
 
 ### `allowNullableEnum`
 
-Allows `enum | null | undefined` in a boolean context.
+{/* insert option description */}
+
 This is unsafe because nullable enums can be either a falsy number or nullish.
 Set this to `true` if you don't mind implicitly treating an enum whose value is zero the same as a nullish value.
 
 ### `allowAny`
 
-Allows `any` in a boolean context.
-This is unsafe for obvious reasons.
+{/* insert option description */}
+
+This is unsafe for because `any` allows any values and disables many type checking checks.
 Set this to `true` at your own risk.
 
 ### `allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing`
 
+{/* insert option description */}
+
 :::danger Deprecated
 
 This option will be removed in the next major version of typescript-eslint.

package/docs/rules/switch-exhaustiveness-check.mdx

@@ -18,7 +18,9 @@ This rule reports when a `switch` statement over a value typed as a union of lit
 
 ### `allowDefaultCaseForExhaustiveSwitch`
 
-Defaults to true. If set to false, this rule will also report when a `switch` statement has a case for everything in a union and _also_ contains a `default` case. Thus, by setting this option to false, the rule becomes stricter.
+{/* insert option description */}
+
+If set to false, this rule will also report when a `switch` statement has a case for everything in a union and _also_ contains a `default` case. Thus, by setting this option to false, the rule becomes stricter.
 
 When a `switch` statement over a union type is exhaustive, a final `default` case would be a form of dead code.
 Additionally, if a new value is added to the union type, a `default` would prevent the `switch-exhaustiveness-check` rule from reporting on the new case not being handled in the `switch` statement.
@@ -34,7 +36,9 @@ If your project has many intentionally redundant `default` cases, you may want t
 
 ### `requireDefaultForNonUnion`
 
-Defaults to false. If set to true, this rule will also report when a `switch` statement switches over a non-union type (like a `number` or `string`, for example) and that `switch` statement does not have a `default` case. Thus, by setting this option to true, the rule becomes stricter.
+{/* insert option description */}
+
+If set to true, this rule will also report when a `switch` statement switches over a non-union type (like a `number` or `string`, for example) and that `switch` statement does not have a `default` case. Thus, by setting this option to true, the rule becomes stricter.
 
 This is generally desirable so that `number` and `string` switches will be subject to the same exhaustive checks that your other switches are.
 

package/docs/rules/triple-slash-reference.mdx

@@ -20,6 +20,8 @@ Specifying `'always'` disables this lint rule for that kind of reference.
 
 ### `lib`
 
+{/* insert option description */}
+
 When set to `'never'`, bans `/// <reference lib="..." />` and enforces using an `import` instead:
 
 <Tabs>
@@ -43,6 +45,8 @@ import { value } from 'code';
 
 ### `path`
 
+{/* insert option description */}
+
 When set to `'never'`, bans `/// <reference path="..." />` and enforces using an `import` instead:
 
 <Tabs>
@@ -66,6 +70,8 @@ import { value } from 'code';
 
 ### `types`
 
+{/* insert option description */}
+
 When set to `'never'`, bans `/// <reference types="..." />` and enforces using an `import` instead:
 
 <Tabs>

package/docs/rules/typedef.mdx

@@ -62,7 +62,7 @@ For example, with the following configuration:
 
 ### `arrayDestructuring`
 
-Whether to enforce type annotations on variables declared using array destructuring.
+{/* insert option description */}
 
 Examples of code with `{ "arrayDestructuring": true }`:
 
@@ -91,7 +91,7 @@ for (const [key, val] of new Map([['key', 1]])) {
 
 ### `arrowParameter`
 
-Whether to enforce type annotations for parameters of arrow functions.
+{/* insert option description */}
 
 Examples of code with `{ "arrowParameter": true }`:
 
@@ -126,7 +126,7 @@ const mapper = {
 
 ### `memberVariableDeclaration`
 
-Whether to enforce type annotations on member variables of classes.
+{/* insert option description */}
 
 Examples of code with `{ "memberVariableDeclaration": true }`:
 
@@ -155,7 +155,7 @@ class ContainsText {
 
 ### `objectDestructuring`
 
-Whether to enforce type annotations on variables declared using object destructuring.
+{/* insert option description */}
 
 Examples of code with `{ "objectDestructuring": true }`:
 
@@ -183,7 +183,7 @@ for (const { key, val } of [{ key: 'key', val: 1 }]) {
 
 ### `parameter`
 
-Whether to enforce type annotations for parameters of functions and methods.
+{/* insert option description */}
 
 Examples of code with `{ "parameter": true }`:
 
@@ -250,7 +250,7 @@ class Logger {
 
 ### `propertyDeclaration`
 
-Whether to enforce type annotations for properties of interfaces and types.
+{/* insert option description */}
 
 Examples of code with `{ "propertyDeclaration": true }`:
 
@@ -279,7 +279,7 @@ type Members = {
 
 ### `variableDeclaration`
 
-Whether to enforce type annotations for variable declarations, excluding array and object destructuring.
+{/* insert option description */}
 
 Examples of code with `{ "variableDeclaration": true }`:
 
@@ -306,7 +306,7 @@ let delayedText: string;
 
 ### `variableDeclarationIgnoreFunction`
 
-Whether to ignore variable declarations for non-arrow and arrow functions.
+{/* insert option description */}
 
 Examples of code with `{ "variableDeclaration": true, "variableDeclarationIgnoreFunction": true }`:
 

package/docs/rules/unbound-method.mdx

@@ -87,6 +87,8 @@ const { double } = arith;
 
 ### `ignoreStatic`
 
+{/* insert option description */}
+
 Examples of **correct** code for this rule with `{ ignoreStatic: true }`:
 
 ```ts option='{ "ignoreStatic": true }' showPlaygroundButton

package/docs/rules/unified-signatures.mdx

@@ -55,6 +55,8 @@ function f(...a: string[]): void;
 
 ### `ignoreDifferentlyNamedParameters`
 
+{/* insert option description */}
+
 Examples of code for this rule with `ignoreDifferentlyNamedParameters`:
 
 <Tabs>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typescript-eslint/eslint-plugin",
-  "version": "8.9.1-alpha.6",
+  "version": "8.9.1-alpha.7",
   "description": "TypeScript plugin for ESLint",
   "files": [
     "dist",
@@ -61,10 +61,10 @@
   },
   "dependencies": {
     "@eslint-community/regexpp": "^4.10.0",
-    "@typescript-eslint/scope-manager": "8.9.1-alpha.6",
-    "@typescript-eslint/type-utils": "8.9.1-alpha.6",
-    "@typescript-eslint/utils": "8.9.1-alpha.6",
-    "@typescript-eslint/visitor-keys": "8.9.1-alpha.6",
+    "@typescript-eslint/scope-manager": "8.9.1-alpha.7",
+    "@typescript-eslint/type-utils": "8.9.1-alpha.7",
+    "@typescript-eslint/utils": "8.9.1-alpha.7",
+    "@typescript-eslint/visitor-keys": "8.9.1-alpha.7",
     "graphemer": "^1.4.0",
     "ignore": "^5.3.1",
     "natural-compare": "^1.4.0",
@@ -75,8 +75,8 @@
     "@types/marked": "^5.0.2",
     "@types/mdast": "^4.0.3",
     "@types/natural-compare": "*",
-    "@typescript-eslint/rule-schema-to-typescript-types": "8.9.1-alpha.6",
-    "@typescript-eslint/rule-tester": "8.9.1-alpha.6",
+    "@typescript-eslint/rule-schema-to-typescript-types": "8.9.1-alpha.7",
+    "@typescript-eslint/rule-tester": "8.9.1-alpha.7",
     "ajv": "^6.12.6",
     "cross-env": "^7.0.3",
     "cross-fetch": "*",