@redocly/cli/lib/commands/scorecard-classic/formatters/json-formatter.js

[@Redocly](https://redocly.com) CLI is your all-in-one API documentation utility. It builds, manages, improves, and quality-checks your API descriptions, all of which comes in handy for various phases of the API Lifecycle. Create your own rulesets to make

import { logger, getLineColLocation } from '@redocly/openapi-core';
function formatRange(start, end) {
    const startStr = `Line ${start.line}, Col ${start.col}`;
    if (!end) {
        return startStr;
    }
    const endStr = `Line ${end.line}, Col ${end.col}`;
    return `${startStr} → ${endStr}`;
}
function getRuleUrl(ruleId) {
    if (!ruleId.includes('/')) {
        return `https://redocly.com/docs/cli/rules/oas/${ruleId}`;
    }
    return undefined;
}
function stripAnsiCodes(text) {
    // eslint-disable-next-line no-control-regex
    return text.replace(/\u001b\[\d+m/g, '');
}
export function printScorecardResultsAsJson(problems, achievedLevel, targetLevelAchieved, version = '1.0') {
    const groupedByLevel = {};
    for (const problem of problems) {
        const level = problem.scorecardLevel || 'Unknown';
        if (!groupedByLevel[level]) {
            groupedByLevel[level] = [];
        }
        groupedByLevel[level].push(problem);
    }
    const levels = [];
    for (const [levelName, levelProblems] of Object.entries(groupedByLevel)) {
        let errors = 0;
        let warnings = 0;
        const formattedProblems = levelProblems.map((problem) => {
            if (problem.severity === 'error')
                errors++;
            if (problem.severity === 'warn')
                warnings++;
            return {
                ruleId: problem.ruleId,
                ruleUrl: getRuleUrl(problem.ruleId),
                severity: problem.severity,
                message: stripAnsiCodes(problem.message),
                location: problem.location.map((loc) => {
                    const lineCol = getLineColLocation(loc);
                    return {
                        file: loc.source.absoluteRef,
                        range: formatRange(lineCol.start, lineCol.end),
                        pointer: loc.pointer,
                    };
                }),
            };
        });
        levels.push({
            name: levelName,
            total: {
                errors,
                warnings,
            },
            problems: formattedProblems,
        });
    }
    const output = {
        version,
        ...(targetLevelAchieved ? { level: achievedLevel } : {}),
        levels,
    };
    logger.output(JSON.stringify(output, null, 2));
    logger.info('\n');
}
//# sourceMappingURL=json-formatter.js.map