fix: allow to ignore floating promise with void operator: @typescript-eslint/no-floating-promises

Deprecated stylistic rule.

.eslintrc.json

@@ -140,7 +140,7 @@
     "no-useless-return": "error",
     "no-else-return": ["error", { "allowElseIf": false }],
     "no-var": "error",
-    "no-void": "error",
+    "no-void": ["error", { "allowAsStatement": true }],
     "no-with": "error",
     "object-shorthand": ["error", "properties"],
     "one-var": ["error", { "initialized": "never" }],
@@ -284,13 +284,6 @@
             "allowDirectConstAssertionInArrowFunctions": true
           }
         ],
-        "@typescript-eslint/member-delimiter-style": [
-          "error",
-          {
-            "multiline": { "delimiter": "none" },
-            "singleline": { "delimiter": "comma", "requireLast": false }
-          }
-        ],
         "@typescript-eslint/method-signature-style": "error",
         "@typescript-eslint/naming-convention": [
           "error",
@@ -321,6 +314,7 @@
         "@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
         "@typescript-eslint/no-unnecessary-type-assertion": "error",
         "@typescript-eslint/no-var-requires": "error",
+        "@typescript-eslint/no-require-imports": "error",
         "@typescript-eslint/no-unsafe-unary-minus": "error",
         "@typescript-eslint/no-array-delete": "error",
         "@typescript-eslint/prefer-as-const": "error",

.github/workflows/lint.yml

@@ -4,16 +4,16 @@ on:
   push:
     branches: [develop]
   pull_request:
-    branches: [master, develop]
+    branches: [main, develop]
 
 jobs:
   lint:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.1.6"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.0.2"
         with:
           node-version: "lts/*"
           cache: "npm"

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: "Release"
 
 on:
   push:
-    branches: [master]
+    branches: [main]
 
 jobs:
   release:
@@ -13,13 +13,13 @@ jobs:
       pull-requests: "write"
       id-token: "write"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.1.6"
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.0.2"
         with:
           node-version: "lts/*"
           cache: "npm"

.github/workflows/test.yml

@@ -4,16 +4,16 @@ on:
   push:
     branches: [develop]
   pull_request:
-    branches: [master, develop]
+    branches: [main, develop]
 
 jobs:
   test:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.1.6"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.0.2"
         with:
           node-version: "lts/*"
           cache: "npm"

.releaserc.json

@@ -1,5 +1,5 @@
 {
-  "branches": ["master"],
+  "branches": ["main", { "name": "beta", "prerelease": true }],
   "plugins": [
     [
       "@semantic-release/commit-analyzer",

README.md

@@ -4,8 +4,6 @@
   <strong><a href="https://eslint.org/docs/developer-guide/shareable-configs">ESLint shareable config</a> to enforce strict conventions and good code quality.</strong>
 </p>
 
-</p>
-
 <p align="center">
   <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="CONTRIBUTING" /></a>
   <a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
@@ -21,7 +19,7 @@
 
 ## 📜 About
 
-**eslint-config-conventions** is a [ESLint](https://eslint.org) configuration to enforce strict conventions and good code quality, it is highly inspired from [eslint-config-standard-with-typescript](https://github.com/mightyiam/eslint-config-standard-with-typescript) but it is **stricter** and with **no formatting rules**, **only code-quality rules**. It supports both **JavaScript** and **TypeScript**.
+**eslint-config-conventions** is a [ESLint](https://eslint.org) configuration to enforce strict conventions and good code quality. It supports both **JavaScript** and **TypeScript**.
 
 This configuration is mostly **for catching bugs** and **code-quality** so it is recommended to use it with [Prettier](https://prettier.io/) for a consistent code style, it works with any `.prettierrc.json` configuration.
 
@@ -40,11 +38,11 @@ npm install --save-dev \
   eslint@^8.56.0 \
   eslint-plugin-import@^2.29.1 \
   eslint-plugin-promise@^6.1.1 \
-  eslint-plugin-unicorn@^51.0.1 \
+  eslint-plugin-unicorn@^53.0.0 \
   eslint-config-conventions@latest
 ```
 
-This list of dependencies are:
+Dependencies are:
 
 - [ESLint](https://github.com/eslint/eslint)
 - 3 [ESLint Plugins](https://eslint.org/docs/user-guide/configuring/plugins)
@@ -53,13 +51,15 @@ This list of dependencies are:
   - [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
 - This package: `eslint-config-conventions`
 
+#### Installation with TypeScript
+
 If you want to use **TypeScript**, you also need to install:
 
 ```sh
 npm install --save-dev \
-  typescript@^5.3.3 \
+  "typescript@^5.3.3" \
-  @typescript-eslint/eslint-plugin@^6.21.0 \
+  "@typescript-eslint/eslint-plugin@>=6.21.0" \
-  @typescript-eslint/parser@^6.21.0
+  "@typescript-eslint/parser@>=6.21.0"
 ```
 
 Dependencies are:
@@ -68,37 +68,49 @@ Dependencies are:
 - [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint): ESLint rules for TypeScript.
 - [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint): ESLint parser for TypeScript.
 
-### Configuration with [Prettier](https://prettier.io/) (recommended)
+### Configuration
 
-You will need to install some dependencies in addition to those required:
+#### `.eslintrc.json` (JavaScript)
+
+```json
+{
+  "extends": ["conventions"],
+  "plugins": ["import", "promise", "unicorn"]
+}
+```
+
+#### `.eslintrc.json` (TypeScript)
+
+```json
+{
+  "extends": ["conventions"],
+  "plugins": ["import", "promise", "unicorn"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parser": "@typescript-eslint/parser",
+      "plugins": ["@typescript-eslint"],
+      "parserOptions": {
+        "project": "./tsconfig.json"
+      }
+    }
+  ]
+}
+```
+
+#### Configuration with [Prettier](https://prettier.io/) (recommended)
 
 ```sh
-npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier
+npm install --save-dev prettier
 
 # Create an empty config file to let editors and other tools know you are using Prettier
 # You can personalize it with your own rules
 echo "{}" > .prettierrc.json
 ```
 
-#### `.eslintrc.json`
+That's all! No need to update the `.eslintrc.json` configuration.
 
-```json
+We discourage usage of [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) and [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier), as `eslint-config-conventions` doesn't include any stylistic rules, and including these packages has several drawbacks (listed in [Integrating with Linters](https://prettier.io/docs/en/integrating-with-linters.html)) and brings no benefits for this configuration.
-{
-  "extends": ["conventions", "prettier"],
-  "plugins": ["prettier"],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": "./tsconfig.json"
-  },
-  "rules": {
-    "prettier/prettier": "error"
-  }
-}
-```
-
-**Note:** Please read some important instructions regarding the `project` option [here](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/README.md#configuration).
-
-`"parserOptions.project"` is only required if you use **TypeScript**.
 
 #### `package.json`
 

package.json

@@ -32,8 +32,7 @@
     "provenance": true
   },
   "engines": {
-    "node": ">=18.0.0",
+    "node": ">=18.0.0"
-    "npm": ">=10.0.0"
   },
   "scripts": {
     "lint:commit": "commitlint",
@@ -52,28 +51,28 @@
     "eslint": "^8.56.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-unicorn": "^51.0.1"
+    "eslint-plugin-unicorn": "^51.0.1 || ^52.0.0 || ^53.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "18.6.0",
+    "@commitlint/cli": "19.2.2",
-    "@commitlint/config-conventional": "18.6.0",
+    "@commitlint/config-conventional": "19.2.2",
-    "@tsconfig/strictest": "2.0.2",
+    "@tsconfig/strictest": "2.0.5",
-    "@types/eslint": "8.56.2",
+    "@types/eslint": "8.56.10",
-    "@types/node": "20.11.17",
+    "@types/node": "20.12.12",
-    "@typescript-eslint/eslint-plugin": "6.21.0",
+    "@typescript-eslint/eslint-plugin": "7.10.0",
-    "@typescript-eslint/parser": "6.21.0",
+    "@typescript-eslint/parser": "7.10.0",
-    "editorconfig-checker": "5.1.3",
+    "editorconfig-checker": "5.1.5",
-    "eslint": "8.56.0",
+    "eslint": "8.57.0",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-unicorn": "51.0.1",
+    "eslint-plugin-unicorn": "53.0.0",
-    "husky": "9.0.10",
+    "husky": "9.0.11",
     "lint-staged": "15.2.2",
-    "markdownlint-cli2": "0.12.1",
+    "markdownlint-cli2": "0.13.0",
-    "markdownlint-rule-relative-links": "2.3.1",
+    "markdownlint-rule-relative-links": "2.3.2",
     "pinst": "3.0.0",
     "prettier": "3.2.5",
-    "semantic-release": "23.0.2",
+    "semantic-release": "23.1.1",
-    "typescript": "5.3.3"
+    "typescript": "5.4.5"
   }
 }

test/fixtures/typescript-no-errors-ignore-promise.ts

@@ -0,0 +1,3 @@
+const returnsPromise = async (): Promise<void> => {}
+
+void returnsPromise()

test/validate-config.js

@@ -37,3 +37,10 @@ test("ensure we allow top-level await", async () => {
   )
   assert.strictEqual(lintResult?.errorCount, 0)
 })
+
+test("ensure we allow to ignore floating promise with void operator (@typescript-eslint/no-floating-promises)", async () => {
+  const [lintResult] = await eslint.lintFiles(
+    "test/fixtures/typescript-no-errors-ignore-promise.ts",
+  )
+  assert.strictEqual(lintResult?.errorCount, 0)
+})