yoastseo-dep/src/languageProcessing/researches/h1s.js

Yoast clientside page analysis

/**
 * Gets all H1s in a text, including their content and their position information.
 *
 * @param {Paper} paper The paper for which to get the H1s.
 *
 * @returns {Array} An array with all H1s, their content and position.
 */
export default function( paper ) {
	const tree = paper.getTree();

	const h1Matches = tree.findAll( node => node.name === "h1" );

	return h1Matches
		.map( h1Match => (
			{
				tag: "h1",
				content: h1Match.findAll( node => node.name === "#text" ).map( textNode => textNode.value ).join( "" ),
				position: {
					startOffset: h1Match.sourceCodeLocation.startTag.endOffset,
					endOffset: h1Match.sourceCodeLocation.endTag.startOffset,
					clientId: h1Match.clientId || "",
				},
			}
		) )
		.filter( h1 => !! h1.content );
}