engine.mjs

'use strict';

/**
 * Creates a linter engine instance to validate ApiDocMetadataEntry entries
 *
 * @param {import('./types').LintRule} rules Lint rules to validate the entries against
 */
const createLinterEngine = rules => {
  /**
   * Validates a ApiDocMetadataEntry entry against all defined rules
   *
   * @param {ApiDocMetadataEntry} entry
   * @returns {import('./types').LintIssue[]}
   */
  const lint = entry => {
    const issues = [];

    for (const rule of rules) {
      const ruleIssues = rule(entry);

      if (ruleIssues.length > 0) {
        issues.push(...ruleIssues);
      }
    }

    return issues;
  };

  /**
   * Validates an array of ApiDocMetadataEntry entries against all defined rules
   *
   * @param {ApiDocMetadataEntry[]} entries
   * @returns {import('./types').LintIssue[]}
   */
  const lintAll = entries => {
    const issues = [];

    for (const entry of entries) {
      issues.push(...lint(entry));
    }

    return issues;
  };

  return {
    lint,
    lintAll,
  };
};

export default createLinterEngine;