Chore/update eslint config (#48)

alexleboucher · web-flow · commit 8f6093d72213 · 2025-03-19T10:57:50.000+01:00
* Update eslint config to mjs

* Update tsconfig target to ES2022

* Upgraded @stylistic/eslint-plugin package

* Fix main tests workflow

* Fix typescript error
diff --git a/.github/workflows/main-tests.yml b/.github/workflows/main-tests.yml
@@ -13,6 +13,7 @@ env:
   TEST_DB_HOST: localhost
   TEST_DB_NAME: test_db
   TEST_DB_PORT: 5432
+  JWT_SECRET: secret
 
 jobs:
   e2e-tests:
diff --git a/eslint.config.js b/eslint.config.js
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,137 @@
+import importPlugin from 'eslint-plugin-import';
+import commentsPlugin from '@eslint-community/eslint-plugin-eslint-comments/configs';
+import stylistic from '@stylistic/eslint-plugin';
+import jseslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import globals from 'globals';
+
+export default tseslint.config(
+  {
+    ignores: ['build/*', 'src/infra/database/migrations/*', 'jest.config.ts', '**/tmp/**', '**/coverage/**', 'eslint.config.mjs'],
+  },
+  jseslint.configs.recommended,
+  tseslint.configs.recommended,
+  importPlugin.flatConfigs.recommended,
+  importPlugin.flatConfigs.typescript,
+  commentsPlugin.recommended,
+  {
+    files: ['**/*.ts', '**/*.mts'],
+    extends: [...tseslint.configs.recommended],
+    languageOptions: {
+      parser: tseslint.parser,
+      ecmaVersion: 2020,
+      sourceType: 'module',
+
+      globals: {
+        ...globals.node,
+      },
+
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    settings: {
+      'import/resolver': {
+        typescript: {
+          alwaysTryTypes: true,
+          project: './tsconfig.lint.json',
+        }
+      },
+    },
+    plugins: {
+      '@typescript-eslint': tseslint.plugin,
+      '@stylistic': stylistic,
+    },
+    rules: {
+      // General rules
+      "no-console": "warn",
+      "no-duplicate-imports": "off",
+      "camelcase": "warn",
+      "require-await": "off",
+      "arrow-body-style": ["warn", "as-needed"],
+      "eqeqeq": "error",
+      "object-shorthand": "warn",
+      "prefer-const": "warn",
+      "consistent-return": "error",
+  
+      // TypeScript rules
+      "@typescript-eslint/await-thenable": "error",
+      "@typescript-eslint/require-await": "error",
+      "@typescript-eslint/no-unnecessary-condition": "warn",
+      "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "req|res|next|err" }],
+      "@typescript-eslint/consistent-type-imports": ["warn", { "prefer": "type-imports" }],
+      "@typescript-eslint/no-floating-promises": "error",
+  
+      // Import rules
+      "import/default": "off",
+      "import/no-duplicates": ["error"],
+      "import/no-named-as-default-member": "off",
+      "import/order": [
+        "warn",
+        {
+          "groups": [
+            ["builtin", "external"],
+            ["internal", "index", "sibling", "parent", "object"]
+          ],
+          "newlines-between": "always-and-inside-groups"
+        }
+      ],
+  
+      // Comments rules
+      "@eslint-community/eslint-comments/no-unused-disable": "error",
+      "@eslint-community/eslint-comments/disable-enable-pair": ["error", { "allowWholeFile": true }],
+  
+      // Stylistic rules
+      "@stylistic/array-bracket-spacing": ["warn", "never"],
+      "@stylistic/array-element-newline": ["warn", "consistent"],
+      "@stylistic/arrow-spacing": "warn",
+      "@stylistic/block-spacing": "warn",
+      "@stylistic/brace-style": ["warn", "1tbs", { "allowSingleLine": true }],
+      "@stylistic/comma-spacing": ["warn", { "before": false, "after": true }],
+      "@stylistic/computed-property-spacing": ["warn", "never"],
+      "@stylistic/comma-style": ["warn", "last"],
+      "@stylistic/function-call-spacing": ["warn", "never"],
+      "@stylistic/function-call-argument-newline": ["warn", "consistent"],
+      "@stylistic/function-paren-newline": ["warn", "multiline-arguments"],
+      "@stylistic/indent": ['warn', 2],
+      "@stylistic/indent-binary-ops": ["warn", 2],
+      "@stylistic/key-spacing": "warn",
+      "@stylistic/keyword-spacing": "warn",
+      "@stylistic/member-delimiter-style": ["warn", {
+        "multiline": {
+            "delimiter": "semi",
+            "requireLast": true
+        },
+        "singleline": {
+            "delimiter": "semi",
+            "requireLast": false
+        }
+      }],
+      "@stylistic/new-parens": "warn",
+      "@stylistic/semi": "warn",
+      "@stylistic/no-extra-semi": "warn",
+      "@stylistic/no-floating-decimal": "warn",
+      "@stylistic/no-multi-spaces": "warn",
+      "@stylistic/no-multiple-empty-lines": "warn",
+      "@stylistic/no-trailing-spaces": "warn",
+      "@stylistic/no-whitespace-before-property": "warn",
+      "@stylistic/nonblock-statement-body-position": ["warn", "beside"],
+      "@stylistic/object-curly-spacing": ["warn", "always"],
+      "@stylistic/quote-props": ["warn", "as-needed"],
+      "@stylistic/quotes": ["warn", "single", { "avoidEscape": true }],
+      "@stylistic/rest-spread-spacing": "warn",
+      "@stylistic/semi-spacing": "warn",
+      "@stylistic/space-before-blocks": "warn",
+      "@stylistic/space-before-function-paren": ["warn", { "anonymous": "ignore", "named": "never", "asyncArrow": "always" }],
+      "@stylistic/space-in-parens": "warn",
+      "@stylistic/space-infix-ops": "warn",
+      "@stylistic/space-unary-ops": "warn",
+      "@stylistic/spaced-comment": "warn",
+      "@stylistic/switch-colon-spacing": "warn",
+      "@stylistic/template-curly-spacing": "warn",
+      "@stylistic/type-annotation-spacing": "warn",
+      "@stylistic/type-named-tuple-spacing": "warn",
+      "@stylistic/yield-star-spacing": ["error", "after"],
+    }
+  },
+);
diff --git a/package.json b/package.json
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "4.4.1",
     "@eslint/js": "9.22.0",
-    "@stylistic/eslint-plugin": "2.12.1",
+    "@stylistic/eslint-plugin": "4.2.0",
     "@types/bcryptjs": "3.0.0",
     "@types/cors": "2.8.17",
     "@types/express": "4.17.21",
diff --git a/src/core/result/result.ts b/src/core/result/result.ts
@@ -21,14 +21,14 @@ export class Result<TValue, TFailure extends { error: Error }> {
 }
 
 export class Success<T> extends Result<T, never> {
-  value!: T;
+  declare value: T;
   constructor(value: T) {
     super({ value });
   }
 }
 
 export class Failure<TFailure extends { error: Error }> extends Result<never, TFailure> {
-  failure!: TFailure;
+  declare failure: TFailure;
   constructor(failure: TFailure) {
     super({ failure });
   }
diff --git a/tsconfig.json b/tsconfig.json
@@ -6,8 +6,9 @@
   },
   "compilerOptions": {
     "types": ["node", "jest"],
-    "target": "ES2020",
-    "module": "commonjs",
+    "target": "ES2022",
+    "module": "CommonJS",
+    "lib": ["ES2022"],
     "moduleResolution": "node",
     "sourceMap": true,
     "outDir": "build",
diff --git a/yarn.lock b/yarn.lock
@@ -720,12 +720,12 @@
   resolved "https://registry.yarnpkg.com/@sqltools/formatter/-/formatter-1.2.5.tgz#3abc203c79b8c3e90fd6c156a0c62d5403520e12"
   integrity sha512-Uy0+khmZqUrUGm5dmMqVlnvufZRSK0FbYzVgp0UMstm+F5+W2/jnEEQyc9vo1ZR/E5ZI/B1WjjoTqBqwJL6Krw==
 
-"@stylistic/eslint-plugin@2.12.1":
-  version "2.12.1"
-  resolved "https://registry.yarnpkg.com/@stylistic/eslint-plugin/-/eslint-plugin-2.12.1.tgz#e341beb4e4315084d8be20bceeeda7d8a46f079f"
-  integrity sha512-fubZKIHSPuo07FgRTn6S4Nl0uXPRPYVNpyZzIDGfp7Fny6JjNus6kReLD7NI380JXi4HtUTSOZ34LBuNPO1XLQ==
+"@stylistic/eslint-plugin@4.2.0":
+  version "4.2.0"
+  resolved "https://registry.yarnpkg.com/@stylistic/eslint-plugin/-/eslint-plugin-4.2.0.tgz#7860ea84aa7ee3b21757907b863eb62f4f8b0455"
+  integrity sha512-8hXezgz7jexGHdo5WN6JBEIPHCSFyyU4vgbxevu4YLVS5vl+sxqAAGyXSzfNDyR6xMNSH5H1x67nsXcYMOHtZA==
   dependencies:
-    "@typescript-eslint/utils" "^8.13.0"
+    "@typescript-eslint/utils" "^8.23.0"
     eslint-visitor-keys "^4.2.0"
     espree "^10.3.0"
     estraverse "^5.3.0"
@@ -1054,7 +1054,7 @@
     semver "^7.6.0"
     ts-api-utils "^2.0.1"
 
-"@typescript-eslint/utils@8.26.1", "@typescript-eslint/utils@^8.13.0":
+"@typescript-eslint/utils@8.26.1", "@typescript-eslint/utils@^8.23.0":
   version "8.26.1"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/utils/-/utils-8.26.1.tgz#54cc58469955f25577f659753b71a0e117a0539f"
   integrity sha512-V4Urxa/XtSUroUrnI7q6yUTD3hDtfJ2jzVfeT3VK0ciizfK2q/zGC0iDh1lFMUZR8cImRrep6/q0xd/1ZGPQpg==

Original file line number	Diff line number	Diff line change
`@@ -21,14 +21,14 @@ export class Result<TValue, TFailure extends { error: Error }> {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`export class Success<T> extends Result<T, never> {`
`24`		`- value!: T;`
	`24`	`+ declare value: T;`
`25`	`25`	`constructor(value: T) {`
`26`	`26`	`super({ value });`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`export class Failure<TFailure extends { error: Error }> extends Result<never, TFailure> {`
`31`		`- failure!: TFailure;`
	`31`	`+ declare failure: TFailure;`
`32`	`32`	`constructor(failure: TFailure) {`
`33`	`33`	`super({ failure });`
`34`	`34`	`}`