Merge branch 'next' into infra/github/merge_queue

Author: ST-DDT

eslint.config.ts

@@ -2,6 +2,7 @@ import { includeIgnoreFile } from '@eslint/compat';
 import eslint from '@eslint/js';
 import stylistic from '@stylistic/eslint-plugin';
 import eslintPluginVitest from '@vitest/eslint-plugin';
+import eslintPluginFileProgress from 'eslint-plugin-file-progress';
 import eslintPluginJsdoc from 'eslint-plugin-jsdoc';
 import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
 import eslintPluginUnicorn from 'eslint-plugin-unicorn';
@@ -17,6 +18,7 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
   //#region global
   includeIgnoreFile(gitignorePath),
   {
+    name: 'manual ignores',
     ignores: [
       // Skip some files that don't need linting right now
       '.github/workflows/commentCodeGeneration.ts',
@@ -28,6 +30,7 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
     ],
   },
   {
+    name: 'linter options',
     linterOptions: {
       reportUnusedDisableDirectives: 'error',
     },
@@ -37,6 +40,7 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
   //#region eslint (js)
   eslint.configs.recommended,
   {
+    name: 'eslint overrides',
     rules: {
       eqeqeq: ['error', 'always', { null: 'ignore' }],
       'logical-assignment-operators': 'error',
@@ -51,9 +55,7 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
   //#region typescript-eslint
   ...tseslint.configs.strictTypeChecked,
   {
-    plugins: {
-      '@typescript-eslint': tseslint.plugin,
-    },
+    name: 'typescript-eslint overrides',
     languageOptions: {
       parserOptions: {
         project: true,
@@ -128,6 +130,7 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
 
   //#region stylistic
   {
+    name: 'stylistic overrides',
     plugins: {
       '@stylistic': stylistic,
     },
@@ -143,6 +146,7 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
   //#region unicorn
   eslintPluginUnicorn.configs['flat/recommended'],
   {
+    name: 'unicorn overrides',
     rules: {
       'unicorn/import-style': 'off', // subjective & doesn't do anything for us
       'unicorn/no-array-callback-reference': 'off', // reduces readability
@@ -153,13 +157,13 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
       'unicorn/number-literal-case': 'off', // incompatible with prettier
       'unicorn/numeric-separators-style': 'off', // "magic numbers" may carry specific meaning
       'unicorn/prefer-string-raw': 'off', // The additional prefix doesn't help readability
+      'unicorn/prefer-string-slice': 'off', // string.substring is sometimes easier to use
       'unicorn/prefer-ternary': 'off', // ternaries aren't always better
 
       // 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/consistent-function-scoping': 'off',
       'unicorn/prefer-export-from': 'off',
-      'unicorn/prefer-string-slice': 'off',
       'unicorn/prevent-abbreviations': 'off',
     },
   },
@@ -168,6 +172,7 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
   //#region jsdoc
   eslintPluginJsdoc.configs['flat/recommended-typescript-error'],
   {
+    name: 'jsdoc overrides',
     rules: {
       'jsdoc/require-jsdoc': 'off', // Enabled only for src/**/*.ts
       'jsdoc/require-returns': 'off',
@@ -200,10 +205,15 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
 
   //#region prettier
   eslintPluginPrettierRecommended,
-  //#endregion,
+  //#endregion
+
+  //#region file-progress
+  eslintPluginFileProgress.configs.recommended,
+  //#endregion
 
   //#region overrides
   {
+    name: 'src/**/*.ts overrides',
     files: ['src/**/*.ts'],
     rules: {
       'no-undef': 'error', // Must override the config from typescript-eslint
@@ -215,12 +225,14 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
     },
   },
   {
+    name: 'src/locale/**/*.ts overrides',
     files: ['src/locale/**/*.ts'],
     rules: {
       'unicorn/filename-case': 'off', // our locale files have a custom naming scheme
     },
   },
   {
+    name: 'src/{definitions,locales}/**/*.ts overrides',
     files: ['src/definitions/**/*.ts', 'src/locales/**/*.ts'],
     rules: {
       'unicorn/filename-case': [
@@ -233,6 +245,7 @@ const config: ReturnType<typeof tseslint.config> = tseslint.config(
     },
   },
   {
+    name: 'test/**/*.ts overrides',
     files: ['test/**/*.spec.ts', 'test/**/*.spec.d.ts'],
     plugins: {
       vitest: eslintPluginVitest,

package.json

@@ -120,6 +120,7 @@
     "cypress": "13.15.1",
     "eslint": "9.14.0",
     "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-file-progress": "2.1.1",
     "eslint-plugin-jsdoc": "50.4.3",
     "eslint-plugin-prettier": "5.2.1",
     "eslint-plugin-unicorn": "56.0.0",