refactor: absolute imports with path alias (#2960) [skip ci]

.eslintrc.js

@@ -38,6 +38,10 @@ module.exports = {
         prefer: 'type-imports',
       },
     ],
+    'no-relative-import-paths/no-relative-import-paths': [
+      'error',
+      { allowSameFolder: true },
+    ],
   },
   overrides: [
     {
@@ -47,7 +51,7 @@ module.exports = {
       },
     },
   ],
-  plugins: ['jsx-a11y', 'react-hooks', 'formatjs'],
+  plugins: ['jsx-a11y', 'react-hooks', 'formatjs', 'no-relative-import-paths'],
   settings: {
     react: {
       pragma: 'React',

.vscode/settings.json

@@ -15,5 +15,6 @@
       "database": "./config/db/db.sqlite3"
     }
   ],
-  "editor.formatOnSave": true
+  "editor.formatOnSave": true,
+  "typescript.preferences.importModuleSpecifier": "non-relative"
 }

package.json

@@ -3,24 +3,24 @@
   "version": "0.1.0",
   "private": true,
   "scripts": {
-    "dev": "nodemon -e ts --watch server --watch overseerr-api.yml -e .json,.ts,.yml -x ts-node --files --project server/tsconfig.json server/index.ts",
-    "build:server": "tsc --project server/tsconfig.json && copyfiles -u 2 server/templates/**/*.{html,pug} dist/templates",
+    "dev": "nodemon -e ts --watch server --watch overseerr-api.yml -e .json,.ts,.yml -x ts-node -r tsconfig-paths/register --files --project server/tsconfig.json server/index.ts",
+    "build:server": "tsc --project server/tsconfig.json && copyfiles -u 2 server/templates/**/*.{html,pug} dist/templates && tsc-alias -p server/tsconfig.json",
     "build:next": "next build",
     "build": "yarn build:next && yarn build:server",
     "lint": "eslint \"./server/**/*.{ts,tsx}\" \"./src/**/*.{ts,tsx}\" --cache",
     "start": "NODE_ENV=production node dist/index.js",
     "i18n:extract": "extract-messages -l=en -o src/i18n/locale -d en --flat true --overwriteDefault true \"./src/**/!(*.test).{ts,tsx}\"",
-    "migration:generate": "ts-node --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:generate -d server/datasource.ts",
-    "migration:create": "ts-node --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:create -d server/datasource.ts",
-    "migration:run": "ts-node --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:run -d server/datasource.ts",
+    "migration:generate": "ts-node -r tsconfig-paths/register --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:generate -d server/datasource.ts",
+    "migration:create": "ts-node -r tsconfig-paths/register --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:create -d server/datasource.ts",
+    "migration:run": "ts-node -r tsconfig-paths/register --project server/tsconfig.json ./node_modules/typeorm/cli.js migration:run -d server/datasource.ts",
     "format": "prettier --loglevel warn --write --cache .",
     "format:check": "prettier --check --cache .",
     "typecheck": "yarn typecheck:server && yarn typecheck:client",
     "typecheck:server": "tsc --project server/tsconfig.json --noEmit",
     "typecheck:client": "tsc --noEmit",
     "prepare": "husky install",
     "cypress:open": "cypress open",
-    "cypress:prepare": "ts-node --files server/scripts/prepareTestDb.ts",
+    "cypress:prepare": "ts-node -r tsconfig-paths/register --files --project server/tsconfig.json server/scripts/prepareTestDb.ts",
     "cypress:build": "yarn build && yarn cypress:prepare"
   },
   "repository": {
@@ -139,6 +139,7 @@
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-formatjs": "4.1.0",
     "eslint-plugin-jsx-a11y": "6.6.1",
+    "eslint-plugin-no-relative-import-paths": "^1.4.0",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-react": "7.30.1",
     "eslint-plugin-react-hooks": "4.6.0",
@@ -154,6 +155,8 @@
     "semantic-release-docker-buildx": "1.0.1",
     "tailwindcss": "3.1.8",
     "ts-node": "10.9.1",
+    "tsc-alias": "^1.7.0",
+    "tsconfig-paths": "^4.1.0",
     "typescript": "4.7.4"
   },
   "resolutions": {

server/api/animelist.ts

@@ -1,8 +1,8 @@
+import logger from '@server/logger';
 import axios from 'axios';
 import fs, { promises as fsp } from 'fs';
 import path from 'path';
 import xml2js from 'xml2js';
-import logger from '../logger';
 
 const UPDATE_INTERVAL_MSEC = 24 * 3600 * 1000; // how often to download new mapping in milliseconds
 // originally at https://raw.githubusercontent.com/ScudLee/anime-lists/master/anime-list.xml

server/api/github.ts

@@ -1,5 +1,5 @@
-import cacheManager from '../lib/cache';
-import logger from '../logger';
+import cacheManager from '@server/lib/cache';
+import logger from '@server/logger';
 import ExternalAPI from './externalapi';
 
 interface GitHubRelease {

server/api/plexapi.ts

@@ -1,7 +1,7 @@
+import type { Library, PlexSettings } from '@server/lib/settings';
+import { getSettings } from '@server/lib/settings';
+import logger from '@server/logger';
 import NodePlexAPI from 'plex-api';
-import type { Library, PlexSettings } from '../lib/settings';
-import { getSettings } from '../lib/settings';
-import logger from '../logger';
 
 export interface PlexLibraryItem {
   ratingKey: string;

server/api/plextv.ts

@@ -1,8 +1,8 @@
+import type { PlexDevice } from '@server/interfaces/api/plexInterfaces';
+import cacheManager from '@server/lib/cache';
+import { getSettings } from '@server/lib/settings';
+import logger from '@server/logger';
 import xml2js from 'xml2js';
-import type { PlexDevice } from '../interfaces/api/plexInterfaces';
-import cacheManager from '../lib/cache';
-import { getSettings } from '../lib/settings';
-import logger from '../logger';
 import ExternalAPI from './externalapi';
 
 interface PlexAccountResponse {

server/api/rottentomatoes.ts

@@ -1,4 +1,4 @@
-import cacheManager from '../lib/cache';
+import cacheManager from '@server/lib/cache';
 import ExternalAPI from './externalapi';
 
 interface RTSearchResult {

server/api/servarr/base.ts

@@ -1,7 +1,7 @@
-import type { AvailableCacheIds } from '../../lib/cache';
-import cacheManager from '../../lib/cache';
-import type { DVRSettings } from '../../lib/settings';
-import ExternalAPI from '../externalapi';
+import ExternalAPI from '@server/api/externalapi';
+import type { AvailableCacheIds } from '@server/lib/cache';
+import cacheManager from '@server/lib/cache';
+import type { DVRSettings } from '@server/lib/settings';
 
 export interface SystemStatus {
   version: string;

server/api/servarr/radarr.ts

@@ -1,4 +1,4 @@
-import logger from '../../logger';
+import logger from '@server/logger';
 import ServarrBase from './base';
 
 export interface RadarrMovieOptions {

server/api/servarr/sonarr.ts

@@ -1,4 +1,4 @@
-import logger from '../../logger';
+import logger from '@server/logger';
 import ServarrBase from './base';
 
 interface SonarrSeason {

server/api/tautulli.ts

@@ -1,9 +1,9 @@
+import type { User } from '@server/entity/User';
+import type { TautulliSettings } from '@server/lib/settings';
+import logger from '@server/logger';
 import type { AxiosInstance } from 'axios';
 import axios from 'axios';
 import { uniqWith } from 'lodash';
-import type { User } from '../entity/User';
-import type { TautulliSettings } from '../lib/settings';
-import logger from '../logger';
 
 export interface TautulliHistoryRecord {
   date: number;

server/api/themoviedb/index.ts

@@ -1,6 +1,6 @@
+import ExternalAPI from '@server/api/externalapi';
+import cacheManager from '@server/lib/cache';
 import { sortBy } from 'lodash';
-import cacheManager from '../../lib/cache';
-import ExternalAPI from '../externalapi';
 import type {
   TmdbCollection,
   TmdbExternalIdResponse,

server/entity/Issue.ts

@@ -1,3 +1,5 @@
+import type { IssueType } from '@server/constants/issue';
+import { IssueStatus } from '@server/constants/issue';
 import {
   Column,
   CreateDateColumn,
@@ -7,8 +9,6 @@ import {
   PrimaryGeneratedColumn,
   UpdateDateColumn,
 } from 'typeorm';
-import type { IssueType } from '../constants/issue';
-import { IssueStatus } from '../constants/issue';
 import IssueComment from './IssueComment';
 import Media from './Media';
 import { User } from './User';

server/entity/Media.ts

@@ -1,3 +1,11 @@
+import RadarrAPI from '@server/api/servarr/radarr';
+import SonarrAPI from '@server/api/servarr/sonarr';
+import { MediaStatus, MediaType } from '@server/constants/media';
+import { getRepository } from '@server/datasource';
+import type { DownloadingItem } from '@server/lib/downloadtracker';
+import downloadTracker from '@server/lib/downloadtracker';
+import { getSettings } from '@server/lib/settings';
+import logger from '@server/logger';
 import {
   AfterLoad,
   Column,
@@ -9,14 +17,6 @@ import {
   PrimaryGeneratedColumn,
   UpdateDateColumn,
 } from 'typeorm';
-import RadarrAPI from '../api/servarr/radarr';
-import SonarrAPI from '../api/servarr/sonarr';
-import { MediaStatus, MediaType } from '../constants/media';
-import { getRepository } from '../datasource';
-import type { DownloadingItem } from '../lib/downloadtracker';
-import downloadTracker from '../lib/downloadtracker';
-import { getSettings } from '../lib/settings';
-import logger from '../logger';
 import Issue from './Issue';
 import { MediaRequest } from './MediaRequest';
 import Season from './Season';

server/entity/MediaRequest.ts

@@ -1,3 +1,23 @@
+import type { RadarrMovieOptions } from '@server/api/servarr/radarr';
+import RadarrAPI from '@server/api/servarr/radarr';
+import type {
+  AddSeriesOptions,
+  SonarrSeries,
+} from '@server/api/servarr/sonarr';
+import SonarrAPI from '@server/api/servarr/sonarr';
+import TheMovieDb from '@server/api/themoviedb';
+import { ANIME_KEYWORD_ID } from '@server/api/themoviedb/constants';
+import {
+  MediaRequestStatus,
+  MediaStatus,
+  MediaType,
+} from '@server/constants/media';
+import { getRepository } from '@server/datasource';
+import type { MediaRequestBody } from '@server/interfaces/api/requestInterfaces';
+import notificationManager, { Notification } from '@server/lib/notifications';
+import { Permission } from '@server/lib/permissions';
+import { getSettings } from '@server/lib/settings';
+import logger from '@server/logger';
 import { isEqual, truncate } from 'lodash';
 import {
   AfterInsert,
@@ -12,19 +32,6 @@ import {
   RelationCount,
   UpdateDateColumn,
 } from 'typeorm';
-import type { RadarrMovieOptions } from '../api/servarr/radarr';
-import RadarrAPI from '../api/servarr/radarr';
-import type { AddSeriesOptions, SonarrSeries } from '../api/servarr/sonarr';
-import SonarrAPI from '../api/servarr/sonarr';
-import TheMovieDb from '../api/themoviedb';
-import { ANIME_KEYWORD_ID } from '../api/themoviedb/constants';
-import { MediaRequestStatus, MediaStatus, MediaType } from '../constants/media';
-import { getRepository } from '../datasource';
-import type { MediaRequestBody } from '../interfaces/api/requestInterfaces';
-import notificationManager, { Notification } from '../lib/notifications';
-import { Permission } from '../lib/permissions';
-import { getSettings } from '../lib/settings';
-import logger from '../logger';
 import Media from './Media';
 import SeasonRequest from './SeasonRequest';
 import { User } from './User';

server/entity/Season.ts

@@ -1,3 +1,4 @@
+import { MediaStatus } from '@server/constants/media';
 import {
   Column,
   CreateDateColumn,
@@ -6,7 +7,6 @@ import {
   PrimaryGeneratedColumn,
   UpdateDateColumn,
 } from 'typeorm';
-import { MediaStatus } from '../constants/media';
 import Media from './Media';
 
 @Entity()

server/entity/SeasonRequest.ts

@@ -1,3 +1,4 @@
+import { MediaRequestStatus } from '@server/constants/media';
 import {
   Column,
   CreateDateColumn,
@@ -6,7 +7,6 @@ import {
   PrimaryGeneratedColumn,
   UpdateDateColumn,
 } from 'typeorm';
-import { MediaRequestStatus } from '../constants/media';
 import { MediaRequest } from './MediaRequest';
 
 @Entity()

server/entity/User.ts

@@ -1,3 +1,13 @@
+import { MediaRequestStatus, MediaType } from '@server/constants/media';
+import { UserType } from '@server/constants/user';
+import { getRepository } from '@server/datasource';
+import type { QuotaResponse } from '@server/interfaces/api/userInterfaces';
+import PreparedEmail from '@server/lib/email';
+import type { PermissionCheckOptions } from '@server/lib/permissions';
+import { hasPermission, Permission } from '@server/lib/permissions';
+import { getSettings } from '@server/lib/settings';
+import logger from '@server/logger';
+import { AfterDate } from '@server/utils/dateHelpers';
 import bcrypt from 'bcrypt';
 import { randomUUID } from 'crypto';
 import path from 'path';
@@ -14,16 +24,6 @@ import {
   RelationCount,
   UpdateDateColumn,
 } from 'typeorm';
-import { MediaRequestStatus, MediaType } from '../constants/media';
-import { UserType } from '../constants/user';
-import { getRepository } from '../datasource';
-import type { QuotaResponse } from '../interfaces/api/userInterfaces';
-import PreparedEmail from '../lib/email';
-import type { PermissionCheckOptions } from '../lib/permissions';
-import { hasPermission, Permission } from '../lib/permissions';
-import { getSettings } from '../lib/settings';
-import logger from '../logger';
-import { AfterDate } from '../utils/dateHelpers';
 import Issue from './Issue';
 import { MediaRequest } from './MediaRequest';
 import SeasonRequest from './SeasonRequest';

server/entity/UserSettings.ts

@@ -1,13 +1,13 @@
+import type { NotificationAgentTypes } from '@server/interfaces/api/userSettingsInterfaces';
+import { hasNotificationType, Notification } from '@server/lib/notifications';
+import { NotificationAgentKey } from '@server/lib/settings';
 import {
   Column,
   Entity,
   JoinColumn,
   OneToOne,
   PrimaryGeneratedColumn,
 } from 'typeorm';
-import type { NotificationAgentTypes } from '../interfaces/api/userSettingsInterfaces';
-import { hasNotificationType, Notification } from '../lib/notifications';
-import { NotificationAgentKey } from '../lib/settings';
 import { User } from './User';
 
 export const ALL_NOTIFICATIONS = Object.values(Notification)

server/index.ts

@@ -1,3 +1,24 @@
+import PlexAPI from '@server/api/plexapi';
+import dataSource, { getRepository } from '@server/datasource';
+import { Session } from '@server/entity/Session';
+import { User } from '@server/entity/User';
+import { startJobs } from '@server/job/schedule';
+import notificationManager from '@server/lib/notifications';
+import DiscordAgent from '@server/lib/notifications/agents/discord';
+import EmailAgent from '@server/lib/notifications/agents/email';
+import GotifyAgent from '@server/lib/notifications/agents/gotify';
+import LunaSeaAgent from '@server/lib/notifications/agents/lunasea';
+import PushbulletAgent from '@server/lib/notifications/agents/pushbullet';
+import PushoverAgent from '@server/lib/notifications/agents/pushover';
+import SlackAgent from '@server/lib/notifications/agents/slack';
+import TelegramAgent from '@server/lib/notifications/agents/telegram';
+import WebhookAgent from '@server/lib/notifications/agents/webhook';
+import WebPushAgent from '@server/lib/notifications/agents/webpush';
+import { getSettings } from '@server/lib/settings';
+import logger from '@server/logger';
+import routes from '@server/routes';
+import { getAppVersion } from '@server/utils/appVersion';
+import restartFlag from '@server/utils/restartFlag';
 import { getClientIp } from '@supercharge/request-ip';
 import { TypeormStore } from 'connect-typeorm/out';
 import cookieParser from 'cookie-parser';
@@ -11,27 +32,6 @@ import next from 'next';
 import path from 'path';
 import swaggerUi from 'swagger-ui-express';
 import YAML from 'yamljs';
-import PlexAPI from './api/plexapi';
-import dataSource, { getRepository } from './datasource';
-import { Session } from './entity/Session';
-import { User } from './entity/User';
-import { startJobs } from './job/schedule';
-import notificationManager from './lib/notifications';
-import DiscordAgent from './lib/notifications/agents/discord';
-import EmailAgent from './lib/notifications/agents/email';
-import GotifyAgent from './lib/notifications/agents/gotify';
-import LunaSeaAgent from './lib/notifications/agents/lunasea';
-import PushbulletAgent from './lib/notifications/agents/pushbullet';
-import PushoverAgent from './lib/notifications/agents/pushover';
-import SlackAgent from './lib/notifications/agents/slack';
-import TelegramAgent from './lib/notifications/agents/telegram';
-import WebhookAgent from './lib/notifications/agents/webhook';
-import WebPushAgent from './lib/notifications/agents/webpush';
-import { getSettings } from './lib/settings';
-import logger from './logger';
-import routes from './routes';
-import { getAppVersion } from './utils/appVersion';
-import restartFlag from './utils/restartFlag';
 
 const API_SPEC_PATH = path.join(__dirname, '../overseerr-api.yml');
 

server/interfaces/api/issueInterfaces.ts

@@ -1,4 +1,4 @@
-import type Issue from '../../entity/Issue';
+import type Issue from '@server/entity/Issue';
 import type { PaginatedResponse } from './common';
 
 export interface IssueResultsResponse extends PaginatedResponse {

server/interfaces/api/mediaInterfaces.ts

@@ -1,5 +1,5 @@
-import type Media from '../../entity/Media';
-import type { User } from '../../entity/User';
+import type Media from '@server/entity/Media';
+import type { User } from '@server/entity/User';
 import type { PaginatedResponse } from './common';
 
 export interface MediaResultsResponse extends PaginatedResponse {