Handle reexports. (#133)

.github/workflows/build.yml

@@ -36,6 +36,7 @@ jobs:
         repo-type:
           - monorepo
           - monorepo-1
+          - monorepo-reexports
           - polyrepo
           - polyrepo-deep
           - polyrepo-multi

fixtures/monorepo-1-package/reexports/README.md

@@ -0,0 +1,7 @@
+# STANDARD
+
+```ts
+function foo(num: number) {
+  return 123;
+}
+```

fixtures/monorepo-1-package/reexports/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "reexports",
+  "version": "1.0.0"
+}

fixtures/monorepo-1-package/reexports/src/index.ts

@@ -0,0 +1 @@
+export * from './other';

fixtures/monorepo-1-package/reexports/src/other.ts

@@ -0,0 +1,112 @@
+/**
+ * a type
+ * @beta
+ */
+export type Type = 'standard';
+
+/**
+ * short description
+ *
+ * long description with a link to {@link bizz}. did it work?
+ * what about our own tokens: {@apilink Foo} and {@doclink intro}!
+ * and some inline `code`???
+ *
+ * ```
+ * let dontForget = 'block code';
+ * ```
+ *
+ * @param {String} msg description
+ * @param other without type
+ * @returns returns the param
+ */
+export function comments(msg: string, other: boolean) {}
+
+/**
+ * newy new guy
+ * @param a a thing
+ * @param b b thing
+ * @alpha
+ */
+export function bizz(a: string, b: string): string;
+
+/**
+ * newy new guy
+ * @param a a thing
+ * @param b b thing
+ * @param c c thing
+ * @beta
+ */
+export function bizz(a: string, b: string, c: string): string;
+
+/**
+ * a thing for a thing
+ * @param a id
+ * @returns returns the param
+ * @beta
+ */
+export function bizz(...args: string[]): string {
+	return args[0];
+}
+
+/**
+ * @param {string} [a] thing
+ * @param {string} [b="b"] thing
+ * @param {string} [c="c override"] thing
+ */
+export function defs(a?: string, b?: string, c: string = 'c') {}
+
+/**
+ * thing for a thing
+ * @beta
+ */
+export interface Foo {
+	/**
+	 * very experimental
+	 * @alpha
+	 * @default "foo"
+	 */
+	foo: string;
+
+	/**
+	 * very experimental
+	 * @experimental
+	 */
+	a: string;
+
+	/**
+	 * @default 123
+	 */
+	int?: number;
+}
+
+/**
+ * :::
+ * standard
+ * :::
+ *
+ * :::note
+ * with type
+ * :::
+ *
+ * ::: title
+ * title only
+ * :::
+ *
+ * :::info title
+ * with type
+ *
+ * and title
+ * :::
+ *
+ * :::success
+ *
+ * extra new lines
+ *
+ * :::
+ */
+export function admonitions() {}
+
+/**
+ * @throws something
+ */
+export function errors() {}

fixtures/monorepo-1-package/reexports/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "declarationDir": "dts",
+    "outDir": "dts",
+    "rootDir": "src",
+    "emitDeclarationOnly": true
+  },
+  "exclude": [
+    "dts",
+    "tests"
+  ],
+  "extends": "../../../tsconfig.options.json",
+  "include": [
+    "src/**/*"
+  ],
+  "references": []
+}

fixtures/monorepo-1-package/tsconfig.json

@@ -5,6 +5,9 @@
     {
       "path": "other"
     },
+    {
+      "path": "reexports"
+    },
     {
       "path": "standard"
     }

packages/plugin/src/index.ts

@@ -117,6 +117,7 @@ export default function typedocApiPlugin(
 
 		return {
 			entryPoints: entries,
+			packageRoot: path.normalize(path.join(projectRoot, pkgConfig.path || '.')),
 			packagePath: pkgConfig.path || '.',
 			packageSlug: pkgConfig.slug ?? path.basename(pkgConfig.path),
 			// Load later on

packages/plugin/src/plugin/data.ts

@@ -255,6 +255,7 @@ function modContainsEntryPoint(
 	meta: {
 		allSourceFiles: Record<string, boolean>;
 		packagePath: string;
+		packageRoot: string;
 		isSinglePackage: boolean;
 		isUsingDeepImports: boolean;
 	},
@@ -267,12 +268,14 @@ function modContainsEntryPoint(
 	// They also don't use full paths like "package/src/index.ts" and simply use "index.ts",
 	// so account for those entry points also.
 	if (!relModSourceFile) {
+		const absEntryPoint = path.normalize(path.join(meta.packageRoot, entry.path));
 		const relEntryPointName = path.basename(relEntryPoint);
-		const relEntryPointInSourceFiles =
+		const entryPointInSourceFiles =
+			!!meta.allSourceFiles[absEntryPoint] ||
 			!!meta.allSourceFiles[relEntryPoint] ||
 			(relEntryPointName.startsWith('index.') && !!meta.allSourceFiles[relEntryPointName]);
 
-		if (relEntryPointInSourceFiles) {
+		if (entryPointInSourceFiles) {
 			return sourceFileMatchesEntryPoint(relEntryPoint, relEntryPoint, {
 				deep: meta.isUsingDeepImports,
 				single: meta.isSinglePackage,
@@ -327,11 +330,21 @@ function extractReflectionModules(
 	return modules;
 }
 
-function buildSourceFileNameMap(modChildren: JSONOutput.DeclarationReflection[]) {
+function buildSourceFileNameMap(
+	project: JSONOutput.ProjectReflection,
+	modChildren: JSONOutput.DeclarationReflection[],
+) {
 	const map: Record<string, boolean> = {};
+	const cwd = process.cwd();
+
+	Object.values(project.symbolIdMap).forEach((symbol) => {
+		// absolute
+		map[path.normalize(path.join(cwd, symbol.sourceFileName))] = true;
+	});
 
 	modChildren.forEach((child) => {
 		child.sources?.forEach((sf) => {
+			// relative
 			map[sf.fileName] = true;
 		});
 	});
@@ -354,7 +367,7 @@ export function flattenAndGroupPackages(
 	const packagesWithDeepImports: TSDDeclarationReflection[] = [];
 
 	modules.forEach((mod) => {
-		const allSourceFiles = buildSourceFileNameMap(mod.children ?? []);
+		const allSourceFiles = buildSourceFileNameMap(project, mod.children ?? []);
 
 		packageConfigs.some((cfg) =>
 			Object.entries(cfg.entryPoints).some(([importPath, entry]) => {
@@ -366,6 +379,7 @@ export function flattenAndGroupPackages(
 						isSinglePackage,
 						isUsingDeepImports,
 						packagePath: cfg.packagePath,
+						packageRoot: cfg.packageRoot,
 					})
 				) {
 					return false;

packages/plugin/src/types.ts

@@ -1,5 +1,5 @@
 import type { JSONOutput, TypeDocOptions } from 'typedoc';
-import type { MDXPlugin } from '@docusaurus/mdx-loader'
+import type { MDXPlugin } from '@docusaurus/mdx-loader';
 import type {
 	PropSidebarItem,
 	VersionBanner,
@@ -54,6 +54,7 @@ export interface PackageConfig {
 
 export interface ResolvedPackageConfig {
 	entryPoints: Record<string, PackageEntryConfig>;
+	packageRoot: string;
 	packagePath: string;
 	packageSlug: string;
 	packageName: string;

website/docusaurus.config.ts

@@ -37,6 +37,11 @@ const monorepoOnePackage = {
 	packages: ['standard'],
 };
 
+const monorepoReexports = {
+	projectRoot: path.join(__dirname, '../fixtures/monorepo-1-package'),
+	packages: ['reexports'],
+};
+
 // POLYREPO STANDARD
 const polyrepo = {
 	projectRoot: path.join(__dirname, '../fixtures/polyrepo'),
@@ -122,6 +127,8 @@ function getPluginConfig() {
 			return monorepo;
 		case 'monorepo-1':
 			return monorepoOnePackage;
+		case 'monorepo-reexports':
+			return monorepoReexports;
 		case 'polyrepo':
 			return polyrepo;
 		case 'polyrepo-deep':