Integration with typedoc-plugin-missing-exports

[csantos1113]

Hey @milesj - thanks for the quick fix for #84

I'm unfortunately having a new/similar error now with the typedoc-plugin-missing-exports plugin and docusaurus-plugin-typedoc-api.

The TL;DR of that plugin:

After TypeDoc has finished converting packages, it will look for types which are referenced, but not exported, and place them into an internal module for that entry point (called <internal> by default).

And you can see where my issue is going to, With the following config:

const __dirname = dirname(url.fileURLToPath(import.meta.url));
const projectRoot = join(__dirname, '..');

[
  'docusaurus-plugin-typedoc-api',
  {
    projectRoot,
    packages: ['packages/web'],
    changelogs: false,
    readmes: true,
    gitRefName: 'main',
    typedocOptions: {
      plugin: ['typedoc-plugin-missing-exports']
    }
  }
],

I get this .docusaurus/api-typedoc-default.json output:

{
  "id": 0,
  "name": "web",
  "kind": 1,
  "kindString": "Project",
  "flags": {},
  "originalName": "",
  "children": [
    { "kindString": "Reference", "...": 58 },
    { "kindString": "Reference", "...": 100 },
     // ...
    {
      "id": 5380,
      "name": "<internal>",
      "kind": 2,
      "kindString": "Module",
      "flags": {},
      "children": [{}, {}]
      }
  ]
}

docusaurus-plugin-typedoc-api/packages/plugin/src/plugin/data.ts

Lines 264 to 277 in 07ddf61

	const hasNoModules = project.children?.every((child) => child.kind !== ReflectionKind.Module);
	if (hasNoModules) {
	// No "module" children:
	// - Polyrepos
	// - Monorepos with 1 package
	modules.push(project);
	} else {
	// Has "module" children:
	// - Polyrepos with deep imports
	// - Polyrepos with multi-imports
	// - Monorepos
	inheritChildren();
	}

☝️ these lines are finding the <internal> Module as the module, instead of handling the web project as the module itself.

Question

Is there any way from the top of your head on how to make this work?

I almost wonder if docusaurus-plugin-typedoc-api should receive an explicit config property where we can indicate whether or not it's a monorepo so the plugin doesn't need to do all the magic, but not sure if that is a good idea (I'm not too familiar with TypeDoc)

[milesj]

@csantos1113 A few things:

I have no plans to directly support typedoc plugins, but I'll review any contributions/PRs for it.

Also, it's not just a polyrepo vs monorepo problem. As shown in the code snippet above, it also takes into account deep imports, multi imports, index imports, etc. This applies to both poly and mono, so there's a handful of combinations to support. This wouldn't be as easy as a flag.

At minimum, the hasNoModules can probably just ignore <internal> modules.