docusaurus-plugin-typedoc-api/src/plugin/url.ts

Docusaurus plugin that provides source code API documentation powered by TypeDoc.

import path from 'path';
import { JSONOutput, ReflectionKind } from 'typedoc';
import type { ResolvedPackageConfig } from '../types';

export function joinUrl(...paths: string[]): string {
	return path.join(...paths).replace(/\\/g, '/');
}

export function getKindSlug(decl: JSONOutput.DeclarationReflection): string {
	switch (decl.kind) {
		case ReflectionKind.Module:
			return 'package';
		case ReflectionKind.Namespace:
			return 'namespace';
		case ReflectionKind.Enum:
			return 'enum';
		case ReflectionKind.Function:
			return 'function';
		case ReflectionKind.Class:
			return 'class';
		case ReflectionKind.Interface:
			return 'interface';
		default:
			return '';
	}
}

export function getPackageSlug(
	pkgConfig: ResolvedPackageConfig,
	importPath: string,
	isSinglePackage: boolean,
): string {
	// Monorepo with 1 package has special handling
	if (isSinglePackage && pkgConfig.packageSlug !== '.') {
		return '.';
	}

	// packages/foo -> foo
	const slug = pkgConfig.packageSlug ?? path.basename(pkgConfig.packagePath);

	// bar/baz -> bar-baz
	const importName = importPath.replace(/\\/g, '-');

	if (importName === 'index') {
		return slug;
	}

	return `${slug}-${importName}`;
}