license-kit/build/serializeReport.js

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

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
    var ownKeys = function(o) {
        ownKeys = Object.getOwnPropertyNames || function (o) {
            var ar = [];
            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
            return ar;
        };
        return ownKeys(o);
    };
    return function (mod) {
        if (mod && mod.__esModule) return mod;
        var result = {};
        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
        __setModuleDefault(result, mod);
        return result;
    };
})();
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.serializeReport = serializeReport;
const node_path_1 = __importDefault(require("node:path"));
const licenses_1 = require("@callstack/licenses");
const md = __importStar(require("ts-markdown-builder"));
function serializeReport({ licenses, format, }) {
    // 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 = node_path_1.default.basename(packageInfo.file);
        }
    }
    switch (format) {
        default:
        case 'json':
            return JSON.stringify(licenses, null, 2);
        case 'about-json':
            return JSON.stringify((0, licenses_1.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();
    }
}