Merge pull request #19398 from Nexus-Mods/feat/18921-cleanup-1

TSConfigs for project separation

Author: erri120

electron.vite.config.ts

@@ -33,7 +33,7 @@ export default defineConfig({
   preload: {
     build: {
       lib: {
-        entry: "./src/preload.ts"
+        entry: "./src/preload/index.ts"
       }
     }
   },

package.json

@@ -59,7 +59,7 @@
     "postinstall": "node postinstall.js",
     "install:debug": "cross-env VORTEX_BUILD_CONFIG=Debug yarn install",
     "test": "jest --no-cache",
-    "build": "yarn run check_packages && yarn run build_rest && tsc -p .",
+    "build": "yarn tsc -p src/shared/tsconfig.json && yarn run check_packages && yarn run build_rest && yarn tsc -p .",
     "buildwatch": "yarn run build_rest && tsc -p . --watch",
     "buildext": "node ./tools/buildScripts/buildSingleExtension.js",
     "gen": "yarn ts-to-zod --all",

src/main.ts

@@ -22,7 +22,7 @@ if (process.send) {
  * entry point for the main process
  */
 import os from "os";
-import { VORTEX_VERSION } from "./constants";
+import { VORTEX_VERSION } from "./shared/constants";
 process.env["UV_THREADPOOL_SIZE"] = (os.cpus().length * 2).toString();
 process.env["VORTEX_VERSION"] = VORTEX_VERSION;
 import "./util/application.electron";
@@ -82,7 +82,7 @@ if (!process.argv.includes('--relaunched')
 }
 */
 
-import { DEBUG_PORT, HTTP_HEADER_SIZE } from "./constants";
+import { DEBUG_PORT, HTTP_HEADER_SIZE } from "./shared/constants";
 
 import * as sourceMapSupport from "source-map-support";
 sourceMapSupport.install();

src/main/tsconfig.json

@@ -0,0 +1,12 @@
+{
+    "extends": "../../tsconfig.base.json",
+    "compilerOptions": {
+        "target": "esnext",
+        "module": "commonjs",
+        "moduleResolution": "node",
+
+        "rootDir": "../",
+        "outDir": "../../out"
+    },
+    "include": ["../main.ts", "**/*", "../shared/**/*"]
+}

src/preload.ts src/preload/index.tssrc/preload.ts renamed to src/preload/index.ts

@@ -0,0 +1,20 @@
+{
+    "extends": "../../tsconfig.base.json",
+    "compilerOptions": {
+        "target": "esnext",
+        "module": "commonjs",
+        "moduleResolution": "node",
+
+        "jsx": "react",
+
+        "rootDir": "../",
+        "outDir": "../../out"
+    },
+  "files": [
+    "../../typings.custom/index.d.ts",
+    "../index.ts",
+    "../renderer.tsx",
+    "../splash.ts",
+    "../extensions/index.ts"
+  ]
+}

src/renderer/tsconfig.json

@@ -1,3 +1,9 @@
 # Shared
 
 This directory contains code shared by the [main](../main/) and [renderer](../renderer/) process.
+
+## Rules
+
+- Only platform-agnostic npm packages allowed
+- No Node built-ins, Electron, or environment-specific libs
+- No imports from main / renderer / preload

src/shared/README.md

@@ -0,0 +1,17 @@
+{
+    // NOTE(erri120): this config only exists for your editor
+    "compilerOptions": {
+        "lib": ["ESNext"],
+        "types": [],
+
+        "strict": true,
+        "useUnknownInCatchVariables": true,
+        "noUncheckedIndexedAccess": true,
+        "noImplicitOverride": true,
+        "noUnusedParameters": true,
+        "noUnusedLocals": true,
+
+        "noEmit": true
+    },
+    "include": ["**/*"]
+}