Add XML parser (#1199)

* Add file system utility to parse XML files

* Add test for file system utility to parse XML files

* Added separate module for XmlParser

* Add docs for the XML parser

* Set @scomans as codeowner of the XmlParser

---------

Co-authored-by: Oliver Schwendener <[email protected]>

.github/CODEOWNERS

@@ -23,6 +23,7 @@ vite.config.mts @oliverschwendener
 
 src/main/Core/IniFileParser @ke1v
 src/main/Core/LinuxDesktopEnvironment @ke1v
+src/main/Core/XmlParser @scomans
 
 # Extensions
 

package.json

@@ -59,6 +59,7 @@
         "@fluentui/react-icons": "^2.0.249",
         "better-sqlite3": "^11.2.1",
         "color": "^4.2.3",
+        "fast-xml-parser": "^4.5.0",
         "fuse.js": "^7.0.0",
         "fuzzysort": "^3.0.1",
         "i18next": "^23.8.1",

src/main/Core/Dependencies.ts

@@ -46,4 +46,5 @@ export type Dependencies = {
     Translator?: Core.Translator;
     UeliCommandInvoker?: Core.UeliCommandInvoker;
     UrlImageGenerator?: Core.UrlImageGenerator;
+    XmlParser?: Core.XmlParser;
 };

src/main/Core/XmlParser/Contract/XmlParser.ts

@@ -0,0 +1,14 @@
+/**
+ * Offers a method to parse XML content.
+ */
+export interface XmlParser {
+    /**
+     * Parses the given XML string and returns the result as an object.
+     * @param xml - The XML string to be parsed.
+     * @param [options] - Optional settings for parsing.
+     * @param options.preserveOrder - Whether to preserve the order of elements.
+     * @param options.ignoreAttributes - Whether to ignore attributes in the XML.
+     * @returns {T} - The parsed result.
+     */
+    parse<T>(xml: string, options?: { preserveOrder: boolean; ignoreAttributes: boolean }): T;
+}

src/main/Core/XmlParser/Contract/index.ts

@@ -0,0 +1 @@
+export * from "./XmlParser";

src/main/Core/XmlParser/XmlParser.test.ts

@@ -0,0 +1,14 @@
+import { describe, expect, it } from "vitest";
+import { XmlParser } from "./XmlParser";
+
+describe(XmlParser, () => {
+    describe(XmlParser.prototype.parse, () => {
+        it("should read and parse XML file content", async () => {
+            const xml = "<root><test>test</test></root>";
+            const actual = new XmlParser().parse(xml, { ignoreAttributes: true, preserveOrder: true });
+            const expected = [{ root: [{ test: [{ "#text": "test" }] }] }];
+
+            expect(actual).toEqual(expected);
+        });
+    });
+});

src/main/Core/XmlParser/XmlParser.ts

@@ -0,0 +1,8 @@
+import { XMLParser } from "fast-xml-parser";
+import type { XmlParser as XmlParserInterface } from "./Contract";
+
+export class XmlParser implements XmlParserInterface {
+    public parse<T>(xml: string, options?: { preserveOrder: boolean; ignoreAttributes: boolean }): T {
+        return new XMLParser(options).parse(xml);
+    }
+}

src/main/Core/XmlParser/XmlParserModule.ts

@@ -0,0 +1,9 @@
+import type { Dependencies } from "@Core/Dependencies";
+import type { DependencyRegistry } from "@Core/DependencyRegistry";
+import { XmlParser } from "./XmlParser";
+
+export class XmlParserModule {
+    public static bootstrap(dependencyRegistry: DependencyRegistry<Dependencies>) {
+        dependencyRegistry.register("XmlParser", new XmlParser());
+    }
+}

src/main/Core/XmlParser/index.ts

@@ -0,0 +1,2 @@
+export * from "./Contract";
+export * from "./XmlParserModule";

src/main/Core/index.ts

@@ -46,3 +46,4 @@ export * from "./Terminal";
 export * from "./Translator";
 export * from "./TrayIcon";
 export * from "./UeliCommand";
+export * from "./XmlParser";

src/main/index.ts

@@ -34,6 +34,7 @@ import * as Extensions from "./Extensions";
     Core.EnvironmentVariableProviderModule.bootstrap(dependencyRegistry);
     Core.LinuxDesktopEnvironmentModule.bootstrap(dependencyRegistry);
     Core.IniFileParserModule.bootstrap(dependencyRegistry);
+    Core.XmlParserModule.bootstrap(dependencyRegistry);
     Core.EventEmitterModule.bootstrap(dependencyRegistry);
     Core.EventSubscriberModule.bootstrap(dependencyRegistry);
     Core.BrowserWindowNotifierModule.bootstrap(dependencyRegistry);