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

adev/shared-docs/pipeline/api-gen/rendering/test/renderable.spec.mts
82 строки3 KB
SkyZeroZx
docs(docs-infra): Adds anchor links to class member headers for linking
02 апр 2026, 18:40
02 апр 2026, 18:40ab9910c
/**
 * @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 {readFile} from 'fs/promises';
import {JSDOM} from 'jsdom';
import {DocEntryRenderable} from '../entities/renderables.mjs';
import {getRenderable} from '../processing.mjs';
import {renderEntry} from '../rendering.mjs';
import {setSymbols} from '../symbol-context.mjs';
import {resolve} from 'path';
import {initHighlighter} from '../../../shared/shiki.mjs';
import {setHighlighterInstance} from '../shiki/shiki.mjs';

// Note: The tests will probably break if the schema of the api extraction changes.
// All entries in the fake-entries are extracted from Angular's api.
// You can just generate them an copy/replace the items in the fake-entries file.

describe('renderable', () => {
  const entries = new Map<string, DocEntryRenderable>();

  beforeAll(async () => {
    setHighlighterInstance(await initHighlighter());

    const entryContent = await readFile(resolve('./fake-entries.json'), {
      encoding: 'utf-8',
    });
    const entryJson = JSON.parse(entryContent) as any;
    const symbols = Object.fromEntries([
      ['AfterRenderPhase', 'core'],
      ['afterRender', 'core'],
      ['EmbeddedViewRef', 'core'],
      ['ChangeDetectionStrategy', 'core'],
      ['ChangeDetectorRef', 'core'],
      ['withNoHttpTransferCache', 'platform-browser'],
      ['withHttpTransferCacheOptions', 'platform-browser'],
      ['withI18nSupport', 'platform-browser'],
      ['withEventReplay', 'platform-browser'],
    ]);
    setSymbols(symbols);

    for (const entry of entryJson.entries) {
      const renderableJson = (await getRenderable(
        entry,
        '@angular/fakeentry',
        'angular/angular',
      )) as DocEntryRenderable;
      entries.set(entry['name'], renderableJson);
    }
  });

  it('should compute the flags correctly', () => {
    // linkedSignal has the developerPreview tag on the overloads not on the main entry.
    const linkedSignal = entries.get('linkedSignal');
    expect(linkedSignal).toBeDefined();
    expect(linkedSignal!.deprecated).toBe(undefined);
    expect(linkedSignal!.developerPreview).toEqual({version: undefined});
    expect(linkedSignal!.experimental).toBe(undefined);
    expect(linkedSignal!.stable).toBe(undefined);
  });

  it('should render docs-anchor links in class member card headers', () => {
    const viewRef = entries.get('ViewRef')!;
    expect(viewRef).toBeDefined();

    const html = renderEntry(viewRef);
    const fragment = JSDOM.fragment(html);

    const memberCards = fragment.querySelectorAll('.docs-reference-member-card');
    expect(memberCards.length).toBeGreaterThan(0);

    for (const card of Array.from(memberCards)) {
      const id = card.getAttribute('id')!;
      const anchor = card.querySelector('h3 a.docs-anchor') as HTMLAnchorElement;
      expect(anchor.getAttribute('href')).toBe(`#${id}`);
    }
  });
});