refactor: re-write everything to a new file structure

notwindstone · notwindstone · commit cfc88bc4c71b · 2025-11-30T14:58:14.000+03:00
diff --git a/src/components/general/extensions/ExtensionLoader.vue b/src/components/general/extensions/ExtensionLoader.vue
@@ -18,9 +18,6 @@ const knownExtensions = ref<Array<ExtensionMetadataType>>([]);
 const unknownExtensions = ref<Array<ExtensionInfoType>>([]);
 
 onMounted(async () => {
-  log.debug("Initializing extensions loader");
-  await ExtensionsManager.initializeDirectory();
-
   log.debug("Getting all stored extensions");
   const extensions: Array<ExtensionInfoType> = await ExtensionsManager.readAllExtensions();
 
diff --git a/src/components/general/misc/ConfigSyncer.vue b/src/components/general/misc/ConfigSyncer.vue
@@ -4,11 +4,16 @@ import { useIntervalFn } from "@vueuse/core";
 import { inject, ref, watchEffect } from "vue";
 
 import { ApplicationNamespace, GlobalStatesContextKey } from "@/constants/application.ts";
+import { FileStructure } from "@/constants/file-structure.ts";
 import Configs from "@/lib/configs";
 import Errors from "@/lib/errors";
+import General from "@/lib/general";
 import GlobalStateHelpers from "@/lib/global-state-helpers";
 import { log } from "@/lib/logging/scopes/log.ts";
-import type { ContextGlobalStatesType } from "@/types/application/global-states.type.ts";
+import type {
+  ContextGlobalStatesType,
+  GlobalStatesType,
+} from "@/types/application/global-states.type.ts";
 import type { ConfigType } from "@/types/configs/config.type.ts";
 
 const globalStates = inject<ContextGlobalStatesType>(GlobalStatesContextKey);
@@ -21,31 +26,38 @@ async function handleConfigSync(): Promise<void> {
   syncing.value = true;
 
   log.debug("Getting current global states");
-  const currentGlobalStates = GlobalStateHelpers.get();
-  const configPath = currentGlobalStates.fileSystem?.files?.config;
-
-  if (!configPath)  {
-    log.warn("No config path was found in global states. Aborting config sync");
-    syncing.value = false;
-
-    return;
-  }
+  const currentGlobalStatesDetached: ConfigType & Partial<GlobalStatesType> = {
+    // Spread the global states to re-create one-level deep properties
+    ...GlobalStateHelpers.get(),
+  };
+  const configPath = General.cachedJoin(
+    General.getCachedBaseDirectory(),
+    FileStructure.Files.Config,
+  );
 
   log.debug("Getting current user config");
   const config = await Configs.getSafe();
 
+  // Remove all non-config properties
+  delete currentGlobalStatesDetached.translations;
+  delete currentGlobalStatesDetached.sidebarItems;
+  delete currentGlobalStatesDetached.contextMenuItems;
+  delete currentGlobalStatesDetached.pages;
+
   log.debug("Creating a 'ConfigType' typed object with the global states contents");
   const configOnlyGlobalStates: ConfigType = {
+    // Spread the global states since there might be additional properties by extensions
+    ...globalStates,
     // Arrange these properties in a way that the config itself arranges them
-    "development": currentGlobalStates.development,
-    "extensions" : currentGlobalStates.extensions,
-    "layout"     : currentGlobalStates.layout,
+    "development": currentGlobalStatesDetached.development,
+    "extensions" : currentGlobalStatesDetached.extensions,
+    "layout"     : currentGlobalStatesDetached.layout,
     "logs"       : {
-      ...currentGlobalStates.logs,
+      ...currentGlobalStatesDetached.logs,
       "show": false,
     },
-    "minecraft": currentGlobalStates.minecraft,
-    "misc"     : currentGlobalStates.misc,
+    "minecraft": currentGlobalStatesDetached.minecraft,
+    "misc"     : currentGlobalStatesDetached.misc,
   };
   const stringyConfig = JSON.stringify(config);
   const stringyGlobalStates = JSON.stringify(configOnlyGlobalStates);
diff --git a/src/components/logging/LogViewer.vue b/src/components/logging/LogViewer.vue
@@ -9,6 +9,8 @@ import LogControls from "@/components/logging/controls/LogControls.vue";
 import LogEntry from "@/components/logging/lines/LogEntry.vue";
 import NonVirtualizedLogs from "@/components/logging/NonVirtualizedLogs.vue";
 import { ApplicationNamespace, GlobalStatesContextKey } from "@/constants/application.ts";
+import { FileStructure } from "@/constants/file-structure.ts";
+import General from "@/lib/general";
 import GlobalStateHelpers from "@/lib/global-state-helpers";
 import { log } from "@/lib/logging/scopes/log.ts";
 import type { ContextGlobalStatesType } from "@/types/application/global-states.type.ts";
@@ -157,17 +159,14 @@ onMounted(async () => {
   mountedKey.value = Math.random();
 
   log.debug("LogViewer.vue mounted");
-  log.debug("Getting 'latest.log' file path");
-  const latestLogPath: string | undefined = globalStates?.fileSystem?.files?.log;
-
-  if (!latestLogPath) {
-    log.warn("'latest.log' file path is missing");
-
-    return;
-  }
+  const latestLogAbsolutePath = General.cachedJoin(
+    General.getCachedBaseDirectory(),
+    FileStructure.Folders.Logs.Path,
+    FileStructure.Folders.Logs.Files.LatestLog,
+  );
 
   log.debug("Reading 'latest.log' file");
-  const existingLogs: string = await readTextFile(latestLogPath);
+  const existingLogs: string = await readTextFile(latestLogAbsolutePath);
 
   if (existingLogs === "") {
     log.warn("Log file is empty");
diff --git a/src/components/logging/controls/LogControls.vue b/src/components/logging/controls/LogControls.vue
@@ -6,6 +6,8 @@ import { computed, ref, shallowRef, watchEffect } from "vue";
 import CustomButton from "@/components/general/base/CustomButton.vue";
 import LogFilterer from "@/components/logging/controls/LogFilterer.vue";
 import LogSearcher from "@/components/logging/controls/LogSearcher.vue";
+import { FileStructure } from "@/constants/file-structure.ts";
+import General from "@/lib/general";
 import GlobalStateHelpers from "@/lib/global-state-helpers";
 import Logging from "@/lib/logging";
 import type { LogButtonType } from "@/types/logging/log-button.type.ts";
@@ -72,11 +74,11 @@ async function copyTextSelection(): Promise<void> {
   );
 }
 async function viewInExplorer(): Promise<void> {
-  const latestLogAbsolutePath = GlobalStateHelpers.get().fileSystem?.files?.log;
-
-  if (!latestLogAbsolutePath) {
-    return;
-  }
+  const latestLogAbsolutePath = General.cachedJoin(
+    General.getCachedBaseDirectory(),
+    FileStructure.Folders.Logs.Path,
+    FileStructure.Folders.Logs.Files.LatestLog,
+  );
 
   await revealItemInDir(latestLogAbsolutePath);
 }
diff --git a/src/constants/application.ts b/src/constants/application.ts
@@ -1,7 +1,9 @@
 import { BaseDirectory } from "@tauri-apps/plugin-fs";
 import { revealItemInDir } from "@tauri-apps/plugin-opener";
 
+import { FileStructure } from "@/constants/file-structure.ts";
 import Errors from "@/lib/errors";
+import General from "@/lib/general";
 import GlobalStateHelpers from "@/lib/global-state-helpers";
 import { log } from "@/lib/logging/scopes/log.ts";
 
@@ -33,7 +35,10 @@ export const ContextMenuItems = [
     "action": (): void => {
       window[ApplicationNamespace].libs.ContextMenu.close();
       revealItemInDir(
-        GlobalStateHelpers.get().fileSystem?.files?.config ?? "",
+        General.cachedJoin(
+          General.getCachedBaseDirectory(),
+          FileStructure.Files.Config,
+        ),
       ).catch((error: unknown) => {
         log.error("Failed to reveal the config file in the explorer:", Errors.prettify(error));
       });
diff --git a/src/constants/hooks.ts b/src/constants/hooks.ts
@@ -1,6 +1,5 @@
 export const HookMappings = {
   "translations"    : "onTranslationsChange",
-  "fileSystem"      : "onFileSystemChange",
   "layout"          : "onLayoutChange",
   "pages"           : "onPagesChange",
   "logs"            : "onLogsChange",
diff --git a/src/declarations.ts b/src/declarations.ts
@@ -329,41 +329,6 @@ declare global {
           "after": HookReturnType<TranslationsType, "nothing">;
         };
 
-        /**
-         * Executed on the 'fileSystem' field replacement in global states
-         */
-        "onFileSystemChange": {
-
-          /**
-           * Executes 'sync'-only functions before the 'fileSystem' property
-           * in the global states will change.
-           *
-           * 'GlobalStatesType["fileSystem"]' typed object is passed as the argument.
-           *
-           * If the hook returns a 'stop' status,
-           * it should also return a 'GlobalStatesType["fileSystem"]' typed object
-           * in the 'response' field.
-           *
-           * If the hook returns a 'continue' status,
-           * code execution will continue as if that hook did not exist.
-           */
-          "before": HookReturnType<
-            GlobalStatesType["fileSystem"],
-            GlobalStatesType["fileSystem"],
-            "non-promise"
-          >;
-
-          /**
-           * Executes 'async' or 'sync' functions on the next Vue tick,
-           * after the 'fileSystem' property in the global states has changed.
-           *
-           * 'GlobalStatesType["fileSystem"]' typed object is passed as the argument.
-           *
-           * Hook should not return anything since the response will not be read.
-           */
-          "after": HookReturnType<GlobalStatesType["fileSystem"], "nothing">;
-        };
-
         /**
          * Executed on the 'layout' field replacement in global states
          */
diff --git a/src/lib/configs/scopes/get-config-file.ts b/src/lib/configs/scopes/get-config-file.ts
@@ -23,7 +23,7 @@ export async function getConfigFile(passedBaseDirectory?: string): Promise<Confi
     baseDirectory = await General.getBaseDirectory(portable);
   }
 
-  const configFileDirectory = General.cachedJoin(baseDirectory, FileStructure.Config.Name);
+  const configFileDirectory = General.cachedJoin(baseDirectory, FileStructure.Files.Config);
 
   log.debug(log.templates.hooks.iterate.start(
     "getConfigFile",
@@ -61,7 +61,7 @@ export async function getConfigFile(passedBaseDirectory?: string): Promise<Confi
   const configExists = await exists(configFileDirectory);
 
   if (!configExists) {
-    log.info("Config file does not exist");
+    log.warn("Config file does not exist");
     log.debug("Initializing a config file");
     await initializeConfigFile(configFileDirectory);
 
diff --git a/src/lib/extensions-manager/index.ts b/src/lib/extensions-manager/index.ts
@@ -4,7 +4,6 @@ import {
 } from "@/lib/extensions-manager/scopes/grant-static-permissions.ts";
 import { handleCssTheme } from "@/lib/extensions-manager/scopes/handle-css-theme.ts";
 import { handlePermission } from "@/lib/extensions-manager/scopes/handle-permission.ts";
-import { initializeDirectory } from "@/lib/extensions-manager/scopes/initialize-directory.ts";
 import { lockdownEnvironment } from "@/lib/extensions-manager/scopes/lockdown-environment.ts";
 import { readAllExtensions } from "@/lib/extensions-manager/scopes/read-all-extensions.ts";
 import { readAllMetadata } from "@/lib/extensions-manager/scopes/read-all-metadata.ts";
@@ -23,7 +22,6 @@ export default {
   grantStaticPermissions,
   handleCssTheme,
   handlePermission,
-  initializeDirectory,
   lockdownEnvironment,
   readAllExtensions,
   readAllMetadata,
diff --git a/src/lib/extensions-manager/scopes/initialize-directory.ts b/src/lib/extensions-manager/scopes/initialize-directory.ts
diff --git a/src/lib/extensions-manager/scopes/read-all-extensions.ts b/src/lib/extensions-manager/scopes/read-all-extensions.ts
@@ -1,8 +1,8 @@
 import { type DirEntry, readDir, readTextFile } from "@tauri-apps/plugin-fs";
 
+import { FileStructure } from "@/constants/file-structure.ts";
 import Errors from "@/lib/errors";
 import General from "@/lib/general";
-import GlobalStateHelpers from "@/lib/global-state-helpers";
 import { log } from "@/lib/logging/scopes/log.ts";
 import type { ExtensionInfoType } from "@/types/extensions/extension-info.type.ts";
 
@@ -18,7 +18,10 @@ async function transformToPromise(path: string, filename: string): Promise<Exten
 
 export async function readAllExtensions(): Promise<Array<ExtensionInfoType>> {
   const startTime = performance.now();
-  const path = GlobalStateHelpers.get().fileSystem?.folders?.extensions;
+  const path = General.cachedJoin(
+    General.getCachedBaseDirectory(),
+    FileStructure.Folders.Extensions.Path,
+  );
 
   if (!path) {
     log.error("The extensions folder path in global states is undefined");
diff --git a/src/lib/extensions-manager/scopes/read-all-metadata.ts b/src/lib/extensions-manager/scopes/read-all-metadata.ts
@@ -1,4 +1,4 @@
-import { readTextFile, writeTextFile } from "@tauri-apps/plugin-fs";
+import { exists, readTextFile, writeTextFile } from "@tauri-apps/plugin-fs";
 
 import { FileStructure } from "@/constants/file-structure.ts";
 import Errors from "@/lib/errors";
@@ -13,21 +13,18 @@ export async function readAllMetadata(): Promise<Array<ExtensionMetadataType>> {
     FileStructure.Files.Extensions,
   );
 
-  log.debug("Reading the extensions metadata file");
-  let metadata: string;
+  log.debug("Checking if extensions metadata file exists");
+  const metadataExists = await exists(metadataPath);
 
-  try {
-    metadata = await readTextFile(metadataPath);
-  } catch (error: unknown) {
-    metadata = "[]";
-
-    log.error(
-      "Could not read the extensions metadata file (re-creating it):",
-      Errors.prettify(error),
-    );
+  if (!metadataExists) {
+    log.warn("Extensions metadata file does not exist");
+    log.debug("Initializing an extensions metadata file");
     await writeTextFile(metadataPath, "[]");
   }
 
+  log.debug("Extensions metadata file exists. Reading an extensions metadata file");
+  const metadata = await readTextFile(metadataPath);
+
   log.debug("Parsing the extensions metadata file");
   let parsedMetadata: unknown;
 
diff --git a/src/lib/general/scopes/initialize-launcher.ts b/src/lib/general/scopes/initialize-launcher.ts
@@ -37,11 +37,11 @@ export async function initializeLauncher({
   log.debug("Checking if all directories present");
   const directoriesStartTime = performance.now();
 
-  const cachePath = General.cachedJoin(baseDirectory, FileStructure.Cache.Path);
-  const instancesPath = General.cachedJoin(baseDirectory, FileStructure.Instances.Path);
-  const extensionsPath = General.cachedJoin(baseDirectory, FileStructure.Extensions.Path);
-  const resourcesPath = General.cachedJoin(baseDirectory, FileStructure.Extensions.Path);
-  const themesPath = General.cachedJoin(baseDirectory, FileStructure.Themes.Path);
+  const cachePath = General.cachedJoin(baseDirectory, FileStructure.Folders.Cache.Path);
+  const instancesPath = General.cachedJoin(baseDirectory, FileStructure.Folders.Instances.Path);
+  const extensionsPath = General.cachedJoin(baseDirectory, FileStructure.Folders.Extensions.Path);
+  const resourcesPath = General.cachedJoin(baseDirectory, FileStructure.Folders.Resources.Path);
+  const themesPath = General.cachedJoin(baseDirectory, FileStructure.Folders.Themes.Path);
 
   const directories: Array<string> = [
     cachePath,
diff --git a/src/lib/globals/scopes/declare-window.ts b/src/lib/globals/scopes/declare-window.ts
@@ -91,10 +91,6 @@ export function declareWindow(): void {
       "getDefaultConfig": {
         "before": [],
       },
-      "onFileSystemChange": {
-        "before": [],
-        "after" : [],
-      },
       "onPagesChange": {
         "before": [],
         "after" : [],
diff --git a/src/lib/instances/scopes/read-stored-instances.ts b/src/lib/instances/scopes/read-stored-instances.ts
@@ -8,13 +8,13 @@ import Schemas from "@/lib/schemas";
 import type { InstanceStatesType } from "@/types/application/instance-states.type.ts";
 
 export async function readStoredInstances(baseDirectory: string): Promise<InstanceStatesType> {
-  const instancesMetadataPath = General.cachedJoin(baseDirectory, FileStructure.InstancesData.Name);
+  const instancesMetadataPath = General.cachedJoin(baseDirectory, FileStructure.Files.Metadata);
 
   log.debug("Checking if instances metadata file exists");
   const metadataExists = await exists(instancesMetadataPath);
 
   if (!metadataExists) {
-    log.info("Instances metadata file does not exist");
+    log.warn("Instances metadata file does not exist");
     log.debug("Initializing an instances metadata file");
     await writeTextFile(instancesMetadataPath, "{}");
 
diff --git a/src/lib/launcher/scopes/get-cached-manifest-v2-path.ts b/src/lib/launcher/scopes/get-cached-manifest-v2-path.ts
diff --git a/src/lib/launcher/scopes/launch-with-checks.ts b/src/lib/launcher/scopes/launch-with-checks.ts
diff --git a/vitest.setup.ts b/vitest.setup.ts
