@typescript-eslint/eslint-plugin 8.0.2-alpha.1 → 8.0.2-alpha.11

package/docs/rules/indent.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/key-spacing.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/keyword-spacing.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/lines-around-comment.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/lines-between-class-members.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/member-delimiter-style.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/no-duplicate-imports.mdx

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been deprecated in favour of the [`import/no-duplicates`](https://github.com/import-js/eslint-plugin-import/blob/HEAD/docs/rules/no-duplicates.md) rule.

package/docs/rules/no-extra-parens.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/no-extra-semi.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/no-misused-promises.mdx

@@ -37,10 +37,89 @@ If you don't want to check conditionals, you can configure the rule with `"check
 
 Doing so prevents the rule from looking at code like `if (somePromise)`.
 
-Examples of code for this rule with `checksConditionals: true`:
+### `checksVoidReturn`
+
+Likewise, if you don't want to check functions that return promises where a void return is
+expected, your configuration will look like this:
+
+```json
+{
+  "@typescript-eslint/no-misused-promises": [
+    "error",
+    {
+      "checksVoidReturn": false
+    }
+  ]
+}
+```
+
+You can disable selective parts of the `checksVoidReturn` option by providing an object that disables specific checks. For example, if you don't mind that passing a `() => Promise<void>` to a `() => void` parameter or JSX attribute can lead to a floating unhandled Promise:
+
+```json
+{
+  "@typescript-eslint/no-misused-promises": [
+    "error",
+    {
+      "checksVoidReturn": {
+        "arguments": false,
+        "attributes": false
+      }
+    }
+  ]
+}
+```
+
+The following sub-options are supported:
+
+#### `arguments`
+
+Disables checking an asynchronous function passed as argument where the parameter type expects a function that returns `void`.
+
+#### `attributes`
+
+Disables checking an asynchronous function passed as a JSX attribute expected to be a function that returns `void`.
+
+#### `inheritedMethods`
+
+Disables checking an asynchronous method in a type that extends or implements another type expecting that method to return `void`.
+
+:::note
+For now, `no-misused-promises` only checks _named_ methods against extended/implemented types: that is, call/construct/index signatures are ignored. Call signatures are not required in TypeScript to be consistent with one another, and construct signatures cannot be `async` in the first place. Index signature checking may be implemented in the future.
+:::
+
+#### `properties`
+
+Disables checking an asynchronous function passed as an object property expected to be a function that returns `void`.
+
+#### `returns`
+
+Disables checking an asynchronous function returned in a function whose return type is a function that returns `void`.
+
+#### `variables`
+
+Disables checking an asynchronous function used as a variable whose return type is a function that returns `void`.
+
+### `checksSpreads`
+
+If you don't want to check object spreads, you can add this configuration:
+
+```json
+{
+  "@typescript-eslint/no-misused-promises": [
+    "error",
+    {
+      "checksSpreads": false
+    }
+  ]
+}
+```
 
 ## Examples
 
+### `checksConditionals`
+
+Examples of code for this rule with `checksConditionals: true`:
+
 <Tabs>
 <TabItem value="❌ Incorrect">
 
@@ -81,45 +160,6 @@ while (await promise) {
 
 ### `checksVoidReturn`
 
-Likewise, if you don't want to check functions that return promises where a void return is
-expected, your configuration will look like this:
-
-```json
-{
-  "@typescript-eslint/no-misused-promises": [
-    "error",
-    {
-      "checksVoidReturn": false
-    }
-  ]
-}
-```
-
-You can disable selective parts of the `checksVoidReturn` option by providing an object that disables specific checks.
-The following options are supported:
-
-- `arguments`: Disables checking an asynchronous function passed as argument where the parameter type expects a function that returns `void`
-- `attributes`: Disables checking an asynchronous function passed as a JSX attribute expected to be a function that returns `void`
-- `properties`: Disables checking an asynchronous function passed as an object property expected to be a function that returns `void`
-- `returns`: Disables checking an asynchronous function returned in a function whose return type is a function that returns `void`
-- `variables`: Disables checking an asynchronous function used as a variable whose return type is a function that returns `void`
-
-For example, if you don't mind that passing a `() => Promise<void>` to a `() => void` parameter or JSX attribute can lead to a floating unhandled Promise:
-
-```json
-{
-  "@typescript-eslint/no-misused-promises": [
-    "error",
-    {
-      "checksVoidReturn": {
-        "arguments": false,
-        "attributes": false
-      }
-    }
-  ]
-}
-```
-
 Examples of code for this rule with `checksVoidReturn: true`:
 
 <Tabs>
@@ -140,6 +180,15 @@ document.addEventListener('click', async () => {
   await fetch('/');
   console.log('synchronous call');
 });
+
+interface MySyncInterface {
+  setThing(): void;
+}
+class MyClass implements MySyncInterface {
+  async setThing(): Promise<void> {
+    this.thing = await fetchThing();
+  }
+}
 ```
 
 </TabItem>
@@ -182,6 +231,15 @@ document.addEventListener('click', () => {
 
   handler().catch(handleError);
 });
+
+interface MyAsyncInterface {
+  setThing(): Promise<void>;
+}
+class MyClass implements MyAsyncInterface {
+  async setThing(): Promise<void> {
+    this.thing = await fetchThing();
+  }
+}
 ```
 
 </TabItem>
@@ -189,19 +247,6 @@ document.addEventListener('click', () => {
 
 ### `checksSpreads`
 
-If you don't want to check object spreads, you can add this configuration:
-
-```json
-{
-  "@typescript-eslint/no-misused-promises": [
-    "error",
-    {
-      "checksSpreads": false
-    }
-  ]
-}
-```
-
 Examples of code for this rule with `checksSpreads: true`:
 
 <Tabs>

package/docs/rules/no-parameter-properties.mdx

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been deprecated in favour of the [`parameter-properties`](https://typescript-eslint.io/rules/parameter-properties/) rule.

package/docs/rules/no-unsafe-return.mdx

@@ -15,7 +15,7 @@ Using `any` disables many type checking rules and is generally best used only as
 Despite your best intentions, the `any` type can sometimes leak into your codebase.
 Returning an an `any`-typed value from a function creates a potential type safety hole and source of bugs in your codebase.
 
-This rule disallows returning `any` or `any[]` from a function.
+This rule disallows returning `any` or `any[]` from a function and returning `Promise<any>` from an async function.
 
 This rule also compares generic type argument types to ensure you don't return an unsafe `any` in a generic position to a function that's expecting a specific type.
 For example, it will error if you return `Set<any>` from a function declared as returning `Set<string>`.
@@ -56,6 +56,10 @@ const foo10 = () => [] as any[];
 
 const foo11 = (): string[] => [1, 2, 3] as any[];
 
+async function foo13() {
+  return Promise.resolve({} as any);
+}
+
 // generic position examples
 function assignability1(): Set<string> {
   return new Set<any>([1]);
@@ -78,6 +82,10 @@ function foo2() {
 const foo3 = () => [];
 const foo4 = () => ['a'];
 
+async function foo5() {
+  return Promise.resolve(1);
+}
+
 function assignability1(): Set<string> {
   return new Set<string>(['foo']);
 }

package/docs/rules/no-useless-template-literals.mdx

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been renamed to [`no-unnecessary-template-expression`](./no-unnecessary-template-expression.mdx). See [#8544](https://github.com/typescript-eslint/typescript-eslint/issues/8544) for more information.

package/docs/rules/object-curly-spacing.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/padding-line-between-statements.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/quotes.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/semi.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/sort-type-union-intersection-members.mdx

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been renamed to [`sort-type-constituents`](https://typescript-eslint.io/rules/sort-type-constituents).

package/docs/rules/space-before-blocks.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/space-before-function-paren.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/docs/rules/space-infix-ops.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

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

@@ -30,13 +30,13 @@ The following nodes are considered boolean expressions and their type is checked
 
 ```ts
 // nullable numbers are considered unsafe by default
-let num: number | undefined = 0;
+declare const num: number | undefined;
 if (num) {
   console.log('num is defined');
 }
 
 // nullable strings are considered unsafe by default
-let str: string | null = null;
+declare const str: string | null;
 if (!str) {
   console.log('str is empty');
 }

package/docs/rules/type-annotation-spacing.md

@@ -1,3 +1,7 @@
+---
+displayed_sidebar: rulesSidebar
+---
+
 :::danger Deprecated
 
 This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typescript-eslint/eslint-plugin",
-  "version": "8.0.2-alpha.1",
+  "version": "8.0.2-alpha.11",
   "description": "TypeScript plugin for ESLint",
   "files": [
     "dist",
@@ -60,10 +60,10 @@
   },
   "dependencies": {
     "@eslint-community/regexpp": "^4.10.0",
-    "@typescript-eslint/scope-manager": "8.0.2-alpha.1",
-    "@typescript-eslint/type-utils": "8.0.2-alpha.1",
-    "@typescript-eslint/utils": "8.0.2-alpha.1",
-    "@typescript-eslint/visitor-keys": "8.0.2-alpha.1",
+    "@typescript-eslint/scope-manager": "8.0.2-alpha.11",
+    "@typescript-eslint/type-utils": "8.0.2-alpha.11",
+    "@typescript-eslint/utils": "8.0.2-alpha.11",
+    "@typescript-eslint/visitor-keys": "8.0.2-alpha.11",
     "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.0.2-alpha.1",
-    "@typescript-eslint/rule-tester": "8.0.2-alpha.1",
+    "@typescript-eslint/rule-schema-to-typescript-types": "8.0.2-alpha.11",
+    "@typescript-eslint/rule-tester": "8.0.2-alpha.11",
     "ajv": "^6.12.6",
     "cross-env": "^7.0.3",
     "cross-fetch": "*",