feat: Integrate CI with linter, tests with coverage, and build (#31)

* ci: Create CI

* ci: Refactor naming

* chore(tests): Define coverage

* chore: Add coverage command

* ci: Run only PR

* chore(ide): Exclude coverage dir

* chore(tests): Ignore lib and prisma folders in coverage

* refactor(make): Refactor tests command

* chore(tests): Fix jest config

* perf(tests): Refactor jest config

* test: Add tests for UserAdapter

* chore: Create format check

* chore(linter): Import plugin:prettier/recommended

* chore(deps): Install eslint-config-prettier

* chore(make): Remove npm run format:c

* chore(linter): Remove formatter from linter

* chore(make): Add format commands

* ci: Add formatter:prettier job

* revert: Test to import prettier in linter again

* fix(linter): Fix configuration

* fix: Clean

* fix(make): Fix format command

* style: Format files with Prettier

* fix: Fix linter issues

Author: vbetsch

.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - main
+      - develop
+
+jobs:
+  linter_eslint:
+    name: linter:eslint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run lint
+
+  tests_units:
+    name: tests:units
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run test:cov
+
+  build_app:
+    name: build:app
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build

.idea/locklite.iml

@@ -26,16 +26,21 @@ lint: node_modules
 	npm run lint
 
 format: node_modules
-	npm run format
+	npm run format:w
 
 tests: node_modules
-	npm run test
+	npm test
+
+coverage: node_modules
+	npm run test:cov
 
 migrate: up
 	npx prisma migrate dev --name init
 
-.PHONY: up down dev build lint format tests migrate
+.PHONY: up down dev build lint format tests coverage migrate
 
 # Aliases
 run: up dev
-.PHONY: run
+checks: lint
+checks_build: checks build
+.PHONY: run checks checks_build

Makefile

@@ -20,9 +20,10 @@ export default tseslint.config(
     ...tseslint.configs.recommended,
     ...compat.extends('next/core-web-vitals', 'next/typescript'),
     ...compat.extends('plugin:jest/recommended'),
+    ...compat.extends('plugin:prettier/recommended'),
 
     {
-      ignores: ['node_modules', 'dist', 'jest.config.cjs'],
+      ignores: ['*', '!src/**', '!tests/**'],
     },
 
     {
@@ -39,7 +40,7 @@ export default tseslint.config(
       },
       rules: {
         // Formatting
-        'prettier/prettier': ['error', { semi: true }],
+        'prettier/prettier': ['warn', { semi: true }],
         semi: ['error', 'always'],
         'max-len': ['warn', { code: 300, ignoreUrls: true }],
 
@@ -86,10 +87,13 @@ 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
-        }],
+        '@typescript-eslint/consistent-type-imports': [
+          'error',
+          {
+            prefer: 'type-imports',
+            disallowTypeAnnotations: false,
+          },
+        ],
 
         // Naming conventions
         '@typescript-eslint/naming-convention': [
@@ -136,9 +140,6 @@ 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 },
       },

eslint.config.mjs

@@ -3,16 +3,16 @@ import type { Config } from 'jest';
 const config: Config = {
   preset: 'ts-jest',
   testEnvironment: 'jsdom',
+  roots: ['<rootDir>/tests'],
   setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
-  globals: {
-    'ts-jest': {
-      tsconfig: 'tsconfig.jest.json',
-    },
-  },
   transform: {
-    '^.+\\.(ts|tsx)$': ['ts-jest', {}],
+    '^.+\\.(ts|tsx)$': [
+      'ts-jest',
+      {
+        tsconfig: 'tsconfig.jest.json',
+      },
+    ],
   },
-  roots: ['<rootDir>'],
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
   moduleNameMapper: {
     '^@/(.*)$': '<rootDir>/$1',
@@ -22,6 +22,16 @@ const config: Config = {
     '^@prisma/(.*)$': '<rootDir>/prisma/$1',
     '^@lib/(.*)$': '<rootDir>/lib/$1',
   },
+  testMatch: ['**/?(*.)+(spec|test).[tj]s?(x)'],
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 80,
+      lines: 80,
+      statements: 80,
+    },
+  },
+  coveragePathIgnorePatterns: ['<rootDir>/lib/', '<rootDir>/prisma/'],
 };
 
 export default config;