yoastseo-dep/src/scoring/assessments/readability/TextPresenceAssessment.js

Yoast clientside page analysis

import { __, sprintf } from "@wordpress/i18n";
import { createAnchorOpeningTag } from "../../../helpers/shortlinker";
import AssessmentResult from "../../../values/AssessmentResult";
import Assessment from "../assessment";
import { merge } from "lodash-es";

/**
 * Represents the assessment that checks whether there is enough text in the paper.
 */
export default class TextPresenceAssessment extends Assessment {
	/**
	 * Sets the identifier and the config.
	 *
	 * @param {object} config The configuration to use.
	 *
	 * @returns {void}
	 */
	constructor( config = {} ) {
		super();

		const defaultConfig = {
			urlTitle: createAnchorOpeningTag( "https://yoa.st/35h" ),
			urlCallToAction: createAnchorOpeningTag( "https://yoa.st/35i" ),
		};

		this.identifier = "textPresence";
		this._config = merge( defaultConfig, config );
	}

	/**
	 * Assesses that the paper has at least a little bit of content.
	 *
	 * @param {Paper} paper The paper to assess.
	 *
	 * @returns {AssessmentResult} The result of this assessment.
	 */
	getResult( paper ) {
		if ( ! this.hasEnoughContentForAssessment( paper ) ) {
			const result = new AssessmentResult();

			result.setText( sprintf(
				/* translators: %1$s and %3$s expand to links to articles on Yoast.com,
				%2$s expands to the anchor end tag*/
				__(
					"%1$sNot enough content%2$s: %3$sPlease add some content to enable a good analysis%2$s.",
					"wordpress-seo"
				),
				this._config.urlTitle,
				"</a>",
				this._config.urlCallToAction ) );

			result.setScore( 3 );
			return result;
		}

		return new AssessmentResult();
	}
}