archived-typedoc-plugin-markdown/jest.helpers.ts

require('ts-node/register');
import * as path from 'path';

import {
  Application,
  PageEvent,
  ProjectReflection,
  RendererEvent,
  TSConfigReader,
  TypeDocReader,
  UrlMapping,
} from 'typedoc';
import { MarkdownTheme } from 'typedoc-plugin-markdown';

const STUBS_SRC_PATH = path.join(__dirname, 'stub-project', 'src');
const STUBS_TSCONFIG_PATH = path.join(
  __dirname,
  'stub-project',
  'tsconfig.json',
);

global.bootstrap = async (
  entryPoints: string[] = [],
  params: { options: any; stubPartials: string[] },
) => {
  const app = new Application();
  const options = params?.options || {};
  const stubPartials = params?.stubPartials || [];
  app.options.addReader(new TypeDocReader());
  app.options.addReader(new TSConfigReader());
  app.bootstrap({
    logger: 'none',
    entryPoints:
      entryPoints.length > 0
        ? entryPoints.map((inputFile: string) =>
            path.join(STUBS_SRC_PATH, inputFile),
          )
        : [STUBS_SRC_PATH],
    tsconfig: STUBS_TSCONFIG_PATH,
    ...options,
    plugin: [
      ...['typedoc-plugin-markdown', 'typedoc-plugin-mdn-links'],
      ...(options.plugin ? options.plugin : []),
    ],
  });

  const project = app.convert() as ProjectReflection;
  app.renderer.render = render;
  await app.generateDocs(project, 'docs');
  const context = (app.renderer.theme as MarkdownTheme).getRenderContext();
  stubPartials.forEach((stubPartial) => {
    context.partials[stubPartial] = () => `[partial: ${stubPartial}]`;
  });

  return { project, context };
};

async function render(project: ProjectReflection, outputDirectory: string) {
  if (!this.prepareTheme()) {
    return;
  }
  const output = new RendererEvent(
    RendererEvent.BEGIN,
    outputDirectory,
    project,
  );
  output.urls = this.theme!.getUrls(project);
  this.trigger(output);
  if (!output.isDefaultPrevented) {
    output?.urls?.forEach((mapping: UrlMapping) => {
      const page = output.createPageEvent(mapping);
      this.trigger(PageEvent.BEGIN, page);
      this.trigger(PageEvent.END, page);
    });
    this.trigger(RendererEvent.END, output);
  }
}