ibm-openapi-validator/src/scoring-tool/index.js

Configurable and extensible validator/linter for OpenAPI documents

/**
 * Copyright 2024 IBM Corporation.
 * SPDX-License-Identifier: Apache2.0
 */

const {
  printCategorizedScoresTable,
  printScoringDataTable,
} = require('./output');
const { scoreResults } = require('./score');
const { computeMetrics } = require('./compute-metrics');

async function produceImpactScore(validatorResults, { apiDefinition, logger }) {
  const metrics = await computeMetrics(apiDefinition);
  logger.debug(`API scaling metrics: ${metrics.toString()}`);

  // Execute scoring logic.
  return scoreResults(validatorResults, metrics, logger);
}

function printScoreTables({ config }, { impactScore }) {
  printCategorizedScoresTable(impactScore);

  if (!config.summaryOnly) {
    printScoringDataTable(impactScore);
  }

  // Print a new line at the end to be consistent with other validator output.
  console.log();
}

module.exports = {
  produceImpactScore,
  printScoreTables,
};