docs: specify TypeScript version with ~ to avoid issues with semver

BREAKING CHANGE: peerDependencies:
`@typescript-eslint/eslint-plugin@^8.3.0`
`@typescript-eslint/parser@^8.3.0`

.commitlintrc.json

@@ -1 +0,0 @@
-{ "extends": ["@commitlint/config-conventional"] }

.eslintrc.json

@@ -1,6 +1,6 @@
 {
   "root": true,
-  "plugins": ["import", "promise", "unicorn"],
+  "plugins": ["promise", "unicorn"],
   "env": {
     "browser": true,
     "node": true,
@@ -93,25 +93,12 @@
     ],
     "no-array-constructor": "error",
     "no-caller": "error",
-    "no-confusing-arrow": "error",
     "no-delete-var": "error",
     "no-empty": ["error", { "allowEmptyCatch": true }],
     "no-empty-static-block": "error",
     "no-eval": "error",
-    "no-floating-decimal": "error",
     "no-global-assign": "error",
     "no-implied-eval": "error",
-    "no-mixed-operators": [
-      "error",
-      {
-        "groups": [
-          ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
-          ["&&", "||"],
-          ["in", "instanceof"]
-        ],
-        "allowSamePrecedence": true
-      }
-    ],
     "no-multi-str": "error",
     "no-new-func": "error",
     "no-object-constructor": "error",
@@ -140,7 +127,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" }],
@@ -148,33 +135,13 @@
     "prefer-object-has-own": "error",
     "prefer-promise-reject-errors": "error",
     "prefer-regex-literals": ["error", { "disallowRedundantWrapping": true }],
-    "quote-props": ["error", "as-needed"],
     "radix": "error",
     "yoda": ["error", "never"],
     "curly": ["error", "all"],
     "func-style": ["error", "expression"],
     "prefer-arrow-callback": "error",
-    "arrow-parens": ["error", "always"],
     "arrow-body-style": ["error", "always"],
 
-    "import/no-absolute-path": "error",
-    "import/no-webpack-loader-syntax": "error",
-    "import/no-self-import": "error",
-    "import/no-useless-path-segments": "error",
-    "import/export": "error",
-    "import/first": "error",
-    "import/no-duplicates": "error",
-    "import/order": [
-      "error",
-      {
-        "groups": ["builtin", "external", "internal"],
-        "newlines-between": "always"
-      }
-    ],
-    "import/no-named-default": "error",
-    "import/no-empty-named-blocks": "error",
-    "import/no-anonymous-default-export": "error",
-
     "promise/param-names": "error",
     "promise/no-new-statics": "error",
     "promise/no-multiple-resolved": "error",
@@ -206,6 +173,7 @@
     "unicorn/require-array-join-separator": "error",
     "unicorn/prefer-number-properties": "error",
     "unicorn/prefer-modern-math-apis": "error",
+    "unicorn/prefer-structured-clone": "error",
     "unicorn/template-indent": "error"
   },
   "overrides": [
@@ -217,8 +185,6 @@
         "no-undef": "off",
         "no-dupe-class-members": "off",
         "@typescript-eslint/no-dupe-class-members": "error",
-        "no-loss-of-precision": "off",
-        "@typescript-eslint/no-loss-of-precision": "error",
         "no-unused-vars": "off",
         "@typescript-eslint/no-unused-vars": [
           "error",
@@ -249,7 +215,7 @@
           { "builtinGlobals": false }
         ],
         "no-throw-literal": "off",
-        "@typescript-eslint/no-throw-literal": "error",
+        "@typescript-eslint/only-throw-error": "error",
         "no-unused-expressions": "off",
         "@typescript-eslint/no-unused-expressions": [
           "error",
@@ -261,14 +227,21 @@
         ],
         "no-useless-constructor": "off",
         "@typescript-eslint/no-useless-constructor": "error",
-        "@typescript-eslint/no-useless-template-literals": "error",
+        "@typescript-eslint/no-unnecessary-template-expression": "error",
+        "@typescript-eslint/no-unnecessary-condition": [
+          "error",
+          {
+            "allowConstantLoopConditions": true
+          }
+        ],
 
         "@typescript-eslint/adjacent-overload-signatures": "error",
         "@typescript-eslint/array-type": [
           "error",
           { "default": "array-simple" }
         ],
-        "@typescript-eslint/ban-types": "error",
+        "@typescript-eslint/no-unsafe-function-type": "error",
+        "@typescript-eslint/no-wrapper-object-types": "error",
         "@typescript-eslint/consistent-type-definitions": [
           "error",
           "interface"
@@ -284,14 +257,8 @@
             "allowDirectConstAssertionInArrowFunctions": true
           }
         ],
-        "@typescript-eslint/member-delimiter-style": [
-          "error",
-          {
-            "multiline": { "delimiter": "none" },
-            "singleline": { "delimiter": "comma", "requireLast": false }
-          }
-        ],
         "@typescript-eslint/method-signature-style": "error",
+        "@typescript-eslint/unbound-method": "error",
         "@typescript-eslint/naming-convention": [
           "error",
           {
@@ -302,8 +269,10 @@
           }
         ],
         "@typescript-eslint/no-base-to-string": "error",
+        "@typescript-eslint/no-deprecated": "error",
         "@typescript-eslint/no-dynamic-delete": "error",
         "@typescript-eslint/no-extra-non-null-assertion": "error",
+        "@typescript-eslint/no-redundant-type-constituents": "error",
         "@typescript-eslint/no-extraneous-class": [
           "error",
           { "allowWithDecorator": true }
@@ -320,8 +289,9 @@
         ],
         "@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-unsafe-declaration-merging": "error",
         "@typescript-eslint/no-array-delete": "error",
         "@typescript-eslint/prefer-as-const": "error",
         "@typescript-eslint/prefer-function-type": "error",
@@ -337,7 +307,7 @@
         ],
         "@typescript-eslint/prefer-readonly": "error",
         "@typescript-eslint/prefer-reduce-type-parameter": "error",
-        "@typescript-eslint/prefer-ts-expect-error": "error",
+        "@typescript-eslint/prefer-return-this-type": "error",
         "@typescript-eslint/promise-function-async": "error",
         "prefer-promise-reject-errors": "off",
         "@typescript-eslint/prefer-promise-reject-errors": "error",
@@ -353,7 +323,6 @@
           "error",
           { "allowNumber": true }
         ],
-        "@typescript-eslint/return-await": ["error", "always"],
         "@typescript-eslint/strict-boolean-expressions": [
           "error",
           {
@@ -365,8 +334,7 @@
             "allowNullableNumber": false,
             "allowAny": false
           }
-        ],
+        ]
-        "@typescript-eslint/type-annotation-spacing": "error"
       }
     }
   ]

.github/workflows/lint.yml

@@ -4,25 +4,31 @@ 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.7"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.0.3"
         with:
-          node-version: "lts/*"
+          node-version: "22.x"
           cache: "npm"
 
       - name: "Install dependencies"
         run: "npm clean-install"
 
-      - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
+      - run: "node --run lint:editorconfig"
-      - run: "npm run lint:editorconfig"
+      - run: "node --run lint:markdown"
-      - run: "npm run lint:markdown"
+      - run: "node --run lint:eslint"
-      - run: "npm run lint:eslint"
+      - run: "node --run lint:prettier"
-      - run: "npm run lint:prettier"
+
+  commitlint:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: "actions/checkout@v4.1.7"
+
+      - uses: "wagoid/commitlint-github-action@v6.1.2"

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: "Release"
 
 on:
   push:
-    branches: [master]
+    branches: [main]
 
 jobs:
   release:
@@ -13,15 +13,15 @@ jobs:
       pull-requests: "write"
       id-token: "write"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.1.7"
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.0.3"
         with:
-          node-version: "lts/*"
+          node-version: "22.x"
           cache: "npm"
 
       - name: "Install dependencies"
@@ -31,7 +31,7 @@ jobs:
         run: "npm audit signatures"
 
       - name: "Release"
-        run: "npm run release"
+        run: "node --run release"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -4,22 +4,22 @@ 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.7"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.0.3"
         with:
-          node-version: "lts/*"
+          node-version: "22.x"
           cache: "npm"
 
       - name: "Install dependencies"
         run: "npm clean-install"
 
       - name: "Test"
-        run: "npm run test"
+        run: "node --run test"

.husky/commit-msg

@@ -1,3 +0,0 @@
-#!/usr/bin/env sh
-
-npm run lint:commit -- --edit

.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-
-npm run lint:staged
-npm run test

.lintstagedrc.json

@@ -1,7 +0,0 @@
-{
-  "**/*": ["editorconfig-checker", "prettier --write --ignore-unknown"],
-  "**/*.md": ["markdownlint-cli2 --fix --no-globs"],
-  "**/*.{js,jsx,ts,tsx}": [
-    "eslint --fix --max-warnings 0 --report-unused-disable-directives"
-  ]
-}

.npmrc

@@ -1,2 +1,2 @@
-save-exact=true
+save-exact = true
-provenance=true
+provenance = true

.releaserc.json

@@ -1,18 +1,8 @@
 {
-  "branches": ["master"],
+  "branches": ["main", { "name": "beta", "prerelease": true }],
   "plugins": [
-    [
+    "@semantic-release/commit-analyzer",
-      "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
-      {
-        "preset": "conventionalcommits"
-      }
-    ],
-    [
-      "@semantic-release/release-notes-generator",
-      {
-        "preset": "conventionalcommits"
-      }
-    ],
     "@semantic-release/npm",
     "@semantic-release/github"
   ]

.vscode/extensions.json

@@ -1,8 +0,0 @@
-{
-  "recommendations": [
-    "editorconfig.editorconfig",
-    "esbenp.prettier-vscode",
-    "dbaeumer.vscode-eslint",
-    "davidanson.vscode-markdownlint"
-  ]
-}

.vscode/settings.json

@@ -1,10 +0,0 @@
-{
-  "typescript.tsdk": "node_modules/typescript/lib",
-  "typescript.preferences.importModuleSpecifierEnding": "js",
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "prettier.configPath": ".prettierrc.json",
-  "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit"
-  }
-}

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.
 
@@ -37,29 +35,29 @@ More information about **formatting rules** vs **code-quality rules** can be fou
 
 ```sh
 npm install --save-dev \
-  eslint@^8.56.0 \
+  eslint@^8.57.0 \
-  eslint-plugin-import@^2.29.1 \
+  eslint-plugin-promise@^7.0.0 \
-  eslint-plugin-promise@^6.1.1 \
+  eslint-plugin-unicorn@^55.0.0 \
-  eslint-plugin-unicorn@^51.0.1 \
   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)
+- [ESLint Plugins](https://eslint.org/docs/user-guide/configuring/plugins)
-  - [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import)
   - [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise)
   - [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.5.4" \
-  @typescript-eslint/eslint-plugin@^6.21.0 \
+  "@typescript-eslint/eslint-plugin@^8.3.0" \
-  @typescript-eslint/parser@^6.21.0
+  "@typescript-eslint/parser@^8.3.0"
 ```
 
 Dependencies are:
@@ -68,37 +66,51 @@ 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
+{
+  "root": true,
+  "extends": ["conventions"],
+  "plugins": ["promise", "unicorn"]
+}
+```
+
+#### `.eslintrc.json` (TypeScript)
+
+```json
+{
+  "root": true,
+  "extends": ["conventions"],
+  "plugins": ["promise", "unicorn"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parser": "@typescript-eslint/parser",
+      "plugins": ["@typescript-eslint"],
+      "parserOptions": {
+        "projectService": true
+      }
+    }
+  ]
+}
+```
+
+#### 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`
 
@@ -114,12 +126,12 @@ echo "{}" > .prettierrc.json
 ### Usage
 
 ```sh
-npm run lint:eslint
+node --run lint:eslint
 # or to apply automatic fixes to code
-npm run lint:eslint -- --fix
+node --run lint:eslint -- --fix
 
 # Validate code formatting in all supported languages by Prettier
-npm run lint:prettier
+node --run lint:prettier
 ```
 
 ## 💡 Contributing

eslintrc.json

@@ -1,6 +1,6 @@
 {
   "extends": "./index.js",
   "parserOptions": {
-    "project": "./tsconfig.json"
+    "projectService": true
   }
 }

package.json

@@ -32,48 +32,34 @@
     "provenance": true
   },
   "engines": {
-    "node": ">=18.0.0",
+    "node": ">=18.0.0"
-    "npm": ">=10.0.0"
   },
   "scripts": {
-    "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
     "lint:markdown": "markdownlint-cli2",
     "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --config eslintrc.json",
     "lint:prettier": "prettier . --check",
-    "lint:staged": "lint-staged",
     "test": "node --test",
-    "release": "semantic-release",
+    "release": "semantic-release"
-    "postinstall": "husky",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable"
   },
   "peerDependencies": {
-    "eslint": "^8.56.0",
+    "eslint": "^8.57.0",
-    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-promise": "^7.0.0",
-    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-unicorn": "^55.0.0"
-    "eslint-plugin-unicorn": "^51.0.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "18.6.0",
+    "@types/eslint": "8.56.12",
-    "@commitlint/config-conventional": "18.6.0",
+    "@types/node": "22.7.4",
-    "@tsconfig/strictest": "2.0.2",
+    "@typescript-eslint/eslint-plugin": "8.7.0",
-    "@types/eslint": "8.56.2",
+    "@typescript-eslint/parser": "8.7.0",
-    "@types/node": "20.11.17",
+    "editorconfig-checker": "6.0.0",
-    "@typescript-eslint/eslint-plugin": "6.21.0",
+    "eslint": "8.57.1",
-    "@typescript-eslint/parser": "6.21.0",
+    "eslint-plugin-promise": "7.1.0",
-    "editorconfig-checker": "5.1.3",
+    "eslint-plugin-unicorn": "55.0.0",
-    "eslint": "8.56.0",
+    "markdownlint-cli2": "0.14.0",
-    "eslint-plugin-import": "2.29.1",
+    "markdownlint-rule-relative-links": "3.0.0",
-    "eslint-plugin-promise": "6.1.1",
+    "prettier": "3.3.3",
-    "eslint-plugin-unicorn": "51.0.1",
+    "semantic-release": "23.1.1",
-    "husky": "9.0.10",
+    "typescript": "5.6.2"
-    "lint-staged": "15.2.2",
-    "markdownlint-cli2": "0.12.1",
-    "markdownlint-rule-relative-links": "2.3.1",
-    "pinst": "3.0.0",
-    "prettier": "3.2.5",
-    "semantic-release": "23.0.2",
-    "typescript": "5.3.3"
   }
 }

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

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

test/validate-config.js

@@ -16,8 +16,31 @@ test("ensure we validate correctly JavaScript files", async () => {
   const [withErrors] = await eslint.lintFiles(
     "test/fixtures/javascript-with-errors.js",
   )
-  assert.strictEqual(noErrors?.errorCount, 0)
+  assert.strictEqual(noErrors?.errorCount, 0, JSON.stringify(noErrors, null, 2))
-  assert.strictEqual(withErrors?.errorCount, 3)
+  assert.strictEqual(
+    withErrors?.errorCount,
+    3,
+    JSON.stringify(withErrors, null, 2),
+  )
+})
+
+test("ensure we do not use deprecated rules", async () => {
+  const [javascriptLintResult] = await eslint.lintFiles(
+    "test/fixtures/javascript-no-errors.js",
+  )
+  const [typescriptLintResult] = await eslint.lintFiles(
+    "test/fixtures/typescript-no-errors.ts",
+  )
+  assert.strictEqual(
+    javascriptLintResult.usedDeprecatedRules.length,
+    0,
+    JSON.stringify(javascriptLintResult, null, 2),
+  )
+  assert.strictEqual(
+    typescriptLintResult.usedDeprecatedRules.length,
+    0,
+    JSON.stringify(typescriptLintResult, null, 2),
+  )
 })
 
 test("ensure we validate correctly TypeScript files", async () => {
@@ -27,13 +50,32 @@ test("ensure we validate correctly TypeScript files", async () => {
   const [withErrors] = await eslint.lintFiles(
     "test/fixtures/javascript-with-errors.js",
   )
-  assert.strictEqual(noErrors?.errorCount, 0)
+  assert.strictEqual(noErrors?.errorCount, 0, JSON.stringify(noErrors, null, 2))
-  assert.strictEqual(withErrors?.errorCount, 3)
+  assert.strictEqual(
+    withErrors?.errorCount,
+    3,
+    JSON.stringify(withErrors, null, 2),
+  )
 })
 
 test("ensure we allow top-level await", async () => {
   const [lintResult] = await eslint.lintFiles(
     "test/fixtures/top-level-await.mjs",
   )
-  assert.strictEqual(lintResult?.errorCount, 0)
+  assert.strictEqual(
+    lintResult?.errorCount,
+    0,
+    JSON.stringify(lintResult, null, 2),
+  )
+})
+
+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,
+    JSON.stringify(lintResult, null, 2),
+  )
 })

tsconfig.json

@@ -1,7 +1,7 @@
 {
-  "extends": "@tsconfig/strictest/tsconfig.json",
   "compilerOptions": {
     "resolveJsonModule": true,
+    "strict": true,
     "target": "ESNext",
     "module": "commonjs",
     "lib": ["ESNext"],