chore: add @typescript-eslint/no-floating-promises rule (#261)

Author: DimitarNestorov

README.md

@@ -99,6 +99,23 @@ Then when running ESLint add `--ext '.js,.ts'` (you might need also `.jsx, .tsx`
 yarn eslint --ext '.js,.ts' ./src
 ```
 
+`parserOptions.project` is set to `./tsconfig.json`. You may need to [adjust that](https://typescript-eslint.io/architecture/parser#project).
+
+To do so, you'll need to override our setup for TS files in your ESLint config:
+
+```json
+{
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parserOptions": {
+        "project": "./packages/**/tsconfig.json"
+      }
+    }
+  ]
+}
+```
+
 #### VSCode
 
 If you're VSCode user, you may find adding this config to your `.vscode/settings.json` helpful:

node.js

@@ -80,6 +80,9 @@ module.exports = {
       files: ['*.ts', '*.tsx'],
       parser: '@typescript-eslint/parser',
       plugins: ['@typescript-eslint/eslint-plugin'],
+      parserOptions: {
+        project: './tsconfig.json'
+      },
       settings: {
         'import/extensions': [...extensions.TS, ...extensions.JS],
         'import/parsers': {
@@ -94,6 +97,7 @@ module.exports = {
       rules: {
         '@typescript-eslint/no-unused-vars': [ERROR, NO_UNUSED_VARS_OPTIONS],
         '@typescript-eslint/prefer-optional-chain': ERROR,
+        '@typescript-eslint/no-floating-promises': ERROR,
         'no-dupe-class-members': OFF,
         'no-unused-vars': OFF,
         'no-undef': OFF,

test/index.tsx

@@ -55,6 +55,7 @@ export function Hook() {
 
   // eslint-disable-next-line require-await
   async () => {
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     new Promise((resolve) => resolve('test'));
   };