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

Author: Ryan Cohen

.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 {