yoastseo-dep/spec/specHelpers/parse/buildTree.js

Yoast clientside page analysis

import LanguageProcessor from "../../../src/parse/language/LanguageProcessor";
import { build } from "../../../src/parse/build";
import adapt from "../../../src/parse/build/private/adapt";
import { parseFragment } from "parse5";
import filterTree from "../../../src/parse/build/private/filterTree";
import permanentFilters from "../../../src/parse/build/private/alwaysFilterElements";
import { htmlEntitiesRegex } from "../../../src/helpers/htmlEntities";

/**
 * Builds an HTML tree for a given paper and researcher, and adds it to the paper.
 *
 * @param {Paper} paper The paper to which the tree will be added.
 * @param {Researcher} researcher The researcher.
 * @returns {void}
 */
export default function buildTree( paper, researcher ) {
	const languageProcessor = new LanguageProcessor( researcher );
	const shortcodes = paper._attributes && paper._attributes.shortcodes;
	paper.setTree( build( paper, languageProcessor, shortcodes ) );
}

/**
 * Builds an HTML tree for a given paper and researcher, and adds it to the paper.
 * @param {Paper} paper The paper to which the tree will be added.
 * @returns {void}
 */
export function buildTreeNoTokenize( paper ) {
	let html = paper.getText();
	// Change HTML entities like "&" to "#amp;" to prevent early conversion to "&" -- which would invalidate token positions.
	html = html.replace( htmlEntitiesRegex, "#$1" );

	let tree = adapt( parseFragment( html, { sourceCodeLocationInfo: true } ) );
	tree = filterTree( tree, permanentFilters );
	paper.setTree( tree );
}