@typescript-eslint/eslint-plugin 8.3.1-alpha.0 → 8.3.1-alpha.10

package/docs/rules/no-shadow.mdx

@@ -31,7 +31,7 @@ const defaultOptions: Options = {
 
 ### `ignoreTypeValueShadow`
 
-When set to `true`, the rule will ignore the case when you name a type the same as a variable. This is generally safe because you cannot use variables in type locations without a `typeof` operator, so there's little risk of confusion.
+Whether to ignore types named the same as a variable. This is generally safe because you cannot use variables in type locations without a `typeof` operator, so there's little risk of confusion.
 
 Examples of **correct** code with `{ ignoreTypeValueShadow: true }`:
 
@@ -55,7 +55,7 @@ _Shadowing_ specifically refers to two identical identifiers that are in differe
 
 ### `ignoreFunctionTypeParameterNameValueShadow`
 
-When set to `true`, the rule will ignore the case when you name a parameter in a function type the same as a variable.
+Whether to ignore function parameters named the same as a variable.
 
 Each of a function type's arguments creates a value variable within the scope of the function type. This is done so that you can reference the type later using the `typeof` operator:
 

package/docs/rules/no-use-before-define.mdx

@@ -33,6 +33,8 @@ const defaultOptions: Options = {
 
 ### `enums`
 
+Whether to check references to enums before the enum declaration.
+
 If this is `true`, this rule warns every reference to a enum before the enum declaration.
 If this is `false`, this rule will ignore references to enums, when the reference is in a child scope.
 
@@ -67,6 +69,8 @@ enum Foo {
 
 ### `typedefs`
 
+Whether to check references to types before the type declaration.
+
 If this is `true`, this rule warns every reference to a type before the type declaration.
 If this is `false`, this rule will ignore references to types.
 
@@ -79,7 +83,9 @@ type StringOrNumber = string | number;
 
 ### `ignoreTypeReferences`
 
-If this is `true`, this rule ignores all type references, such as in type annotations and assertions.
+Whether to ignore type references, such as in type annotations and assertions.
+
+If this is `true`, this rule ignores all type references.
 If this is `false`, this will check all type references.
 
 Examples of **correct** code for the `{ "ignoreTypeReferences": true }` option:

package/docs/rules/prefer-literal-enum-member.mdx

@@ -67,7 +67,7 @@ enum Valid {
 
 ### `allowBitwiseExpressions`
 
-When set to `true` will allow you to use bitwise expressions in enum initializer (default: `false`).
+Whether to allow using bitwise expressions in enum initializers (default: `false`).
 
 Examples of code for the `{ "allowBitwiseExpressions": true }` option:
 

package/docs/rules/prefer-nullish-coalescing.mdx

@@ -25,7 +25,7 @@ This rule will not work as expected if [`strictNullChecks`](https://www.typescri
 
 ### `ignoreTernaryTests`
 
-Setting this option to `true` will cause the rule to ignore any ternary expressions that could be simplified by using the nullish coalescing operator. This is set to `false` by default.
+Whether to ignore any ternary expressions that could be simplified by using the nullish coalescing operator. This is set to `false` by default.
 
 Incorrect code for `ignoreTernaryTests: false`, and correct code for `ignoreTernaryTests: true`:
 
@@ -65,7 +65,7 @@ foo ?? 'a string';
 
 ### `ignoreConditionalTests`
 
-Setting this option to `false` will cause the rule to also check cases that are located within a conditional test. This is set to `true` by default.
+Whether to ignore cases that are located within a conditional test. This is set to `true` by default.
 
 Generally expressions within conditional tests intentionally use the falsy fallthrough behavior of the logical or operator, meaning that fixing the operator to the nullish coalesce operator could cause bugs.
 
@@ -107,7 +107,7 @@ a ?? b ? true : false;
 
 ### `ignoreMixedLogicalExpressions`
 
-Setting this option to `true` will cause the rule to ignore any logical or expressions that are part of a mixed logical expression (with `&&`). This is set to `false` by default.
+Whether to ignore any logical or expressions that are part of a mixed logical expression (with `&&`). This is set to `false` by default.
 
 Generally expressions within mixed logical expressions intentionally use the falsy fallthrough behavior of the logical or operator, meaning that fixing the operator to the nullish coalesce operator could cause bugs.
 
@@ -147,6 +147,8 @@ a ?? (b && c && d);
 
 ### `ignorePrimitives`
 
+Whether to ignore all (`true`) or some (an object with properties) primitive types.
+
 If you would like to ignore expressions containing operands of certain primitive types that can be falsy then you may pass an object containing a boolean value for each primitive:
 
 - `string: true`, ignores `null` or `undefined` unions with `string` (default: false).
@@ -172,7 +174,7 @@ Also, if you would like to ignore all primitives types, you can set `ignorePrimi
 
 ### `allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing`
 
-If this is set to `false`, then the rule will error on every file whose `tsconfig.json` does _not_ have the `strictNullChecks` compiler option (or `strict`) set to `true`.
+Unless this is set to `true`, the rule will error on every file whose `tsconfig.json` does _not_ have the `strictNullChecks` compiler option (or `strict`) set to `true`.
 
 Without `strictNullChecks`, TypeScript essentially erases `undefined` and `null` from the types. This means when this rule inspects the types from a variable, **it will not be able to tell that the variable might be `null` or `undefined`**, which essentially makes this rule useless.
 

package/docs/rules/prefer-readonly-parameter-types.mdx

@@ -140,23 +140,16 @@ interface Foo {
 
 ### `allow`
 
+An array of type specifiers to ignore.
 Some complex types cannot easily be made readonly, for example the `HTMLElement` type or the `JQueryStatic` type from `@types/jquery`. This option allows you to globally disable reporting of such types.
 
-This option takes an array of type specifiers to ignore.
-Each item in the array must have one of the following forms:
-
-- A type defined in a file (`{ from: "file", name: "Foo", path: "src/foo-file.ts" }` with `path` being an optional path relative to the project root directory)
-- A type from the default library (`{ from: "lib", name: "Foo" }`)
-- A type from a package (`{ from: "package", name: "Foo", package: "foo-lib" }`, this also works for types defined in a typings package).
-
-Additionally, a type may be defined just as a simple string, which then matches the type independently of its origin.
+This option takes the shared [`TypeOrValueSpecifier` format](/packages/type-utils/type-or-value-specifier).
 
 Examples of code for this rule with:
 
 ```json
 {
   "allow": [
-    "$",
     { "from": "file", "name": "Foo" },
     { "from": "lib", "name": "HTMLElement" },
     { "from": "package", "name": "Bar", "package": "bar-lib" }
@@ -167,7 +160,7 @@ Examples of code for this rule with:
 <Tabs>
 <TabItem value="❌ Incorrect">
 
-```ts option='{"allow":["$",{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
+```ts option='{"allow":[{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
 interface ThisIsMutable {
   prop: string;
 }
@@ -191,7 +184,7 @@ function fn2(arg: Wrapper) {}
 function fn3(arg: WrapperWithOther) {}
 ```
 
-```ts option='{"allow":["$",{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
+```ts option='{"allow":[{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
 import { Foo } from 'some-lib';
 import { Bar } from 'incorrect-lib';
 
@@ -212,7 +205,7 @@ function fn3(arg: Bar) {}
 </TabItem>
 <TabItem value="✅ Correct">
 
-```ts option='{"allow":["$",{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
+```ts option='{"allow":[{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
 interface Foo {
   prop: string;
 }
@@ -229,7 +222,7 @@ function fn1(arg: Foo) {}
 function fn2(arg: Wrapper) {}
 ```
 
-```ts option='{"allow":["$",{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
+```ts option='{"allow":[{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
 import { Bar } from 'bar-lib';
 
 interface Foo {
@@ -246,7 +239,7 @@ function fn2(arg: HTMLElement) {}
 function fn3(arg: Bar) {}
 ```
 
-```ts option='{"allow":["$",{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
+```ts option='{"allow":[{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
 import { Foo } from './foo';
 
 // Works because Foo is still a local type - it has to be in the same package
@@ -258,7 +251,7 @@ function fn(arg: Foo) {}
 
 ### `checkParameterProperties`
 
-This option allows you to enable or disable the checking of parameter properties.
+Whether to check class parameter properties.
 Because parameter properties create properties on the class, it may be undesirable to force them to be readonly.
 
 Examples of code for this rule with `{checkParameterProperties: true}`:
@@ -297,7 +290,8 @@ class Foo {
 
 ### `ignoreInferredTypes`
 
-This option allows you to ignore parameters which don't explicitly specify a type. This may be desirable in cases where an external dependency specifies a callback with mutable parameters, and manually annotating the callback's parameters is undesirable.
+Whether to ignore parameters which don't explicitly specify a type.
+This may be desirable in cases where an external dependency specifies a callback with mutable parameters, and manually annotating the callback's parameters is undesirable.
 
 Examples of code for this rule with `{ignoreInferredTypes: true}`:
 
@@ -354,7 +348,8 @@ export const acceptsCallback: AcceptsCallback;
 
 ### `treatMethodsAsReadonly`
 
-This option allows you to treat all mutable methods as though they were readonly. This may be desirable when you are never reassigning methods.
+Whether to treat all mutable methods as though they are readonly.
+This may be desirable when you are never reassigning methods.
 
 Examples of code for this rule with `{treatMethodsAsReadonly: false}`:
 

package/docs/rules/promise-function-async.mdx

@@ -68,7 +68,7 @@ async function functionReturnsUnionWithPromiseImplicitly(p: boolean) {
 
 ### `allowAny`
 
-Whether to ignore functions that return `any` and `unknown`.
+Whether to ignore functions that return `any` or `unknown`.
 If you want additional safety, consider turning this option off, as it makes the rule less able to catch incorrect Promise behaviors.
 
 Examples of code with `{ "allowAny": false }`:
@@ -135,7 +135,7 @@ Whether to check inline function expressions.
 
 ### `checkMethodDeclarations`
 
-Whether to check methods on classes and object literals
+Whether to check methods on classes and object literals.
 `true` by default, but can be set to `false` to ignore them.
 
 ## When Not To Use It

package/docs/rules/require-await.mdx

@@ -12,14 +12,43 @@ import TabItem from '@theme/TabItem';
 This rule extends the base [`eslint/require-await`](https://eslint.org/docs/rules/require-await) rule.
 It uses type information to allow promise-returning functions to be marked as `async` without containing an `await` expression.
 
+:::note
+`yield` expressions in [async generator functions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function*) behave differently from sync generator functions (they unwrap promises), so the base rule never checks async generator functions. On the other hand, our rule uses type information and can detect async generator functions that both never use `await` and always yield non-promise values.
+:::
+
 ## Examples
 
-Examples of **correct** code for this rule:
+<Tabs>
+<TabItem value="❌ Incorrect">
+
+```ts
+async function returnNumber() {
+  return 1;
+}
+
+async function* asyncGenerator() {
+  yield 1;
+}
+
+const num = returnNumber();
+const callAsyncGenerator = () => asyncGenerator();
+```
+
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
-async function returnsPromise1() {
-  return Promise.resolve(1);
+function returnNumber() {
+  return 1;
 }
 
-const returnsPromise2 = () => returnsPromise1();
+function* syncGenerator() {
+  yield 1;
+}
+
+const num = returnNumber();
+const callSyncGenerator = () => syncGenerator();
 ```
+
+</TabItem>
+</Tabs>

package/docs/rules/typedef.mdx

@@ -306,7 +306,7 @@ let delayedText: string;
 
 ### `variableDeclarationIgnoreFunction`
 
-Ignore variable declarations for non-arrow and arrow functions.
+Whether to ignore variable declarations for non-arrow and arrow functions.
 
 Examples of code with `{ "variableDeclaration": true, "variableDeclarationIgnoreFunction": true }`:
 

package/package.json

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