Fix possibility of absolute paths, resolves #12

Author: Gerrit0

CHANGELOG.md

@@ -1,3 +1,8 @@
+### 3.0.1 (2024-10-15)
+
+- Fixed an issue where modules could be created by this plugin with names
+  including an absolute path, #12.
+
 ### 3.0.0 (2024-06-22)
 
 - Support TypeDoc 0.26

index.ts

@@ -1,3 +1,4 @@
+import { relative } from "path";
 import {
 	Application,
 	Context,
@@ -127,6 +128,19 @@ export function load(app: Application) {
 			if (refl.kindOf(ModuleLike)) {
 				knownPrograms.set(refl, context.program);
 			}
+
+			// #12 - This plugin might cause TypeDoc to convert some module without
+			// an export symbol to give it a name other than the full absolute
+			// path to the symbol. Detect this and rename it to a relative path
+			// based on base path if specified or CWD.
+			const symbol = context.project.getSymbolFromReflection(refl);
+			const file = symbol?.declarations?.find(ts.isSourceFile);
+			if (file && /^".*"$/.test(refl.name)) {
+				refl.name = relative(
+					app.options.getValue("basePath") || process.cwd(),
+					file.fileName,
+				);
+			}
 		},
 	);
 

test/packages.test.ts

@@ -75,6 +75,7 @@ beforeAll(async () => {
 afterEach(() => {
 	app.options.reset("internalModule");
 	app.options.reset("placeInternalsInOwningModule");
+	app.options.reset("basePath");
 
 	expect(logger.messages).toEqual([]);
 	logger.messages = [];
@@ -159,6 +160,30 @@ test("Missing declaration", () => {
 	expect(toStringHierarchy(project)).toBe(hierarchy);
 });
 
+// https://github.com/Gerrit0/typedoc-plugin-missing-exports/issues/12
+test("Issue #12", () => {
+	const project = convert("gh12/index.ts");
+
+	const hierarchy = outdent`
+		Module <internal>
+			Namespace test/packages/gh12/mod.ts
+		Variable ReferencesModule
+	`;
+
+	expect(toStringHierarchy(project)).toBe(hierarchy);
+
+	app.options.setValue("basePath", "test/packages");
+	const project2 = convert("gh12/index.ts");
+
+	const hierarchy2 = outdent`
+		Module <internal>
+			Namespace gh12/mod.ts
+		Variable ReferencesModule
+	`;
+
+	expect(toStringHierarchy(project2)).toBe(hierarchy2);
+});
+
 // https://github.com/Gerrit0/typedoc-plugin-missing-exports/issues/15
 test("Issue #15", () => {
 	const project = convert("gh15/index.ts");

test/packages/gh12/index.ts

@@ -0,0 +1,3 @@
+export declare const ReferencesModule: {
+	mod: typeof import("./mod.js");
+};

test/packages/gh12/mod.ts

@@ -0,0 +1 @@
+export const abc = 123;