Fix remaining unit tests on Linux

Author: Gerrit0

site/overview.md

@@ -52,13 +52,18 @@ import * as td from "typedoc";
 // Also accepts an array of option readers if you want to disable
 // TypeDoc's tsconfig.json/package.json/typedoc.json option readers
 const app = await td.Application.bootstrapWithPlugins({
+    // Note: This accepts globs, do not pass paths with backslash path separators!
     entryPoints: ["src/index.ts"],
 });
 
 // May be undefined if errors are encountered.
 const project = await app.convert();
 
 if (project) {
+    // Generate configured outputs
+    await generateOutputs(project);
+
+    // Alternatively...
     const outputDir = "docs";
     // Generate HTML rendered docs
     await app.generateDocs(project, outputDir);

src/lib/utils/options/options.ts

@@ -1,7 +1,7 @@
 import type ts from "typescript";
 import { resolve } from "path";
 import { ParameterType } from "./declaration.js";
-import type { OutputSpecification } from "../index.js";
+import { normalizePath, type OutputSpecification } from "../index.js";
 import type { Application } from "../../../index.js";
 import type { Logger } from "../loggers.js";
 import {
@@ -353,7 +353,7 @@ export class Options {
             ).map((c) => {
                 return {
                     ...c,
-                    path: resolve(configPath ?? process.cwd(), c.path),
+                    path: normalizePath(resolve(configPath ?? process.cwd(), c.path)),
                 };
             });
         } else {

src/lib/utils/paths.ts

@@ -65,7 +65,7 @@ export function createGlobString(relativeTo: NormalizedPath, glob: string): Glob
     if (isAbsolute(glob) || isGlobalGlob(glob)) return glob as GlobString;
 
     const split = splitGlobToPathAndSpecial(glob);
-    const leadingPath = normalizePath(resolve(relativeTo, split.path)).replace(/^\w:\//, "");
+    const leadingPath = normalizePath(resolve(relativeTo, split.path));
 
     if (!split.glob) {
         return split.modifiers + escapeGlob(leadingPath) as GlobString;

src/test/merge.test.ts

@@ -1,6 +1,6 @@
 import { deepStrictEqual as equal, ok } from "assert";
 import { join } from "path";
-import { Application, type DeclarationReflection, EntryPointStrategy, ReferenceType } from "../index.js";
+import { Application, type DeclarationReflection, EntryPointStrategy, normalizePath, ReferenceType } from "../index.js";
 import { getConverterBase } from "./programs.js";
 import { TestLogger } from "./TestLogger.js";
 
@@ -11,8 +11,8 @@ describe("Merging projects", () => {
         const app = await Application.bootstrap({
             entryPointStrategy: EntryPointStrategy.Merge,
             entryPoints: [
-                join(base, "alias/specs.json"),
-                join(base, "class/*specs.json"),
+                normalizePath(join(base, "alias/specs.json")),
+                normalizePath(join(base, "class/*specs.json")),
             ],
             projectDocuments: [],
             name: "typedoc",

src/test/output/output.test.ts

@@ -5,6 +5,7 @@ import { Outputs } from "../../lib/output/output.js";
 import { TestLogger } from "../TestLogger.js";
 import { FileRegistry, ProjectReflection } from "../../lib/models/index.js";
 import type { TranslatedString } from "../../lib/internationalization/index.js";
+import { normalizePath } from "#node-utils";
 
 const app = getConverter2App();
 
@@ -46,22 +47,22 @@ describe("Output", () => {
 
     it("Uses the --out output by default", () => {
         const specs = outputs.getOutputSpecs();
-        equal(specs, [{ name: "html", path: resolve("./docs") }]);
+        equal(specs, [{ name: "html", path: normalizePath(resolve("./docs")) }]);
     });
 
     it("Does not use default value of --out if there is a specified output shortcut", () => {
         app.options.setValue("html", "./html_docs");
         const specs = outputs.getOutputSpecs();
-        equal(specs, [{ name: "html", path: resolve("./html_docs") }]);
+        equal(specs, [{ name: "html", path: normalizePath(resolve("./html_docs")) }]);
     });
 
     it("Uses --out if specified", () => {
         app.options.setValue("html", "./html_docs");
         app.options.setValue("out", "./out_docs");
         const specs = outputs.getOutputSpecs();
         equal(specs, [
-            { name: "html", path: resolve("./out_docs") },
-            { name: "html", path: resolve("./html_docs") },
+            { name: "html", path: normalizePath(resolve("./out_docs")) },
+            { name: "html", path: normalizePath(resolve("./html_docs")) },
         ]);
     });
 
@@ -70,7 +71,7 @@ describe("Output", () => {
             { name: "html", path: "./html_docs" },
         ]);
         const specs = outputs.getOutputSpecs();
-        equal(specs, [{ name: "html", path: resolve("./html_docs") }]);
+        equal(specs, [{ name: "html", path: normalizePath(resolve("./html_docs")) }]);
     });
 
     it("Prioritizes shortcuts if both outputs and shortcuts are specified", () => {
@@ -79,7 +80,7 @@ describe("Output", () => {
         ]);
         app.options.setValue("html", "./html_docs2");
         const specs = outputs.getOutputSpecs();
-        equal(specs, [{ name: "html", path: resolve("./html_docs2") }]);
+        equal(specs, [{ name: "html", path: normalizePath(resolve("./html_docs2")) }]);
     });
 
     it("Prioritizes --out if both outputs and --out are specified", () => {
@@ -88,14 +89,14 @@ describe("Output", () => {
         ]);
         app.options.setValue("out", "./html_docs2");
         const specs = outputs.getOutputSpecs();
-        equal(specs, [{ name: "html", path: resolve("./html_docs2") }]);
+        equal(specs, [{ name: "html", path: normalizePath(resolve("./html_docs2")) }]);
     });
 
     it("Supports specifying a different default output name", () => {
         outputs.setDefaultOutputName("json");
         const specs = outputs.getOutputSpecs();
         try {
-            equal(specs, [{ name: "json", path: resolve("./docs") }]);
+            equal(specs, [{ name: "json", path: normalizePath(resolve("./docs")) }]);
         } finally {
             outputs.setDefaultOutputName("html");
         }

src/test/slow/entry-point.test.ts

@@ -27,10 +27,12 @@ describe("Entry Points", () => {
     it("Supports expanding existing paths", async () => {
         const app = await Application.bootstrap({
             tsconfig,
-            entryPoints: [fixture.cwd],
+            entryPoints: [normalizePath(fixture.cwd)],
             entryPointStrategy: EntryPointStrategy.Expand,
         });
 
+        equal(app.options.getValue("entryPoints"), [normalizePath(fixture.cwd)]);
+
         const entryPoints = app.getDefinedEntryPoints();
         ok(entryPoints);
         equal(

src/test/utils/options/readers/arguments.test.ts

@@ -68,7 +68,7 @@ describe("Options - ArgumentsReader", () => {
     });
 
     test("Works with string options", ["--out", "outDir"], () => {
-        equal(options.getValue("out"), join(process.cwd(), "outDir"));
+        equal(options.getValue("out"), normalizePath(join(process.cwd(), "outDir")));
     });
 
     test("Works with number options", ["-numOption", "123"], () => {

src/test/utils/paths.test.ts

@@ -69,10 +69,17 @@ describe("paths.ts", () => {
         });
 
         it("Handles file paths", () => {
-            equal(
-                createGlobString("/test/typedoc" as NormalizedPath, "src/index.ts"),
-                "/test/typedoc/src/index.ts",
-            );
+            if (process.platform == "win32") {
+                equal(
+                    createGlobString("C:/test/typedoc" as NormalizedPath, "src/index.ts"),
+                    "C:/test/typedoc/src/index.ts",
+                );
+            } else {
+                equal(
+                    createGlobString("/test/typedoc" as NormalizedPath, "src/index.ts"),
+                    "/test/typedoc/src/index.ts",
+                );
+            }
         });
     });