adev/shared-docs/pipeline/api-gen/rendering/rendering.mts - main - githubmirror/angular

adev/shared-docs/pipeline/api-gen/rendering/rendering.mts

70 строк2 KB

Shuaib Hasan Akib

fix(docs-infra): prevent duplicate description rendering for block API entries

13 янв 2026, 00:37

13 янв 2026, 00:378bdd98e

/*!
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */

import {render} from 'preact-render-to-string';

import {
  isClassEntry,
  isCliEntry,
  isConstantEntry,
  isDecoratorEntry,
  isEnumEntry,
  isFunctionEntry,
  isInitializerApiFunctionEntry,
  isInterfaceEntry,
  isTypeAliasEntry,
  isBlockEntry,
} from './entities/categorization.mjs';
import {CliCommandRenderable, DocEntryRenderable} from './entities/renderables.mjs';
import {ClassReference} from './templates/class-reference';
import {CliCommandReference} from './templates/cli-reference';
import {ConstantReference} from './templates/constant-reference';
import {DocsReference} from './templates/docs-reference';
import {EnumReference} from './templates/enum-reference';
import {FunctionReference} from './templates/function-reference';
import {InitializerApiFunction} from './templates/initializer-api-function';
import {TypeAliasReference} from './templates/type-alias-reference';
import {DecoratorReference} from './templates/decorator-reference';
import {setCurrentSymbol} from './symbol-context.mjs';
import {BlockReference} from './templates/block-reference';

/** Given a doc entry, get the transformed version of the entry for rendering. */
export function renderEntry(renderable: DocEntryRenderable | CliCommandRenderable): string {
  setCurrentSymbol(renderable.name);
  if (isCliEntry(renderable)) {
    return render(CliCommandReference(renderable));
  }

  if (isClassEntry(renderable) || isInterfaceEntry(renderable)) {
    return render(ClassReference(renderable));
  }
  if (isDecoratorEntry(renderable)) {
    return render(DecoratorReference(renderable));
  }
  if (isConstantEntry(renderable)) {
    return render(ConstantReference(renderable));
  }
  if (isEnumEntry(renderable)) {
    return render(EnumReference(renderable));
  }
  if (isFunctionEntry(renderable)) {
    return render(FunctionReference(renderable));
  }
  if (isTypeAliasEntry(renderable)) {
    return render(TypeAliasReference(renderable));
  }
  if (isInitializerApiFunctionEntry(renderable)) {
    return render(InitializerApiFunction(renderable));
  }
  if (isBlockEntry(renderable)) {
    return render(BlockReference(renderable));
  }

  // Fall back rendering nothing while in development.
  return render(DocsReference(renderable));
}