yoastseo-dep/src/languageProcessing/helpers/word/includesIndex.js

Yoast clientside page analysis

import { forEach, includes, isEmpty } from "lodash-es";

/**
 * Checks whether a given word is directly preceded by a word from a list of words.
 *
 * @param {Array} precedingWords    The array of objects with matches and indices.
 * @param {number} matchIndex       The index of the word for which to check whether it's preceded by one of the other words.
 * @param {boolean} addSpace        True if a space should be added.
 *
 * @returns {boolean} Returns true if the match is preceded by a given word, otherwise returns false.
 */
export default function( precedingWords, matchIndex, addSpace = true ) {
	/*
	1 if there is a space between the match and the preceding word
	(because the end word boundary is not included in the match).
	0 if the preceding word is a contraction.
	*/
	const space = addSpace ? 1 : 0;

	if ( isEmpty( precedingWords ) ) {
		return false;
	}

	const precedingWordsEndIndices = [];
	forEach( precedingWords, function( precedingWord ) {
		const precedingWordsEndIndex = precedingWord.index + precedingWord.match.length + space;
		precedingWordsEndIndices.push( precedingWordsEndIndex );
	} );
	return includes( precedingWordsEndIndices, matchIndex );
}