feat: Setup unit tests environment and improve linter (#29)

* feat: Add units tests architecture

* chore(deps): Add jest dependencies

* chore(linter): Add jest into eslint

* chore(linter): Add eslint-plugin-no-comments

* chore(linter): Add no-comments/disallowComments

* chore(linter): Fix jest

* chore(linter): Fix eslintPluginNoComments

* chore(linter): Set no-comments on warn

* chore(linter): Remove eslint-plugin-no-comments

* chore(linter): Add @typescript-eslint/consistent-type-imports

* fix(linter): Fix import types

* chore(tests): Add jest config

* chore(tests): Add test command

* chore(deps): Add ts-node dependency

* chore(tests): Fix jest config

* revert(deps): Remove ts-node dependency

* chore(ide): Identify tests folder

* chore(ide): Exclude lib folder

* chore(tests): Add ts aliases in jest config

* test: Create tests for GetAllUsersUseCase

* test: Create tests for UsersList

* chore(tests): Create a setup file for UI

* chore(tests): Create tsconfig.jest.json

* test: Fix users-list.test.tsx

Author: vbetsch

.idea/locklite.iml

@@ -28,10 +28,13 @@ lint: node_modules
 format: node_modules
 	npm run format
 
+tests: node_modules
+	npm run test
+
 migrate: up
 	npx prisma migrate dev --name init
 
-.PHONY: up down dev build lint format migrate
+.PHONY: up down dev build lint format tests migrate
 
 # Aliases
 run: up dev

Makefile

@@ -1,11 +1,11 @@
-// eslint.config.mjs
 import { dirname } from 'path';
 import { fileURLToPath } from 'url';
 import { FlatCompat } from '@eslint/eslintrc';
 import js from '@eslint/js';
 import tseslint from 'typescript-eslint';
 import eslintPluginPrettier from 'eslint-plugin-prettier';
 import importPlugin from 'eslint-plugin-import';
+import eslintPluginJest from 'eslint-plugin-jest';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -19,6 +19,7 @@ export default tseslint.config(
     js.configs.recommended,
     ...tseslint.configs.recommended,
     ...compat.extends('next/core-web-vitals', 'next/typescript'),
+    ...compat.extends('plugin:jest/recommended'),
 
     {
       ignores: ['node_modules', 'dist', 'jest.config.cjs'],
@@ -34,6 +35,7 @@ export default tseslint.config(
       plugins: {
         prettier: eslintPluginPrettier,
         import: importPlugin,
+        jest: eslintPluginJest,
       },
       rules: {
         // Formatting
@@ -50,6 +52,7 @@ export default tseslint.config(
         'prefer-const': ['error', { destructuring: 'all' }],
         'require-object-destructuring': 'off',
         'import/no-unresolved': 'error',
+        'no-inline-comments': 'warn',
 
         // TypeScript strictness
         '@typescript-eslint/explicit-member-accessibility': [
@@ -83,6 +86,10 @@ export default tseslint.config(
         '@typescript-eslint/class-literal-property-style': ['warn', 'fields'],
         '@typescript-eslint/no-empty-function': ['warn'],
         '@typescript-eslint/adjacent-overload-signatures': 'warn',
+        "@typescript-eslint/consistent-type-imports": ["error", {
+          "prefer": "type-imports",
+          "disallowTypeAnnotations": false
+        }],
 
         // Naming conventions
         '@typescript-eslint/naming-convention': [
@@ -125,6 +132,17 @@ export default tseslint.config(
         },
       },
     },
+
+    {
+      files: ['**/*.test.ts', '**/*.spec.ts', '**/*.test.tsx', '**/*.spec.tsx'],
+      plugins: { jest: eslintPluginJest },
+      languageOptions: {
+        env: { 'jest/globals': true },
+      },
+      settings: {
+        jest: { version: 29 },
+      },
+    },
   ],
   {
     files: ['**/*.ts', '**/*.tsx'],

eslint.config.mjs

@@ -0,0 +1,27 @@
+import type { Config } from 'jest';
+
+const config: Config = {
+  preset: 'ts-jest',
+  testEnvironment: 'jsdom',
+  setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
+  globals: {
+    'ts-jest': {
+      tsconfig: 'tsconfig.jest.json',
+    },
+  },
+  transform: {
+    '^.+\\.(ts|tsx)$': ['ts-jest', {}],
+  },
+  roots: ['<rootDir>'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  moduleNameMapper: {
+    '^@/(.*)$': '<rootDir>/$1',
+    '^@api/(.*)$': '<rootDir>/src/modules/api/$1',
+    '^@ui/(.*)$': '<rootDir>/src/modules/ui/$1',
+    '^@shared/(.*)$': '<rootDir>/src/modules/shared/$1',
+    '^@prisma/(.*)$': '<rootDir>/prisma/$1',
+    '^@lib/(.*)$': '<rootDir>/lib/$1',
+  },
+};
+
+export default config;

jest.config.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';