Function metaDescription

packages/utils/src/lib/reports/formatting.ts:73–93

(
  audit: Pick<AuditReport, 'docsUrl' | 'description'>,
)

// @TODO extract `Pick<AuditReport, 'docsUrl' | 'description'>` to a reusable schema and type
export function metaDescription(
  audit: Pick<AuditReport, 'docsUrl' | 'description'>,
): InlineText {
  const docsUrl = audit.docsUrl;
  const description = audit.description?.trim();
  if (docsUrl) {
    const docsLink = md.link(docsUrl, '📖 Docs');
    if (!description) {
      return docsLink;
    }
    const formattedDescription = wrapTags(description);
    const parsedDescription = formattedDescription.endsWith('```')
      ? `${formattedDescription}\n\n`
      : `${formattedDescription} `;
    return md`${parsedDescription}${docsLink}`;
  }
  if (description && description.trim().length > 0) {
    return wrapTags(description);
  }
  return '';
}

/**
 * Link to local source for IDE