chore(server,cli,web): housekeeping and stricter code style

cli/.eslintrc.cjs

@@ -6,7 +6,7 @@ module.exports = {
     tsconfigRootDir: __dirname,
   },
   plugins: ['@typescript-eslint/eslint-plugin'],
-  extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
+  extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended', 'plugin:unicorn/recommended'],
   root: true,
   env: {
     node: true,
@@ -19,6 +19,14 @@ module.exports = {
     '@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': [
+      'error',
+      {
+        ignore: ['\\.e2e-spec$', /^ignore/i],
+      },
+    ],
   },
 };

cli/package.json

@@ -28,18 +28,18 @@
     "@types/cli-progress": "^3.11.0",
     "@types/mock-fs": "^4.13.1",
     "@types/node": "^20.3.1",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.4.1",
+    "@typescript-eslint/parser": "^6.4.1",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-unicorn": "^50.0.1",
     "@vitest/coverage-v8": "^1.2.2",
-    "eslint": "^8.43.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-unicorn": "^50.0.0",
     "immich": "file:../server",
     "mock-fs": "^5.2.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.3",
-    "typescript": "^5.0.0",
+    "typescript": "^5.3.3",
     "vitest": "^1.2.1"
   },
   "scripts": {

cli/src/commands/upload.command.ts

@@ -8,7 +8,7 @@ import { BaseCommand } from './base-command';
 import { basename } from 'node:path';
 import { access, constants, stat, unlink } from 'node:fs/promises';
 import { createHash } from 'node:crypto';
-import Os from 'os';
+import os from 'node:os';
 
 class Asset {
   readonly path: string;
@@ -27,25 +27,31 @@ class Asset {
 
   async prepare() {
     const stats = await stat(this.path);
-    this.deviceAssetId = `${basename(this.path)}-${stats.size}`.replace(/\s+/g, '');
+    this.deviceAssetId = `${basename(this.path)}-${stats.size}`.replaceAll(/\s+/g, '');
     this.fileCreatedAt = stats.mtime.toISOString();
     this.fileModifiedAt = stats.mtime.toISOString();
     this.fileSize = stats.size;
     this.albumName = this.extractAlbumName();
   }
 
   async getUploadFormData(): Promise<FormData> {
-    if (!this.deviceAssetId) throw new Error('Device asset id not set');
-    if (!this.fileCreatedAt) throw new Error('File created at not set');
-    if (!this.fileModifiedAt) throw new Error('File modified at not set');
+    if (!this.deviceAssetId) {
+      throw new Error('Device asset id not set');
+    }
+    if (!this.fileCreatedAt) {
+      throw new Error('File created at not set');
+    }
+    if (!this.fileModifiedAt) {
+      throw new Error('File modified at not set');
+    }
 
     // TODO: doesn't xmp replace the file extension? Will need investigation
     const sideCarPath = `${this.path}.xmp`;
     let sidecarData: ReadStream | undefined = undefined;
     try {
       await access(sideCarPath, constants.R_OK);
       sidecarData = createReadStream(sideCarPath);
-    } catch (error) {}
+    } catch {}
 
     const data: any = {
       assetData: createReadStream(this.path),
@@ -57,8 +63,8 @@ class Asset {
     };
     const formData = new FormData();
 
-    for (const prop in data) {
-      formData.append(prop, data[prop]);
+    for (const property in data) {
+      formData.append(property, data[property]);
     }
 
     if (sidecarData) {
@@ -86,12 +92,8 @@ class Asset {
     return await sha1(this.path);
   }
 
-  private extractAlbumName(): string {
-    if (Os.platform() === 'win32') {
-      return this.path.split('\\').slice(-2)[0];
-    } else {
-      return this.path.split('/').slice(-2)[0];
-    }
+  private extractAlbumName(): string | undefined {
+    return os.platform() === 'win32' ? this.path.split('\\').at(-2) : this.path.split('/').at(-2);
   }
 }
 
@@ -162,7 +164,8 @@ export class UploadCommand extends BaseCommand {
       }
     }
 
-    const existingAlbums = (await this.immichApi.albumApi.getAllAlbums()).data;
+    const allAlbums = await this.immichApi.albumApi.getAllAlbums();
+    const existingAlbums = allAlbums.data;
 
     uploadProgress.start(totalSize, 0);
     uploadProgress.update({ value_formatted: 0, total_formatted: byteSize(totalSize) });
@@ -195,32 +198,30 @@ export class UploadCommand extends BaseCommand {
           skipAsset = skipUpload && !isDuplicate;
         }
 
-        if (!skipAsset) {
-          if (!options.dryRun) {
-            if (!skipUpload) {
-              const formData = await asset.getUploadFormData();
-              const res = await this.uploadAsset(formData);
-              existingAssetId = res.data.id;
-              uploadCounter++;
-              totalSizeUploaded += asset.fileSize;
+        if (!skipAsset && !options.dryRun) {
+          if (!skipUpload) {
+            const formData = await asset.getUploadFormData();
+            const response = await this.uploadAsset(formData);
+            existingAssetId = response.data.id;
+            uploadCounter++;
+            totalSizeUploaded += asset.fileSize;
+          }
+
+          if ((options.album || options.albumName) && asset.albumName !== undefined) {
+            let album = existingAlbums.find((album) => album.albumName === asset.albumName);
+            if (!album) {
+              const response = await this.immichApi.albumApi.createAlbum({
+                createAlbumDto: { albumName: asset.albumName },
+              });
+              album = response.data;
+              existingAlbums.push(album);
             }
 
-            if ((options.album || options.albumName) && asset.albumName !== undefined) {
-              let album = existingAlbums.find((album) => album.albumName === asset.albumName);
-              if (!album) {
-                const res = await this.immichApi.albumApi.createAlbum({
-                  createAlbumDto: { albumName: asset.albumName },
-                });
-                album = res.data;
-                existingAlbums.push(album);
-              }
-
-              if (existingAssetId) {
-                await this.immichApi.albumApi.addAssetsToAlbum({
-                  id: album.id,
-                  bulkIdsDto: { ids: [existingAssetId] },
-                });
-              }
+            if (existingAssetId) {
+              await this.immichApi.albumApi.addAssetsToAlbum({
+                id: album.id,
+                bulkIdsDto: { ids: [existingAssetId] },
+              });
             }
           }
         }
@@ -233,12 +234,7 @@ export class UploadCommand extends BaseCommand {
       uploadProgress.stop();
     }
 
-    let messageStart;
-    if (options.dryRun) {
-      messageStart = 'Would have';
-    } else {
-      messageStart = 'Successfully';
-    }
+    const messageStart = options.dryRun ? 'Would have' : 'Successfully';
 
     if (uploadCounter === 0) {
       console.log('All assets were already uploaded, nothing to do.');
@@ -276,12 +272,11 @@ export class UploadCommand extends BaseCommand {
         'x-api-key': this.immichApi.apiKey,
         ...data.getHeaders(),
       },
-      maxContentLength: Infinity,
-      maxBodyLength: Infinity,
+      maxContentLength: Number.POSITIVE_INFINITY,
+      maxBodyLength: Number.POSITIVE_INFINITY,
       data,
     };
 
-    const res = await axios(config);
-    return res;
+    return await axios(config);
   }
 }

cli/src/index.ts

@@ -1,21 +1,21 @@
 #! /usr/bin/env node
 import { Command, Option } from 'commander';
 import path from 'node:path';
-import os from 'os';
+import os from 'node:os';
 import { version } from '../package.json';
 import { LoginCommand } from './commands/login';
 import { LogoutCommand } from './commands/logout.command';
 import { ServerInfoCommand } from './commands/server-info.command';
 import { UploadCommand } from './commands/upload.command';
 
-const userHomeDir = os.homedir();
-const configDir = path.join(userHomeDir, '.config/immich/');
+const homeDirectory = os.homedir();
+const configDirectory = path.join(homeDirectory, '.config/immich/');
 
 const program = new Command()
   .name('immich')
   .version(version)
   .description('Command line interface for Immich')
-  .addOption(new Option('-d, --config', 'Configuration directory').env('IMMICH_CONFIG_DIR').default(configDir));
+  .addOption(new Option('-d, --config', 'Configuration directory').env('IMMICH_CONFIG_DIR').default(configDirectory));
 
 program
   .command('upload')

cli/src/services/crawl.service.ts

@@ -1,5 +1,5 @@
 import { glob } from 'glob';
-import * as fs from 'fs';
+import * as fs from 'node:fs';
 
 export class CrawlOptions {
   pathsToCrawl!: string[];
@@ -12,14 +12,14 @@ export class CrawlService {
   private readonly extensions!: string[];
 
   constructor(image: string[], video: string[]) {
-    this.extensions = image.concat(video).map((extension) => extension.replace('.', ''));
+    this.extensions = [...image, ...video].map((extension) => extension.replace('.', ''));
   }
 
   async crawl(options: CrawlOptions): Promise<string[]> {
     const { recursive, pathsToCrawl, exclusionPatterns, includeHidden } = options;
 
     if (!pathsToCrawl) {
-      return Promise.resolve([]);
+      return [];
     }
 
     const patterns: string[] = [];
@@ -65,8 +65,6 @@ export class CrawlService {
       ignore: exclusionPatterns,
     });
 
-    const returnedFiles = crawledFiles.concat(globbedFiles);
-    returnedFiles.sort();
-    return returnedFiles;
+    return [...crawledFiles, ...globbedFiles].sort();
   }
 }