Function closestFilters

curriculum/src/filter.ts:199–248

(
  superblocks: Filterable[],
  target?: Filter
)

}

export function closestFilters(
  superblocks: Filterable[],
  target?: Filter
): Filter | undefined {
  // This is subjective, but should allow through typos while rejecting overly vague or unrelated filters.
  const diceSorensenThreshold = 0.7;

  if (target?.superBlock) {
    const superblockNames = superblocks.map(({ name }) => name);

    // If there are multiple superblocks, do not attempt to find a closest match.
    if (target.superBlock.includes(',')) {
      return target;
    }

    const { closest, score } = closestMatch(target.superBlock, superblockNames);

    if (score < diceSorensenThreshold) {
      throw Error(
        `No close match found for superBlock: ${target.superBlock}. Found "${closest}", is that what you meant?`
      );
    }

    return {
      ...target,
      superBlock: closest
    };
  }

  if (target?.block) {
    const blocks = superblocks.flatMap(({ blocks }) =>
      blocks.map(({ dashedName }) => dashedName)
    );

    const { closest, score } = closestMatch(target.block, blocks);

    if (score < diceSorensenThreshold) {
      throw Error(
        `No close match found for block: ${target.block}. Found "${closest}", is that what you meant?`
      );
    }

    return {
      ...target,
      block: closest
    };
  }

  return target;
}