chore: linting (#7532)

* chore: linting * fix: broken tests * fix: formatting
immich-app · Feb 29, 2024 · af0de1a · af0de1a
1 parent 09a7291
commit af0de1a
Show file tree

Hide file tree

Showing 33 changed files with 2,633 additions and 701 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -16,4 +16,4 @@ max_line_length = off
 trim_trailing_whitespace = false
 
 [*.{yml,yaml}]
-quote_type = double
+quote_type = single
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -35,7 +35,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          submodules: "recursive"
+          submodules: 'recursive'
 
       - name: Run e2e tests
         run: make server-e2e-jobs
@@ -184,7 +184,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          submodules: "recursive"
+          submodules: 'recursive'
 
       - name: Setup Node
         uses: actions/setup-node@v4
@@ -194,25 +194,40 @@ jobs:
       - name: Run setup typescript-sdk
         run: npm ci && npm run build
         working-directory: ./open-api/typescript-sdk
+        if: ${{ !cancelled() }}
 
       - name: Run setup cli
         run: npm ci && npm run build
         working-directory: ./cli
+        if: ${{ !cancelled() }}
 
       - name: Install dependencies
         run: npm ci
+        if: ${{ !cancelled() }}
+
+      - name: Run linter
+        run: npm run lint
+        if: ${{ !cancelled() }}
+
+      - name: Run formatter
+        run: npm run format
+        if: ${{ !cancelled() }}
 
       - name: Install Playwright Browsers
         run: npx playwright install --with-deps chromium
+        if: ${{ !cancelled() }}
 
       - name: Docker build
         run: docker compose build
+        if: ${{ !cancelled() }}
 
       - name: Run e2e tests (api & cli)
         run: npm run test
+        if: ${{ !cancelled() }}
 
       - name: Run e2e tests (web)
         run: npx playwright test
+        if: ${{ !cancelled() }}
 
   mobile-unit-tests:
     name: Mobile
@@ -222,8 +237,8 @@ jobs:
       - name: Setup Flutter SDK
         uses: subosito/flutter-action@v2
         with:
-          channel: "stable"
-          flutter-version: "3.16.9"
+          channel: 'stable'
+          flutter-version: '3.16.9'
       - name: Run tests
         working-directory: ./mobile
         run: flutter test -j 1
@@ -241,7 +256,7 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: 3.11
-          cache: "poetry"
+          cache: 'poetry'
       - name: Install dependencies
         run: |
           poetry install --with dev --with cpu

diff --git a/docker/docker-compose.dev.yml b/docker/docker-compose.dev.yml
@@ -2,7 +2,7 @@
 # - https://immich.app/docs/developer/setup
 # - https://immich.app/docs/developer/troubleshooting
 
-version: "3.8"
+version: '3.8'
 
 name: immich-dev
 
@@ -30,7 +30,7 @@ x-server-build: &server-common
 services:
   immich-server:
     container_name: immich_server
-    command: [ "/usr/src/app/bin/immich-dev", "immich" ]
+    command: ['/usr/src/app/bin/immich-dev', 'immich']
     <<: *server-common
     ports:
       - 3001:3001
@@ -41,7 +41,7 @@ services:
 
   immich-microservices:
     container_name: immich_microservices
-    command: [ "/usr/src/app/bin/immich-dev", "microservices" ]
+    command: ['/usr/src/app/bin/immich-dev', 'microservices']
     <<: *server-common
     # extends:
     #   file: hwaccel.transcoding.yml
@@ -57,7 +57,7 @@ services:
     image: immich-web-dev:latest
     build:
       context: ../web
-    command: [ "/usr/src/app/bin/immich-web" ]
+    command: ['/usr/src/app/bin/immich-web']
     env_file:
       - .env
     ports:

diff --git a/docker/docker-compose.prod.yml b/docker/docker-compose.prod.yml
@@ -1,4 +1,4 @@
-version: "3.8"
+version: '3.8'
 
 name: immich-prod
 
@@ -17,7 +17,7 @@ x-server-build: &server-common
 services:
   immich-server:
     container_name: immich_server
-    command: [ "start.sh", "immich" ]
+    command: ['start.sh', 'immich']
     <<: *server-common
     ports:
       - 2283:3001
@@ -27,7 +27,7 @@ services:
 
   immich-microservices:
     container_name: immich_microservices
-    command: [ "start.sh", "microservices" ]
+    command: ['start.sh', 'microservices']
     <<: *server-common
     # extends:
     #   file: hwaccel.transcoding.yml

diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
@@ -1,4 +1,4 @@
-version: "3.8"
+version: '3.8'
 
 #
 # WARNING: Make sure to use the docker-compose.yml of the current release:
@@ -14,7 +14,7 @@ services:
   immich-server:
     container_name: immich_server
     image: ghcr.io/immich-app/immich-server:${IMMICH_VERSION:-release}
-    command: [ "start.sh", "immich" ]
+    command: ['start.sh', 'immich']
     volumes:
       - ${UPLOAD_LOCATION}:/usr/src/app/upload
       - /etc/localtime:/etc/localtime:ro
@@ -33,7 +33,7 @@ services:
     # extends: # uncomment this section for hardware acceleration - see https://immich.app/docs/features/hardware-transcoding
     #   file: hwaccel.transcoding.yml
     #   service: cpu # set to one of [nvenc, quicksync, rkmpp, vaapi, vaapi-wsl] for accelerated transcoding
-    command: [ "start.sh", "microservices" ]
+    command: ['start.sh', 'microservices']
     volumes:
       - ${UPLOAD_LOCATION}:/usr/src/app/upload
       - /etc/localtime:/etc/localtime:ro

diff --git a/e2e/.eslintrc.cjs b/e2e/.eslintrc.cjs
@@ -0,0 +1,31 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    sourceType: 'module',
+    tsconfigRootDir: __dirname,
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended', 'plugin:unicorn/recommended'],
+  root: true,
+  env: {
+    node: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-floating-promises': 'error',
+    'unicorn/prefer-module': 'off',
+    curly: 2,
+    'prettier/prettier': 0,
+    'unicorn/prevent-abbreviations': 'off',
+    'unicorn/filename-case': 'off',
+    'unicorn/no-null': 'off',
+    'unicorn/prefer-top-level-await': 'off',
+    'unicorn/prefer-event-target': 'off',
+    'unicorn/no-thenable': 'off',
+  },
+};
diff --git a/e2e/.prettierignore b/e2e/.prettierignore
@@ -0,0 +1,16 @@
+.DS_Store
+node_modules
+/build
+/package
+.env
+.env.*
+!.env.example
+*.md
+*.json
+coverage
+dist
+
+# Ignore files for PNPM, NPM and YARN
+pnpm-lock.yaml
+package-lock.json
+yarn.lock
diff --git a/e2e/.prettierrc b/e2e/.prettierrc
@@ -0,0 +1,8 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 120,
+  "semi": true,
+  "organizeImportsSkipDestructiveCodeActions": true,
+  "plugins": ["prettier-plugin-organize-imports"]
+}
diff --git a/e2e/docker-compose.yml b/e2e/docker-compose.yml
@@ -1,4 +1,4 @@
-version: "3.8"
+version: '3.8'
 
 name: immich-e2e
 
@@ -23,14 +23,14 @@ x-server-build: &server-common
 services:
   immich-server:
     container_name: immich-e2e-server
-    command: [ "./start.sh", "immich" ]
+    command: ['./start.sh', 'immich']
     <<: *server-common
     ports:
       - 2283:3001
 
   immich-microservices:
     container_name: immich-e2e-microservices
-    command: [ "./start.sh", "microservices" ]
+    command: ['./start.sh', 'microservices']
     <<: *server-common
 
   redis: