Helper methods for working with pw annotations

setAnnotation.ts

import { test } from '@playwright/test';

/**
 * Updates exsiting annotation or creates new one for current test
 *
 * @throws {Error} if called outside of test or before/after hooks
 */
export function setAnnotation(annotation: {
  type: string;
  description: string;
}): void {
  const existingAnnotation = test
    .info()
    .annotations.find((a) => a.type === annotation.type);

  if (existingAnnotation) {
    existingAnnotation.description = annotation.description;
  } else {
    test.info().annotations.push(annotation);
  }
}

/**
 * Updates exsiting annotation or creates new one for current test
 *
 * @throws {Error} if called outside of test or before/after hooks
 */
export function setAnnotations(
  annotations: Parameters<typeof setAnnotation>[0][],
): void {
  for (const annotation of annotations) {
    setAnnotation(annotation);
  }
}