Shared Linters (#288)

* feat: update to node 20 lts

* feat: add shared linters

* fix: rollback changes in docs due refactor

* fix: fix running tests on api

* fix: fix issue with starting api in dev mode

* feat: add ts-node config for tsconfig file

* fix: fix issue with importting

* feat: add .gitignore to eslint-config-custom package

* feat: update pnpm lock file to use ts

* feat: update to node v20 in web dockerfile

* fix: remove code for testing

template/.dockerignore

@@ -1,2 +1,27 @@
-node_modules
-*/**/node_modules
+# dependencies
+/node_modules
+
+# testing
+/coverage
+
+# production
+/dist
+
+# edtiors
+.idea
+.vscode
+
+# misc
+.DS_Store
+.dev
+.turbo
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# typescript
+*.tsbuildinfo

template/.gitignore

@@ -1,7 +1,27 @@
+# dependencies
+/node_modules
+
+# testing
+/coverage
+
+# production
+/dist
+
+# edtiors
 .idea
-.turbo
+.vscode
+
+# misc
 .DS_Store
 .dev
-/node_modules
-dist
-coverage
+.turbo
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# typescript
+*.tsbuildinfo

template/apps/api/.dockerignore

@@ -1 +1,23 @@
-node_modules
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/dist
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# typescript
+*.tsbuildinfo

template/apps/api/.eslintignore

@@ -1,2 +1,23 @@
-node_modules/*
-jest.config.ts
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/dist
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# typescript
+*.tsbuildinfo

template/apps/api/.eslintrc.js

@@ -1,61 +1,5 @@
-const { resolve } = require("path");
-
 module.exports = {
   root: true,
-  parser: "@typescript-eslint/parser",
-  plugins: ["@typescript-eslint", "import", "tsc"],
-  extends: [
-    "airbnb-typescript/base",
-    "plugin:@typescript-eslint/recommended",
-  ],
-  env: {
-    node: true,
-  },
-  parserOptions: {
-    ecmaVersion: 13,
-    sourceType: "module",
-    project: "./tsconfig.json",
-    // use tsconfig relative to eslintrc file for IDE
-    tsconfigRootDir: __dirname,
-  },
-  rules: {
-    'tsc/config': [2, {
-      configFile: resolve(__dirname, './tsconfig.json')
-    }],
-    'arrow-body-style': 0,
-    'no-underscore-dangle': 0,
-    'function-paren-newline': 1,
-    'import/no-extraneous-dependencies': ['error', {
-      devDependencies: [
-        '**/*.spec.{js,ts}',
-        '**/*.builder.{js,ts}',
-      ],
-    }],
-    'max-len': ['warn', {
-      code: 120,
-      ignoreStrings: true,
-      ignoreUrls: true,
-      ignoreTemplateLiterals: true,
-    }],
-  },
-  settings: {
-    "import/resolver": {
-      "node": {
-        "moduleDirectory": [
-          "src",
-          "node_modules"
-        ]
-      }
-    }
-  },
-  ignorePatterns: [
-    // ignore this file
-    ".eslintrc.js",
-    // never lint node modules
-    "node_modules",
-    // ignore prod_node_modules copied in Docker
-    "prod_node_modules",
-    // ignore output build files
-    "dist"
-  ],
+  extends: ['custom/node'],
+  ignorePatterns: ['jest.config.js'],
 };

template/apps/api/.gitignore

@@ -1,10 +1,28 @@
-node_modules
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/dist
+
+# misc
 .DS_Store
-npm-debug.log
-.idea
-.vscode
-./dist
+*.pem
 
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
 .env
 .env.*
 !.env.example
+
+# typescript
+*.tsbuildinfo

template/apps/api/.prettierignore

@@ -0,0 +1,23 @@
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/dist
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# typescript
+*.tsbuildinfo

template/apps/api/.prettierrc.json

@@ -0,0 +1 @@
+"prettier-config-custom"

template/apps/api/Dockerfile

@@ -1,5 +1,5 @@
 # BUILDER - Stage 1
-FROM node:18-alpine AS builder
+FROM node:20-alpine AS builder
 WORKDIR /app
 # Check /~https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk update && apk add --no-cache libc6-compat
@@ -8,7 +8,7 @@ COPY . .
 RUN turbo prune --scope=api --docker
 
 # INSTALLER - Stage 2
-FROM node:18-alpine AS installer
+FROM node:20-alpine AS installer
 WORKDIR /app
 # Check /~https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk update && apk add --no-cache libc6-compat
@@ -29,7 +29,7 @@ FROM installer AS development
 CMD pnpm turbo run dev --scope=api
 
 # RUNNER - Stage 4
-FROM node:18-alpine AS runner
+FROM node:20-alpine AS runner
 WORKDIR /app
 # Check /~https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk update && apk add --no-cache libc6-compat

template/apps/api/Dockerfile.migrator

@@ -1,5 +1,5 @@
 # BUILDER - Stage 1
-FROM node:18-alpine AS builder
+FROM node:20-alpine AS builder
 WORKDIR /app
 # Check /~https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk update && apk add --no-cache libc6-compat
@@ -8,7 +8,7 @@ COPY . .
 RUN turbo prune --scope=api --docker
 
 # INSTALLER - Stage 2
-FROM node:18-alpine AS installer
+FROM node:20-alpine AS installer
 WORKDIR /app
 # Check /~https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk update && apk add --no-cache libc6-compat
@@ -29,7 +29,7 @@ FROM installer AS development
 CMD pnpm turbo run api#migrate-dev --scope=api
 
 # RUNNER - Stage 4
-FROM node:18-alpine AS runner
+FROM node:20-alpine AS runner
 WORKDIR /app
 # Check /~https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk update && apk add --no-cache libc6-compat

template/apps/api/Dockerfile.scheduler

@@ -1,5 +1,5 @@
 # BUILDER - Stage 1
-FROM node:18-alpine AS builder
+FROM node:20-alpine AS builder
 WORKDIR /app
 # Check /~https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk update && apk add --no-cache libc6-compat
@@ -8,7 +8,7 @@ COPY . .
 RUN turbo prune --scope=api --docker
 
 # INSTALLER - Stage 2
-FROM node:18-alpine AS installer
+FROM node:20-alpine AS installer
 WORKDIR /app
 # Check /~https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk update && apk add --no-cache libc6-compat
@@ -29,7 +29,7 @@ FROM installer AS development
 CMD pnpm turbo run dev --scope=api
 
 # RUNNER - Stage 4
-FROM node:18-alpine AS runner
+FROM node:20-alpine AS runner
 WORKDIR /app
 # Check /~https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
 RUN apk update && apk add --no-cache libc6-compat

template/apps/api/README.md

@@ -26,14 +26,12 @@ docker-compose up --build
 
 To start the project not in the docker container just run: `npm run dev`. This command will start the application on port `3001` and will automatically restart whenever you change any file in `./src` directory.
 
-
 ### Important notes
 
-You need to set ```APP_ENV``` variable in build args in a place where you deploy application. It is responsible for the config file from ```environment``` folder that will be taken when building your application
-
+You need to set `APP_ENV` variable in build args in a place where you deploy application. It is responsible for the config file from `environment` folder that will be taken when building your application
 
-| APP_ENV       | File          |
-| ------------- | ------------- |
-| development   | development.json  |
-| staging       | staging.json  |
-| production    | production.json  |
+| APP_ENV     | File             |
+| ----------- | ---------------- |
+| development | development.json |
+| staging     | staging.json     |
+| production  | production.json  |

template/apps/api/jest.config.ts → template/apps/api/jest.config.js

@@ -1,12 +1,9 @@
-import type { JestConfigWithTsJest } from 'ts-jest';
-
-const config: JestConfigWithTsJest = {
+/** @type {import('jest').Config} */
+const config = {
   preset: '@shelf/jest-mongodb',
   verbose: true,
   testEnvironment: 'node',
-  testMatch: [
-    '**/?(*.)+(spec.ts)',
-  ],
+  testMatch: ['**/?(*.)+(spec.ts)'],
   transform: {
     '^.+\\.(ts)$': 'ts-jest',
   },
@@ -17,4 +14,4 @@ const config: JestConfigWithTsJest = {
   testTimeout: 10000,
 };
 
-export default config;
+module.exports = config;