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,19 +1,17 @@
 {
   "root": true,
-  "plugins": ["@typescript-eslint", "import", "promise", "unicorn"],
+  "plugins": ["promise", "unicorn"],
   "env": {
     "browser": true,
     "node": true,
-    "es2022": true
+    "es2024": true
   },
-  "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "ecmaVersion": 2022,
+    "ecmaVersion": "latest",
     "sourceType": "module",
     "ecmaFeatures": {
       "jsx": true
-    },
+    }
-    "project": "./tsconfig.json"
   },
   "rules": {
     "constructor-super": "error",
@@ -24,18 +22,17 @@
     "no-compare-neg-zero": "error",
     "no-cond-assign": "error",
     "no-const-assign": "error",
+    "no-constant-binary-expression": "error",
     "no-constant-condition": "error",
     "no-constructor-return": "error",
     "no-control-regex": "error",
     "no-debugger": "error",
     "no-dupe-args": "error",
-    "no-dupe-class-members": "off",
+    "no-dupe-class-members": "error",
-    "@typescript-eslint/no-dupe-class-members": "error",
     "no-dupe-else-if": "error",
     "no-dupe-keys": "error",
     "no-duplicate-case": "error",
-    "no-duplicate-imports": "off",
+    "no-duplicate-imports": "error",
-    "@typescript-eslint/no-duplicate-imports": "error",
     "no-empty-character-class": "error",
     "no-empty-pattern": "error",
     "no-ex-assign": "error",
@@ -44,9 +41,9 @@
     "no-import-assign": "error",
     "no-invalid-regexp": "error",
     "no-irregular-whitespace": "error",
-    "no-loss-of-precision": "off",
+    "no-loss-of-precision": "error",
-    "@typescript-eslint/no-loss-of-precision": "error",
     "no-misleading-character-class": "error",
+    "no-new-native-nonconstructor": "error",
     "no-new-symbol": "error",
     "no-obj-calls": "error",
     "no-promise-executor-return": "error",
@@ -54,6 +51,7 @@
     "no-self-assign": "error",
     "no-self-compare": "error",
     "no-setter-return": "error",
+    "no-sparse-arrays": "error",
     "no-this-before-super": "error",
     "no-undef": "error",
     "no-unexpected-multiline": "error",
@@ -64,21 +62,16 @@
     "no-unsafe-negation": "error",
     "no-unsafe-optional-chaining": "error",
     "no-unused-private-class-members": "error",
-    "no-unused-vars": "off",
+    "no-unused-vars": ["error", { "varsIgnorePattern": "^_" }],
-    "@typescript-eslint/no-unused-vars": "error",
+    "no-use-before-define": [
-    "no-use-before-define": "off",
-    "@typescript-eslint/no-use-before-define": [
       "error",
       {
         "functions": false,
         "classes": false,
-        "enums": false,
+        "variables": false
-        "variables": false,
-        "typedefs": false
       }
     ],
     "no-useless-backreference": "error",
-    "require-atomic-updates": "error",
     "use-isnan": [
       "error",
       {
@@ -89,54 +82,35 @@
     "valid-typeof": ["error", { "requireStringLiterals": true }],
 
     "consistent-this": "error",
-    "default-param-last": "off",
+    "default-param-last": "error",
-    "@typescript-eslint/default-param-last": "error",
     "default-case-last": "error",
-    "dot-notation": "off",
+    "dot-notation": ["error", { "allowKeywords": true }],
-    "@typescript-eslint/dot-notation": ["error", { "allowKeywords": true }],
     "eqeqeq": ["error", "always", { "null": "ignore" }],
     "grouped-accessor-pairs": "error",
     "new-cap": [
       "error",
       { "newIsCap": true, "capIsNew": false, "properties": true }
     ],
-    "no-array-constructor": "off",
+    "no-array-constructor": "error",
-    "@typescript-eslint/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": "off",
+    "no-implied-eval": "error",
-    "@typescript-eslint/no-implied-eval": "error",
-    "no-mixed-operators": [
-      "error",
-      {
-        "groups": [
-          ["==", "!=", "===", "!==", ">", ">=", "<", "<="],
-          ["&&", "||"],
-          ["in", "instanceof"]
-        ],
-        "allowSamePrecedence": true
-      }
-    ],
     "no-multi-str": "error",
     "no-new-func": "error",
-    "no-new-object": "error",
+    "no-object-constructor": "error",
     "no-octal": "error",
     "no-octal-escape": "error",
     "no-proto": "error",
-    "no-redeclare": "off",
+    "no-redeclare": ["error", { "builtinGlobals": false }],
-    "@typescript-eslint/no-redeclare": ["error", { "builtinGlobals": false }],
     "no-regex-spaces": "error",
     "no-shadow-restricted-names": "error",
-    "no-throw-literal": "off",
+    "no-throw-literal": "error",
-    "@typescript-eslint/no-throw-literal": "error",
     "no-undef-init": "error",
-    "no-unused-expressions": "off",
+    "no-unused-expressions": [
-    "@typescript-eslint/no-unused-expressions": [
       "error",
       {
         "allowShortCircuit": true,
@@ -145,14 +119,15 @@
       }
     ],
     "no-useless-call": "error",
+    "no-useless-concat": "error",
     "no-useless-computed-key": "error",
-    "no-useless-constructor": "off",
+    "no-useless-constructor": "error",
-    "@typescript-eslint/no-useless-constructor": "error",
     "no-useless-escape": "error",
     "no-useless-rename": "error",
     "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" }],
@@ -160,65 +135,119 @@
     "prefer-object-has-own": "error",
     "prefer-promise-reject-errors": "error",
     "prefer-regex-literals": ["error", { "disallowRedundantWrapping": true }],
-    "quote-props": ["error", "as-needed"],
     "radix": "error",
-    "require-await": "off",
-    "@typescript-eslint/require-await": "error",
-    "spaced-comment": ["error", "always"],
     "yoda": ["error", "never"],
-
+    "curly": ["error", "all"],
-    "import/no-absolute-path": "error",
+    "func-style": ["error", "expression"],
-    "import/no-webpack-loader-syntax": "error",
+    "prefer-arrow-callback": "error",
-    "import/no-self-import": "error",
+    "arrow-body-style": ["error", "always"],
-    "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",
 
     "promise/param-names": "error",
     "promise/no-new-statics": "error",
+    "promise/no-multiple-resolved": "error",
+    "promise/no-nesting": "error",
 
     "unicorn/better-regex": "error",
     "unicorn/catch-error-name": "error",
+    "unicorn/consistent-destructuring": "error",
     "unicorn/custom-error-definition": "error",
     "unicorn/error-message": "error",
     "unicorn/escape-case": "error",
+    "unicorn/explicit-length-check": "error",
     "unicorn/new-for-builtins": "error",
+    "unicorn/no-array-callback-reference": "error",
+    "unicorn/no-array-for-each": "error",
+    "unicorn/no-array-method-this-argument": "error",
+    "unicorn/no-document-cookie": "error",
+    "unicorn/no-empty-file": "error",
     "unicorn/no-hex-escape": "error",
     "unicorn/no-instanceof-array": "error",
+    "unicorn/no-new-array": "error",
+    "unicorn/no-new-buffer": "error",
     "unicorn/no-this-assignment": "error",
     "unicorn/no-zero-fractions": "error",
+    "unicorn/number-literal-case": "error",
     "unicorn/prefer-node-protocol": "error",
-    "unicorn/throw-new-error": "error"
+    "unicorn/throw-new-error": "error",
+    "unicorn/no-typeof-undefined": "error",
+    "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": [
     {
       "files": ["*.ts", "*.tsx"],
+      "parser": "@typescript-eslint/parser",
+      "plugins": ["@typescript-eslint"],
       "rules": {
+        "no-undef": "off",
+        "no-dupe-class-members": "off",
+        "@typescript-eslint/no-dupe-class-members": "error",
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": [
+          "error",
+          { "varsIgnorePattern": "^_" }
+        ],
+        "no-use-before-define": "off",
+        "@typescript-eslint/no-use-before-define": [
+          "error",
+          {
+            "functions": false,
+            "classes": false,
+            "enums": false,
+            "variables": false,
+            "typedefs": false
+          }
+        ],
+        "default-param-last": "off",
+        "@typescript-eslint/default-param-last": "error",
+        "dot-notation": "off",
+        "@typescript-eslint/dot-notation": ["error", { "allowKeywords": true }],
+        "no-array-constructor": "off",
+        "@typescript-eslint/no-array-constructor": "error",
+        "no-implied-eval": "off",
+        "@typescript-eslint/no-implied-eval": "error",
+        "no-redeclare": "off",
+        "@typescript-eslint/no-redeclare": [
+          "error",
+          { "builtinGlobals": false }
+        ],
+        "no-throw-literal": "off",
+        "@typescript-eslint/only-throw-error": "error",
+        "no-unused-expressions": "off",
+        "@typescript-eslint/no-unused-expressions": [
+          "error",
+          {
+            "allowShortCircuit": true,
+            "allowTernary": true,
+            "allowTaggedTemplates": true
+          }
+        ],
+        "no-useless-constructor": "off",
+        "@typescript-eslint/no-useless-constructor": "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/consistent-type-assertions": [
+        "@typescript-eslint/no-unsafe-function-type": "error",
-          "error",
+        "@typescript-eslint/no-wrapper-object-types": "error",
-          {
-            "assertionStyle": "as",
-            "objectLiteralTypeAssertions": "never"
-          }
-        ],
         "@typescript-eslint/consistent-type-definitions": [
           "error",
           "interface"
         ],
+        "no-duplicate-imports": "off",
+        "@typescript-eslint/consistent-type-imports": "error",
         "@typescript-eslint/explicit-function-return-type": [
           "error",
           {
@@ -228,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",
           {
@@ -246,12 +269,10 @@
           }
         ],
         "@typescript-eslint/no-base-to-string": "error",
+        "@typescript-eslint/no-deprecated": "error",
         "@typescript-eslint/no-dynamic-delete": "error",
-        "@typescript-eslint/no-empty-interface": [
-          "error",
-          { "allowSingleExtends": true }
-        ],
         "@typescript-eslint/no-extra-non-null-assertion": "error",
+        "@typescript-eslint/no-redundant-type-constituents": "error",
         "@typescript-eslint/no-extraneous-class": [
           "error",
           { "allowWithDecorator": true }
@@ -260,7 +281,6 @@
         "@typescript-eslint/no-for-in-array": "error",
         "@typescript-eslint/no-invalid-void-type": "error",
         "@typescript-eslint/no-misused-new": "error",
-        "@typescript-eslint/no-misused-promises": "error",
         "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
         "@typescript-eslint/no-non-null-assertion": "error",
         "@typescript-eslint/no-this-alias": [
@@ -269,34 +289,40 @@
         ],
         "@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",
+        "@typescript-eslint/prefer-find": "error",
         "@typescript-eslint/prefer-includes": "error",
         "@typescript-eslint/prefer-nullish-coalescing": [
           "error",
           {
+            "ignoreTernaryTests": true,
             "ignoreConditionalTests": false,
             "ignoreMixedLogicalExpressions": false
           }
         ],
-        "@typescript-eslint/prefer-optional-chain": "error",
         "@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",
         "@typescript-eslint/require-array-sort-compare": [
           "error",
           { "ignoreStringArrays": true }
         ],
         "@typescript-eslint/restrict-plus-operands": [
           "error",
-          { "checkCompoundAssignments": true }
+          { "skipCompoundAssignments": true }
         ],
         "@typescript-eslint/restrict-template-expressions": [
           "error",
           { "allowNumber": true }
         ],
-        "@typescript-eslint/return-await": ["error", "always"],
         "@typescript-eslint/strict-boolean-expressions": [
           "error",
           {
@@ -308,8 +334,7 @@
             "allowNullableNumber": false,
             "allowAny": false
           }
-        ],
+        ]
-        "@typescript-eslint/type-annotation-spacing": "error"
       }
     }
   ]

.github/ISSUE_TEMPLATE/BUG.md

@@ -1,8 +1,8 @@
 ---
-name: '🐛 Bug Report'
+name: "🐛 Bug Report"
-about: 'Report an unexpected problem or unintended behavior.'
+about: "Report an unexpected problem or unintended behavior."
-title: '[Bug]'
+title: "[Bug]"
-labels: 'bug'
+labels: "bug"
 ---
 
 <!--

.github/ISSUE_TEMPLATE/DOCUMENTATION.md

@@ -1,8 +1,8 @@
 ---
-name: '📜 Documentation'
+name: "📜 Documentation"
-about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).'
+about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)."
-title: '[Documentation]'
+title: "[Documentation]"
-labels: 'documentation'
+labels: "documentation"
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -1,8 +1,8 @@
 ---
-name: '✨ Feature Request'
+name: "✨ Feature Request"
-about: 'Suggest a new feature idea.'
+about: "Suggest a new feature idea."
-title: '[Feature]'
+title: "[Feature]"
-labels: 'feature request'
+labels: "feature request"
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->

.github/ISSUE_TEMPLATE/IMPROVEMENT.md

@@ -1,8 +1,8 @@
 ---
-name: '🔧 Improvement'
+name: "🔧 Improvement"
-about: 'Improve structure/format/performance/refactor/tests of the code.'
+about: "Improve structure/format/performance/refactor/tests of the code."
-title: '[Improvement]'
+title: "[Improvement]"
-labels: 'improvement'
+labels: "improvement"
 ---
 
 <!-- Please make sure your issue has not already been fixed. -->

.github/ISSUE_TEMPLATE/QUESTION.md

@@ -1,8 +1,8 @@
 ---
-name: '🙋 Question'
+name: "🙋 Question"
-about: 'Further information is requested.'
+about: "Further information is requested."
-title: '[Question]'
+title: "[Question]"
-labels: 'question'
+labels: "question"
 ---
 
 ### Question

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 <!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
 
-## What changes this PR introduce?
+# What changes this PR introduce?
 
 ## List any relevant issue numbers
 

.github/workflows/lint.yml

@@ -1,28 +1,34 @@
-name: 'Lint'
+name: "Lint"
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
-    branches: [master, develop]
+    branches: [main, develop]
 
 jobs:
   lint:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     steps:
-      - uses: 'actions/checkout@v2.4.0'
+      - uses: "actions/checkout@v4.1.7"
 
-      - name: 'Use Node.js'
+      - name: "Setup Node.js"
-        uses: 'actions/setup-node@v2.5.1'
+        uses: "actions/setup-node@v4.0.3"
         with:
-          node-version: 'lts/*'
+          node-version: "22.x"
-          cache: 'npm'
+          cache: "npm"
 
-      - name: 'Install'
+      - name: "Install dependencies"
-        run: 'npm install'
+        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:javascript'
+      - 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

@@ -1,29 +1,37 @@
-name: 'Release'
+name: "Release"
 
 on:
   push:
-    branches: [master]
+    branches: [main]
 
 jobs:
   release:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
+    permissions:
+      contents: "write"
+      issues: "write"
+      pull-requests: "write"
+      id-token: "write"
     steps:
-      - uses: 'actions/checkout@v2.4.0'
+      - uses: "actions/checkout@v4.1.7"
         with:
           fetch-depth: 0
           persist-credentials: false
 
-      - name: 'Use Node.js'
+      - name: "Setup Node.js"
-        uses: 'actions/setup-node@v2.5.1'
+        uses: "actions/setup-node@v4.0.3"
         with:
-          node-version: 'lts/*'
+          node-version: "22.x"
-          cache: 'npm'
+          cache: "npm"
 
-      - name: 'Install'
+      - name: "Install dependencies"
-        run: 'npm install'
+        run: "npm clean-install"
 
-      - name: 'Release'
+      - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
-        run: 'npm run release'
+        run: "npm audit signatures"
+
+      - name: "Release"
+        run: "node --run release"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -1,25 +1,25 @@
-name: 'Test'
+name: "Test"
 
 on:
   push:
-    branches: [master, develop]
+    branches: [develop]
   pull_request:
-    branches: [master, develop]
+    branches: [main, develop]
 
 jobs:
   test:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     steps:
-      - uses: 'actions/checkout@v2.4.0'
+      - uses: "actions/checkout@v4.1.7"
 
-      - name: 'Use Node.js'
+      - name: "Setup Node.js"
-        uses: 'actions/setup-node@v2.5.1'
+        uses: "actions/setup-node@v4.0.3"
         with:
-          node-version: 'lts/*'
+          node-version: "22.x"
-          cache: 'npm'
+          cache: "npm"
 
-      - name: 'Install'
+      - name: "Install dependencies"
-        run: 'npm install'
+        run: "npm clean-install"
 
-      - name: 'Test'
+      - name: "Test"
-        run: 'npm run test'
+        run: "node --run test"

.gitignore

@@ -4,6 +4,7 @@ node_modules
 
 # testing
 coverage
+.nyc_output
 
 # debug
 npm-debug.log*

.husky/commit-msg

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run lint:commit -- --edit

.husky/pre-commit

@@ -1,5 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run lint:staged
-npm run test

.lintstagedrc.json

@@ -1,6 +0,0 @@
-{
-  "*": ["editorconfig-checker"],
-  "*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
-  "*.{json,jsonc,yml,yaml}": ["prettier --write"],
-  "*.{md,mdx}": ["prettier --write", "markdownlint --dot --fix"]
-}

.markdownlint-cli2.jsonc

@@ -0,0 +1,11 @@
+{
+  "config": {
+    "extends": "markdownlint/style/prettier",
+    "default": true,
+    "relative-links": true,
+    "no-inline-html": false,
+  },
+  "globs": ["**/*.md"],
+  "ignores": ["**/node_modules"],
+  "customRules": ["markdownlint-rule-relative-links"],
+}

.markdownlint.json

@@ -1,6 +0,0 @@
-{
-  "default": true,
-  "MD013": false,
-  "MD033": false,
-  "MD041": false
-}

.npmrc

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

.prettierrc.json

@@ -1,6 +1,3 @@
 {
-  "singleQuote": true,
+  "semi": false
-  "jsxSingleQuote": true,
-  "semi": false,
-  "trailingComma": "none"
 }

.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": true
-  }
-}

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-contact@divlo.fr.
+<contact@theoludwig.fr>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

CONTRIBUTING.md

@@ -2,6 +2,14 @@
 
 Thanks a lot for your interest in contributing to **eslint-config-conventions**! 🎉
 
+## Code of Conduct
+
+**eslint-config-conventions** adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
+
+## Open Development
+
+All work on **eslint-config-conventions** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
+
 ## Types of contributions
 
 - Reporting a bug.
@@ -11,7 +19,7 @@ Thanks a lot for your interest in contributing to **eslint-config-conventions**!
 
 ## Pull Requests
 
-- **Please first discuss** the change you wish to make via [issue](https://github.com/Divlo/eslint-config-conventions/issues) before making a change. It might avoid a waste of your time.
+- **Please first discuss** the change you wish to make via [issue](https://github.com/theoludwig/eslint-config-conventions/issues) before making a change. It might avoid a waste of your time.
 
 - Ensure your code respect linting.
 
@@ -21,26 +29,4 @@ If you're adding new features to **eslint-config-conventions**, please include t
 
 ## Commits
 
-The commit message guidelines respect [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and [Semantic Versioning](https://semver.org/) for releases.
+The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
-
-### Types
-
-Types define which kind of changes you made to the project.
-
-| Types    | Description                                                                                                  |
-| -------- | ------------------------------------------------------------------------------------------------------------ |
-| feat     | A new feature.                                                                                               |
-| fix      | A bug fix.                                                                                                   |
-| docs     | Documentation only changes.                                                                                  |
-| style    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).      |
-| refactor | A code change that neither fixes a bug nor adds a feature.                                                   |
-| perf     | A code change that improves performance.                                                                     |
-| test     | Adding missing tests or correcting existing tests.                                                           |
-| build    | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).         |
-| ci       | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
-| chore    | Other changes that don't modify src or test files.                                                           |
-| revert   | Reverts a previous commit.                                                                                   |
-
-### Scopes
-
-Scopes define what part of the code changed.

LICENSE

@@ -1,6 +1,6 @@
-MIT License
+# MIT License
 
-Copyright (c) Divlo
+Copyright (c) Théo LUDWIG <contact@theoludwig.fr>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,15 +4,13 @@
   <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" /></a>
+  <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>
   <a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
   <br />
-  <a href="https://github.com/Divlo/eslint-config-conventions/actions/workflows/lint.yml"><img src="https://github.com/Divlo/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
+  <a href="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop" alt="lint action" /></a>
-  <a href="https://github.com/Divlo/eslint-config-conventions/actions/workflows/test.yml"><img src="https://github.com/Divlo/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
+  <a href="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop" alt="test action" /></a>
   <br />
   <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
   <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a>
@@ -21,9 +19,9 @@
 
 ## 📜 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/standard/eslint-config-standard-with-typescript) but it is **stricter** and with **no formatting rules**, **only code-quality rules**.
+**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 recommanded to use it with [Prettier](https://prettier.io/) for a consistent code style, it works with any `.prettierrc.json` configuration.
+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.
 
 More information about **formatting rules** vs **code-quality rules** can be found on [Prettier vs. Linters](https://prettier.io/docs/en/comparison.html).
 
@@ -31,75 +29,96 @@ More information about **formatting rules** vs **code-quality rules** can be fou
 
 ### Prerequisites
 
-- [Node.js](https://nodejs.org/) >= 16.0.0
+[Node.js](https://nodejs.org/) >= 18.0.0
 
 ### Installation
 
-`npm@<7` does not automatically install `peerDependencies`, so if that's what you're using, install them manually.
-Here is an example, but use it only for reference, because your decisions regarding version ranges and range specifiers may vary.
-
 ```sh
 npm install --save-dev \
-  eslint@^8.9.0 \
+  eslint@^8.57.0 \
-  eslint-plugin-import@^2.25.4 \
+  eslint-plugin-promise@^7.0.0 \
-  eslint-plugin-promise@^6.0.0 \
+  eslint-plugin-unicorn@^55.0.0 \
-  eslint-plugin-unicorn@^41.0.0 \
-  typescript@^4.4.0 \
-  @typescript-eslint/eslint-plugin@^5.12.0 \
   eslint-config-conventions@latest
 ```
 
-Yes, this is a large number of packages. This is due to [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458).
+Dependencies are:
-
-This list of 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)
-- [TypeScript](https://github.com/Microsoft/TypeScript)
-- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint); ESLint rules for TypeScript.
 - This package: `eslint-config-conventions`
 
-### Configuration with [Prettier](https://prettier.io/) (recommended)
+#### Installation with TypeScript
 
-You will need to install some dependencies in addition to those required:
+If you want to use **TypeScript**, you also need to install:
 
 ```sh
-npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier
+npm install --save-dev \
-
+  "typescript@~5.5.4" \
-# Create an empty config file to let editors and other tools know you are using Prettier
+  "@typescript-eslint/eslint-plugin@^8.3.0" \
-# You can personalize it with your own rules
+  "@typescript-eslint/parser@^8.3.0"
-echo {}> .prettierrc.json
 ```
 
-#### `.eslintrc.json`
+Dependencies are:
+
+- [TypeScript](https://github.com/Microsoft/TypeScript)
+- [@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
+
+#### `.eslintrc.json` (JavaScript)
 
 ```json
 {
-  "extends": ["conventions", "prettier"],
+  "root": true,
-  "plugins": ["prettier"],
+  "extends": ["conventions"],
-  "parserOptions": {
+  "plugins": ["promise", "unicorn"]
-    "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).
+#### `.eslintrc.json` (TypeScript)
 
-You must have a valid `tsconfig.json` file to specify `"parserOptions.project"`.
+```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
+
+# 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
+```
+
+That's all! No need to update the `.eslintrc.json` configuration.
+
+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.
 
 #### `package.json`
 
-```jsonc
+```json
 {
   "scripts": {
-    "lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
+    "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
-    "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\""
+    "lint:prettier": "prettier . --check"
   }
 }
 ```
@@ -107,12 +126,12 @@ You must have a valid `tsconfig.json` file to specify `"parserOptions.project"`.
 ### Usage
 
 ```sh
-npm run lint:typescript
+node --run lint:eslint
 # or to apply automatic fixes to code
-npm run lint:typescript -- --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

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

index.js

@@ -1 +1 @@
-module.exports = require('./.eslintrc.json')
+module.exports = require("./.eslintrc.json")

package.json

@@ -3,16 +3,16 @@
   "version": "0.0.0-development",
   "public": true,
   "description": "ESLint shareable config to enforce strict conventions and good code quality.",
-  "author": "Divlo <contact@divlo.fr>",
+  "author": "Théo LUDWIG <contact@theoludwig.fr>",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/Divlo/eslint-config-conventions.git"
+    "url": "https://github.com/theoludwig/eslint-config-conventions.git"
   },
   "bugs": {
-    "url": "https://github.com/Divlo/eslint-config-conventions/issues"
+    "url": "https://github.com/theoludwig/eslint-config-conventions/issues"
   },
-  "homepage": "https://github.com/Divlo/eslint-config-conventions#readme",
+  "homepage": "https://github.com/theoludwig/eslint-config-conventions#readme",
   "keywords": [
     "eslintconfig",
     "eslint",
@@ -23,50 +23,43 @@
     "conventions"
   ],
   "main": "index.js",
+  "files": [
+    "index.js",
+    ".eslintrc.json"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "engines": {
-    "node": ">=16.0.0",
+    "node": ">=18.0.0"
-    "npm": ">=8.0.0"
   },
   "scripts": {
-    "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
-    "lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"",
+    "lint:markdown": "markdownlint-cli2",
-    "lint:javascript": "eslint \"**/*.{js,jsx,ts,tsx}\"",
+    "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --config eslintrc.json",
-    "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
+    "lint:prettier": "prettier . --check",
-    "lint:staged": "lint-staged",
+    "test": "node --test",
-    "test": "tape \"test/**/*.js\"",
+    "release": "semantic-release"
-    "release": "semantic-release",
-    "postinstall": "husky install",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable"
   },
   "peerDependencies": {
-    "eslint": "^8.9.0",
+    "eslint": "^8.57.0",
-    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-promise": "^7.0.0",
-    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-unicorn": "^55.0.0"
-    "eslint-plugin-unicorn": "^41.0.0",
-    "typescript": "^4.4.0",
-    "@typescript-eslint/eslint-plugin": "^5.12.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "16.2.1",
+    "@types/eslint": "8.56.12",
-    "@commitlint/config-conventional": "16.2.1",
+    "@types/node": "22.7.4",
-    "editorconfig-checker": "4.0.2",
+    "@typescript-eslint/eslint-plugin": "8.7.0",
-    "eslint": "8.9.0",
+    "@typescript-eslint/parser": "8.7.0",
-    "@types/eslint": "8.4.1",
+    "editorconfig-checker": "6.0.0",
-    "eslint-plugin-import": "2.25.4",
+    "eslint": "8.57.1",
-    "eslint-plugin-promise": "6.0.0",
+    "eslint-plugin-promise": "7.1.0",
-    "eslint-plugin-unicorn": "41.0.0",
+    "eslint-plugin-unicorn": "55.0.0",
-    "typescript": "4.5.5",
+    "markdownlint-cli2": "0.14.0",
-    "@typescript-eslint/parser": "5.12.0",
+    "markdownlint-rule-relative-links": "3.0.0",
-    "@typescript-eslint/eslint-plugin": "5.12.0",
+    "prettier": "3.3.3",
-    "tape": "5.5.2",
+    "semantic-release": "23.1.1",
-    "husky": "7.0.4",
+    "typescript": "5.6.2"
-    "lint-staged": "12.3.4",
-    "markdownlint-cli": "0.31.1",
-    "@types/tape": "4.13.2",
-    "pinst": "2.1.6",
-    "prettier": "2.5.1",
-    "semantic-release": "19.0.2"
   }
 }

test/basic.js

@@ -1,15 +1,20 @@
-const test = require('tape')
+const test = require("node:test")
+const assert = require("node:assert/strict")
 
-const config = require('../index.js')
+const config = require("../index.js")
 
-test('test basic properties of config', function (t) {
+/**
-  t.ok(isObject(config.parserOptions))
+ * @param {unknown} object
-  t.ok(isObject(config.env))
+ * @returns {boolean}
-  t.ok(isObject(config.rules))
+ */
-  t.ok(isObject(config.overrides))
+const isObject = (object) => {
-  t.end()
+  return typeof object === "object" && object !== null
-})
-
-function isObject(object) {
-  return typeof object === 'object' && object !== null
 }
+
+test("test basic properties of config", async () => {
+  assert.ok(isObject(config))
+  assert.ok(isObject(config.parserOptions))
+  assert.ok(isObject(config.env))
+  assert.ok(isObject(config.rules))
+  assert.ok(isObject(config.overrides))
+})

test/fixtures/javascript-with-errors.js

@@ -1 +1 @@
-'invalid eqeqeq' == 'invalid eqeqeq'
+"invalid eqeqeq" == "invalid eqeqeq"

test/fixtures/top-level-await.mjs

@@ -1,3 +1,3 @@
 const foo = await 1
-const bar = function () {}
+const bar = () => {}
 await bar(foo)

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

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

test/validate-config.js

@@ -1,37 +1,81 @@
-const { ESLint } = require('eslint')
+const test = require("node:test")
-const test = require('tape')
+const assert = require("node:assert/strict")
 
-test('ensure we validate correctly JavaScript files', async (t) => {
+const { ESLint } = require("eslint")
-  const eslint = new ESLint({ ignore: false })
+
-  const [noErrors] = await eslint.lintFiles(
+const eslint = new ESLint({
-    'test/fixtures/javascript-no-errors.js'
+  ignore: false,
-  )
+  useEslintrc: false,
-  const [withErrors] = await eslint.lintFiles(
+  overrideConfigFile: "eslintrc.json",
-    'test/fixtures/javascript-with-errors.js'
-  )
-  t.equal(noErrors.errorCount, 0)
-  t.equal(withErrors.errorCount, 3)
-  t.end()
 })
 
-test('ensure we validate correctly TypeScript files', async (t) => {
+test("ensure we validate correctly JavaScript files", async () => {
-  const eslint = new ESLint({ ignore: false })
   const [noErrors] = await eslint.lintFiles(
-    'test/fixtures/typescript-no-errors.ts'
+    "test/fixtures/javascript-no-errors.js",
   )
   const [withErrors] = await eslint.lintFiles(
-    'test/fixtures/javascript-with-errors.js'
+    "test/fixtures/javascript-with-errors.js",
+  )
+  assert.strictEqual(noErrors?.errorCount, 0, JSON.stringify(noErrors, null, 2))
+  assert.strictEqual(
+    withErrors?.errorCount,
+    3,
+    JSON.stringify(withErrors, null, 2),
   )
-  t.equal(noErrors.errorCount, 0)
-  t.equal(withErrors.errorCount, 3)
-  t.end()
 })
 
-test('ensure we allow top-level await', async (t) => {
+test("ensure we do not use deprecated rules", async () => {
-  const eslint = new ESLint({ ignore: false })
+  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 () => {
+  const [noErrors] = await eslint.lintFiles(
+    "test/fixtures/typescript-no-errors.ts",
+  )
+  const [withErrors] = await eslint.lintFiles(
+    "test/fixtures/javascript-with-errors.js",
+  )
+  assert.strictEqual(noErrors?.errorCount, 0, JSON.stringify(noErrors, null, 2))
+  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'
+    "test/fixtures/top-level-await.mjs",
+  )
+  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),
   )
-  t.equal(lintResult.errorCount, 0)
-  t.end()
 })

tsconfig.json

@@ -1,12 +1,11 @@
 {
   "compilerOptions": {
+    "resolveJsonModule": true,
+    "strict": true,
     "target": "ESNext",
     "module": "commonjs",
     "lib": ["ESNext"],
     "moduleResolution": "node",
-    "rootDir": "./",
+    "rootDir": "./"
-    "strict": true,
-    "skipLibCheck": true,
-    "esModuleInterop": true
   }
 }