@apideck/better-ajv-errors/src/lib/suggestions.ts

Human-friendly JSON Schema validation for APIs

import leven from 'leven';

export const getSuggestion = ({
  value,
  suggestions,
  format = (suggestion) => `Did you mean '${suggestion}'?`,
}: {
  value: string | null;
  suggestions: string[];
  format?: (suggestion: string) => string;
}): string => {
  if (!value) return '';
  const bestSuggestion = suggestions.reduce(
    (best, current) => {
      const distance = leven(value, current);
      if (best.distance > distance) {
        return { value: current, distance };
      }

      return best;
    },
    {
      distance: Infinity,
      value: '',
    }
  );

  return bestSuggestion.distance < value.length ? format(bestSuggestion.value) : '';
};