feat: add redux-toolkit-floating-promises example

JoshuaKGoldberg · JoshuaKGoldberg · commit fdb1d16ef0d2 · 2025-01-16T08:12:33.000-05:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/redux-toolkit-floating-promises/README.md b/packages/redux-toolkit-floating-promises/README.md
@@ -0,0 +1,25 @@
+# Example: `redux-toolkit` and Floating Promise Detection
+
+An example of using [`redux-toolkit`](https://redux-toolkit.js.org) along with the [`@typescript-eslint/no-floating-promises` rule](https://typescript-eslint.io/rules/no-floating-promises) enabled.
+It uses the [`allowForKnownSafePromises` rule option](https://typescript-eslint.io/rules/no-floating-promises/#allowforknownsafepromises) to not report on RTK APIs that create a `SafePromise`, such as `createAsyncThunk`.
+
+## Setup
+
+```shell
+npm i
+```
+
+## Usage
+
+```shell
+npm run lint
+```
+
+There should be no lint reports.
+
+If you remove the `allowForKnownSafePromises` option from `eslint.config.js`, there will be:
+
+```plaintext
+.../index.test.ts
+  4:1  error  Promises must be awaited, end with a call to .catch, end with a call to .then with a rejection handler or be explicitly marked as ignored with the `void` operator  @typescript-eslint/no-floating-promises
+```
diff --git a/packages/redux-toolkit-floating-promises/eslint.config.js b/packages/redux-toolkit-floating-promises/eslint.config.js
@@ -0,0 +1,27 @@
+// @ts-check
+
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  tseslint.configs.recommendedTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: {
+          allowDefaultProject: ['*.config.*']
+        },
+      },
+    },
+    rules: {
+      "@typescript-eslint/no-floating-promises": [
+        "error", {
+          "allowForKnownSafePromises": [
+            { "from": "package", "name": "SafePromise", "package": "@reduxjs/toolkit" }
+          ]
+        }
+      ]
+    }
+  }
+);
diff --git a/packages/redux-toolkit-floating-promises/index.ts b/packages/redux-toolkit-floating-promises/index.ts
@@ -0,0 +1,16 @@
+import { configureStore, createAsyncThunk } from '@reduxjs/toolkit';
+
+function reducer() {
+    // ...
+}
+
+const store = configureStore({ reducer });
+
+const exampleThunk = createAsyncThunk(
+  'example',
+  async () => {
+    // ...
+  },
+);
+
+store.dispatch(exampleThunk());
diff --git a/packages/redux-toolkit-floating-promises/package.json b/packages/redux-toolkit-floating-promises/package.json
@@ -0,0 +1,26 @@
+{
+  "name": "redux-toolkit-floating-promises",
+  "version": "0.0.0",
+  "description": "Example of using `redux-toolkit` with `@typescript-eslint/no-floating-promises`'s `allowForKnownSafePromises` option.",
+  "main": "index.ts",
+  "repository": {
+    "directory": "packages/redux-toolkit-floating-promises",
+    "type": "git",
+    "url": "https://github.com/typescript-eslint/typescript-eslint-examples"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^22.10.7",
+    "eslint": "^9.16.0",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.18.0"
+  },
+  "dependencies": {
+    "@reduxjs/toolkit": "2.5.0"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "tsc": "tsc"
+  },
+  "type": "module"
+}
diff --git a/packages/redux-toolkit-floating-promises/tsconfig.json b/packages/redux-toolkit-floating-promises/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "strict": true
+  },
+}
