license-kit/src/serializeReport.ts

Aggregate license notes of OSS libraries used in your Node.js project, analyze & visualize OSS licenses with AI-turbocharged tooling

import path from 'node:path';

import { type Types, generateAboutLibrariesNPMOutput } from '@callstack/licenses';
import * as md from 'ts-markdown-builder';

import type { Format } from './types/Format';

export function serializeReport({
  licenses,
  format,
}: {
  licenses: Types.AggregatedLicensesMapping;
  format: Format;
}): string {
  // convert absolute paths to license files to just filenames (no point in placing those in the file)
  for (const packageInfo of Object.values(licenses)) {
    if (packageInfo.file) {
      packageInfo.file = path.basename(packageInfo.file);
    }
  }

  switch (format) {
    default:
    case 'json':
      return JSON.stringify(licenses, null, 2);

    case 'about-json':
      return JSON.stringify(generateAboutLibrariesNPMOutput(licenses), null, 2);

    case 'text':
      return Object.values(licenses)
        .map(({ name: packageName, version, author, content, description, file, type, url }) =>
          [
            `${packageName} (${version})`,
            url ? `URL: ${url}` : '',
            author ? `Author: ${author}` : '',
            content ?? '',
            description ? `Description: ${description}` : '',
            file ? `File: ${file}` : '',
            type ? `Type: ${type}` : '',
            '',
            '---'.repeat(10),
            '',
          ].join('\n'),
        )
        .join('\n');

    case 'markdown':
      return md
        .joinBlocks(
          Object.values(licenses)
            .flatMap(({ name: packageName, version, author, content, description, file, type, url }) => [
              '\n',
              md.heading(packageName, { level: 2 }),
              '\n',
              `Version: ${version}<br/>\n`,
              url ? `URL: ${url}<br/>\n` : '',
              author ? `Author: ${author}<br/>\n\n` : '',
              content ?? '',
              '\n',
              description ? `Description: ${description}\n` : '',
              file ? `\nFile: ${file}\n` : '',
              type ? `Type: ${type}` : '',
              '\n',
              md.horizontalRule,
            ])
            .join('\n'),
        )
        .toString();
  }
}