Merge branch 'next' into refactor/location/decouple-direction-data-index-from-representation-value

Author: ST-DDT

.eslintrc.js

@@ -15,62 +15,52 @@ module.exports = defineConfig({
   reportUnusedDisableDirectives: true,
   extends: [
     'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
     'plugin:@typescript-eslint/recommended-type-checked',
     'plugin:prettier/recommended',
+    'plugin:deprecation/recommended',
     'plugin:jsdoc/recommended-typescript-error',
     'plugin:unicorn/recommended',
   ],
-  parser: '@typescript-eslint/parser',
   parserOptions: {
     project: ['./tsconfig.json'],
-    sourceType: 'module',
     warnOnUnsupportedTypeScriptVersion: false,
   },
-  plugins: ['@typescript-eslint', 'prettier', 'deprecation', 'jsdoc'],
   rules: {
     eqeqeq: ['error', 'always', { null: 'ignore' }],
     'no-else-return': 'error',
-    'prefer-template': 'error',
     'no-restricted-globals': ['error', 'Intl'],
-
-    'deprecation/deprecation': 'error',
+    'prefer-template': 'error',
 
     'unicorn/no-nested-ternary': 'off', // incompatible with prettier
     'unicorn/no-null': 'off', // incompatible with TypeScript
+    'unicorn/no-zero-fractions': 'off', // deactivated to raise awareness of floating operations
     'unicorn/number-literal-case': 'off', // incompatible with prettier
+    'unicorn/prefer-ternary': 'off', // ternaries aren't always better
 
     // TODO @Shinigami92 2023-09-23: prefer-at should be turned on when we drop support for Node 14.
     'unicorn/prefer-at': 'off',
     // TODO @Shinigami92 2023-09-23: prefer-string-replace-all should be turned on when we drop support for Node 14.
     'unicorn/prefer-string-replace-all': 'off',
+    // TODO @ST-DDT 2023-10-28: The following rule should be turned on when we switch to esm.
+    'unicorn/prefer-top-level-await': 'off',
 
     // TODO @Shinigami92 2023-09-23: The following rules currently conflict with our code.
     // Each rule should be checked whether it should be enabled/configured and the problems fixed, or stay disabled permanently.
     'unicorn/better-regex': 'off',
     'unicorn/consistent-function-scoping': 'off',
-    'unicorn/filename-case': 'off',
     'unicorn/import-style': 'off',
     'unicorn/no-array-callback-reference': 'off',
     'unicorn/no-array-reduce': 'off',
     'unicorn/no-await-expression-member': 'off',
-    'unicorn/no-for-loop': 'off',
     'unicorn/no-negated-condition': 'off',
     'unicorn/no-object-as-default-parameter': 'off',
     'unicorn/no-useless-switch-case': 'off',
-    'unicorn/no-zero-fractions': 'off',
     'unicorn/numeric-separators-style': 'off',
-    'unicorn/prefer-array-some': 'off',
     'unicorn/prefer-code-point': 'off',
     'unicorn/prefer-export-from': 'off',
     'unicorn/prefer-module': 'off',
-    'unicorn/prefer-native-coercion-functions': 'off',
     'unicorn/prefer-negative-index': 'off',
-    'unicorn/prefer-number-properties': 'off',
-    'unicorn/prefer-optional-catch-binding': 'off',
     'unicorn/prefer-string-slice': 'off',
-    'unicorn/prefer-ternary': 'off',
-    'unicorn/prefer-top-level-await': 'off',
     'unicorn/prevent-abbreviations': 'off',
     'unicorn/require-array-join-separator': 'off',
     'unicorn/switch-case-braces': 'off',
@@ -101,11 +91,9 @@ module.exports = defineConfig({
       'error',
       { ignoreParameters: true },
     ],
-    '@typescript-eslint/no-unsafe-argument': 'error',
     '@typescript-eslint/no-unsafe-assignment': 'off',
     '@typescript-eslint/no-unsafe-call': 'off',
     '@typescript-eslint/no-unsafe-member-access': 'off',
-    '@typescript-eslint/no-unsafe-return': 'error',
     '@typescript-eslint/padding-line-between-statements': [
       'error',
       { blankLine: 'always', prev: 'block-like', next: '*' },
@@ -117,8 +105,7 @@ module.exports = defineConfig({
     ],
     '@typescript-eslint/unbound-method': 'off',
 
-    'jsdoc/no-types': 'error',
-    'jsdoc/require-jsdoc': 'off',
+    'jsdoc/require-jsdoc': 'off', // Enabled only for src/**/*.ts
     'jsdoc/require-returns': 'off',
     'jsdoc/sort-tags': [
       'error',
@@ -152,8 +139,26 @@ module.exports = defineConfig({
       },
     },
     {
-      files: ['src/locales/**/*.ts'],
+      files: ['src/locale/**/*.ts'],
       rules: {
+        'unicorn/filename-case': 'off', // our locale files have a custom naming scheme
+      },
+    },
+    {
+      files: ['src/definitions/**/*.ts', 'src/locales/**/*.ts'],
+      rules: {
+        'unicorn/filename-case': [
+          'error',
+          {
+            case: 'snakeCase',
+            // TODO @ST-DDT 2023-10-21: rename the definitions in v9
+            ignore: [
+              /chemicalElement\.ts$/,
+              /directoryPaths\.ts$/,
+              /mimeTypes\.ts$/,
+            ],
+          },
+        ],
         'unicorn/text-encoding-identifier-case': 'off',
       },
     },

.github/workflows/ci.yml

@@ -35,7 +35,7 @@ jobs:
     name: 'Build & Unit Test: node-${{ matrix.node_version }}, ${{ matrix.os }}'
     steps:
       - name: Checkout
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
         with:
           # Required for docs/versions tests
           fetch-depth: 0
@@ -51,7 +51,7 @@ jobs:
         uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
 
       - name: Set node version to ${{ matrix.node_version }}
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
         with:
           node-version: ${{ matrix.node_version }}
           cache: 'pnpm'
@@ -90,7 +90,7 @@ jobs:
         run: date
 
       - name: Checkout
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
         with:
           # Required for docs/versions tests
           fetch-depth: 0
@@ -99,7 +99,7 @@ jobs:
         uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
 
       - name: Set node version to ${{ matrix.node_version }}
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
         with:
           node-version: ${{ matrix.node_version }}
           cache: 'pnpm'
@@ -124,7 +124,7 @@ jobs:
     name: 'E2E Doc Test: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
 
       - name: Install pnpm
         uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
@@ -145,15 +145,15 @@ jobs:
     name: 'Lint: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
         with:
           fetch-depth: 0
 
       - name: Install pnpm
         uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
 
       - name: Set node version to 20
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
         with:
           node-version: 20
           cache: 'pnpm'
@@ -175,15 +175,15 @@ jobs:
     name: 'TS-Check: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
         with:
           fetch-depth: 0
 
       - name: Install pnpm
         uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
 
       - name: Set node version to 20
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
         with:
           node-version: 20
           cache: 'pnpm'
@@ -202,15 +202,15 @@ jobs:
     name: 'Codecov: node-20, ubuntu-latest'
     steps:
       - name: Checkout
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
         with:
           fetch-depth: 0
 
       - name: Install pnpm
         uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
 
       - name: Set node version to 20
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
         with:
           node-version: 20
           cache: 'pnpm'

.github/workflows/pr.yml

@@ -15,15 +15,15 @@ jobs:
       pull-requests: write
     steps:
       - name: Checkout
-        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
+        uses: actions/checkout@1e31de5234b9f8995739874a8ce0492dc87873e2 # v4.0.0
         with:
           fetch-depth: 0
 
       - name: Install pnpm
         uses: pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598 # v2.4.0
 
       - name: Set node version to 20
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
         with:
           node-version: 20
           cache: 'pnpm'

docs/guide/usage.md

@@ -168,7 +168,7 @@ interface User {
 }
 ```
 
-As you can see, your `User` model probably looks completely different from the one you have in your codebase.
+As you can see, our `User` model probably looks completely different from the one you have in your codebase.
 One thing to keep an eye on is the `subscriptionTier` property, as it is not simply a string, but only one of the strings defined in the `SubscriptionTier` type (`'free'` or `'basic'` or `'business'`).
 Also, in a real scenario, your model should not depend on a type of a third party library (`SexType` in this case).
 

package.json

@@ -63,7 +63,7 @@
     "build": "run-s build:clean build:code build:types",
     "generate": "run-s generate:locales generate:api-docs",
     "generate:api-docs": "tsx ./scripts/apidoc.ts",
-    "generate:locales": "tsx ./scripts/generateLocales.ts",
+    "generate:locales": "tsx ./scripts/generate-locales.ts",
     "docs:build": "run-s docs:prepare docs:build:run",
     "docs:build:run": "vitepress build docs",
     "docs:build:ci": "run-s build docs:build",
@@ -89,28 +89,28 @@
   "devDependencies": {
     "@actions/github": "~6.0.0",
     "@algolia/client-search": "~4.19.1",
-    "@types/markdown-it": "~13.0.2",
-    "@types/node": "~20.8.6",
-    "@types/sanitize-html": "~2.9.2",
-    "@types/semver": "~7.5.3",
-    "@types/validator": "~13.11.3",
-    "@typescript-eslint/eslint-plugin": "~6.7.5",
-    "@typescript-eslint/parser": "~6.7.5",
+    "@types/markdown-it": "~13.0.4",
+    "@types/node": "~20.8.7",
+    "@types/sanitize-html": "~2.9.3",
+    "@types/semver": "~7.5.4",
+    "@types/validator": "~13.11.5",
+    "@typescript-eslint/eslint-plugin": "~6.9.0",
+    "@typescript-eslint/parser": "~6.9.0",
     "@vitest/coverage-v8": "~0.34.6",
     "@vitest/ui": "~0.34.7",
     "@vueuse/core": "~10.5.0",
     "conventional-changelog-cli": "~4.1.0",
-    "cypress": "~13.3.1",
-    "esbuild": "~0.19.4",
-    "eslint": "~8.51.0",
+    "cypress": "~13.3.2",
+    "esbuild": "~0.19.5",
+    "eslint": "~8.52.0",
     "eslint-config-prettier": "~9.0.0",
     "eslint-define-config": "~1.24.1",
     "eslint-gitignore": "~0.1.0",
     "eslint-plugin-deprecation": "~2.0.0",
     "eslint-plugin-jsdoc": "~46.8.2",
     "eslint-plugin-prettier": "~5.0.1",
-    "eslint-plugin-unicorn": "~48.0.1",
-    "eslint-plugin-vitest": "~0.3.2",
+    "eslint-plugin-unicorn": "~49.0.0",
+    "eslint-plugin-vitest": "~0.3.8",
     "glob": "~10.3.10",
     "npm-run-all": "~4.1.5",
     "prettier": "3.0.3",
@@ -123,10 +123,10 @@
     "typedoc": "~0.24.8",
     "typescript": "~4.9.5",
     "validator": "~13.11.0",
-    "vite": "~4.4.11",
+    "vite": "~4.5.0",
     "vitepress": "1.0.0-beta.7",
     "vitest": "~0.34.6",
-    "vue": "~3.3.4"
+    "vue": "~3.3.6"
   },
   "packageManager": "pnpm@8.5.1",
   "engines": {