fix: weaudit files from different OSes fail to load due to path differences (#41) (#94)

* fix: weaudit config files from different OSes are not cross-platform (#41)

* prettier

* fix docstr

Author: dariushoule

src/codeMarker.ts

@@ -47,6 +47,7 @@ import {
     configEntryEquals,
     RootPathAndLabel,
 } from "./types";
+import { normalizePathForOS } from "./utilities/normalizePath";
 
 export const SERIALIZED_FILE_EXTENSION = ".weaudit";
 const DAY_LOG_FILENAME = ".weauditdaylog";
@@ -3315,6 +3316,28 @@ export class CodeMarker implements vscode.TreeDataProvider<TreeEntry> {
             ),
         } as FullSerializedData;
 
+        // Normalize all the paths from loaded files. These can come from different OSes with different path
+        // conventions. We do a best effort to match them to the current OS format.
+        fullParsedEntries.treeEntries.forEach((entry) => {
+            entry.locations.forEach((loc) => {
+                loc.path = normalizePathForOS(rootPath, loc.path);
+            });
+        });
+
+        fullParsedEntries.resolvedEntries.forEach((entry) => {
+            entry.locations.forEach((loc) => {
+                loc.path = normalizePathForOS(rootPath, loc.path);
+            });
+        });
+
+        fullParsedEntries.auditedFiles.forEach((auditedFile) => {
+            auditedFile.path = normalizePathForOS(rootPath, auditedFile.path);
+        });
+
+        fullParsedEntries.partiallyAuditedFiles?.forEach((partiallyAuditedFile) => {
+            partiallyAuditedFile.path = normalizePathForOS(rootPath, partiallyAuditedFile.path);
+        });
+
         if (update) {
             if (add) {
                 // Remove potential entries of username which appear on the tree.

src/utilities/normalizePath.ts

@@ -0,0 +1,25 @@
+import * as path from "path";
+import * as fs from "fs";
+
+/**
+ * A method that normalizes the slashes in a path based on current operating system.
+ *
+ * @param wsRoot - The workspace root path to resolve relative paths
+ * @param filePath - The file path string to normalize
+ * @returns The path with slashes normalized for the current operating system
+ */
+export function normalizePathForOS(wsRoot: string, filePath: string): string {
+    if (process.platform === "win32" && filePath.includes("/")) {
+        // Unix-style paths on Windows
+        return path.normalize(filePath);
+    } else if (process.platform !== "win32" && filePath.includes("\\")) {
+        if (fs.existsSync(path.join(wsRoot, filePath))) {
+            // Hateful edge case, this is a unix-style path with backslashes in the file name.
+            return filePath;
+        } else {
+            // Windows path on non-windows OS
+            return filePath.replace(/\\/g, "/");
+        }
+    }
+    return filePath;
+}