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

Yoast clientside page analysis

import { __, sprintf } from "@wordpress/i18n";
import { merge } from "lodash-es";

import { AssessmentResult, helpers, languageProcessing, Assessment, values } from "yoastseo-dep";

const { createAnchorOpeningTag } = helpers;
const { collectMarkingsInSentence } = languageProcessing;
const { Mark } = values;

/**
 * Represents the assessment that checks whether there are too many complex words in the text.
 * This assessment is not bundled in Yoast SEO.
 */
export default class WordComplexityAssessment extends Assessment {
	/**
	 * Sets the identifier and the config.
	 *
	 * @param {object} config The configuration to use.
	 *
	 * @returns {void}
	 */
	constructor( config = {} ) {
		super();

		const defaultConfig = {
			scores: {
				acceptableAmount: 6,
				goodAmount: 9,
			},
			urlTitle: "https://yoa.st/4ls",
			urlCallToAction: "https://yoa.st/4lt",
		};

		/*
		 * translators: This is the name of the 'Word complexity' readability assessment.
         * It appears before the feedback in the analysis, for example in the feedback string:
         * "Word complexity: You are not using too many complex words, which makes your text easy to read. Good job!"
         */
		this.name = __( "Word complexity", "wordpress-seo-premium" );
		this.identifier = "wordComplexity";
		this._config = merge( defaultConfig, config );

		// Creates an anchor opening tag for the shortlinks.
		this._config.urlTitle = createAnchorOpeningTag( this._config.urlTitle );
		this._config.urlCallToAction = createAnchorOpeningTag( this._config.urlCallToAction );
	}

	/**
	 * Scores the percentage of sentences including one or more transition words.
	 *
	 * @param {Paper} paper        The paper to use for the assessment.
	 * @param {Researcher} researcher   The researcher used for calling research.
	 *
	 * @returns {object} The Assessment result.
	 */
	getResult( paper, researcher ) {
		this._wordComplexity = researcher.getResearch( "wordComplexity" );

		const calculatedScore = this.calculateResult();
		const assessmentResult = new AssessmentResult();
		assessmentResult.setScore( calculatedScore.score );
		assessmentResult.setText( calculatedScore.resultText );
		assessmentResult.setHasMarks( calculatedScore.hasMarks );

		return assessmentResult;
	}

	/**
	 * Calculates word complexity word result.
	 *
	 * @returns {object} Object containing the score, the result text and the information whether there is a mark..
	 */
	calculateResult() {
		const complexWordsPercentage = this._wordComplexity.percentage;
		const hasMarks = complexWordsPercentage > 0;
		const assessmentLink = this._config.urlTitle + this.name + "</a>";

		if ( complexWordsPercentage < 10 ) {
			return {
				score: this._config.scores.goodAmount,
				hasMarks: hasMarks,
				resultText: sprintf(
					/* translators: %1$s expands to the title of the "Word complexity" assessment (translated to the current language)
					 and links to an article on yoast.com.*/
					__(
						// eslint-disable-next-line max-len
						"%1$s: You are not using too many complex words, which makes your text easy to read. Good job!",
						"wordpress-seo-premium"
					),
					assessmentLink
				),
			};
		}
		return {
			score: this._config.scores.acceptableAmount,
			hasMarks: hasMarks,
			resultText: sprintf(
				/* translators: %1$s expands to the title of the "Word complexity" assessment (translated to the current language)
					 and links to an article on yoast.com. %2$s expand to the percentage of the complex words found in the text.
					 %3$s expand to a link on yoast.com, %4$s expands to the anchor end tag. */
				__(
					// eslint-disable-next-line max-len
					"%1$s: %2$s of the words in your text are considered complex. %3$sTry to use shorter and more familiar words to improve readability%4$s.",
					"wordpress-seo-premium"
				),
				assessmentLink,
				complexWordsPercentage + "%",
				this._config.urlCallToAction,
				"</a>"
			),
		};
	}

	/**
	 * Marks text for the word complexity assessment.
	 *
	 * @param {Paper}       paper       The paper to use for the marking.
	 * @param {Researcher}  researcher  The researcher containing the necessary research.
	 *
	 * @returns {Array<Mark>} A list of marks that should be applied.
	 */
	getMarks( paper, researcher ) {
		const wordComplexityResults = researcher.getResearch( "wordComplexity" ).complexWords;
		const matchWordCustomHelper = researcher.getHelper( "matchWordCustomHelper" );
		const markings = [];

		wordComplexityResults.forEach( ( result ) => {
			const complexWords = result.complexWords;
			const sentence = result.sentence;

			if ( complexWords.length > 0 ) {
				markings.push(
					new Mark( {
						original: sentence,
						marked: collectMarkingsInSentence( sentence, complexWords, matchWordCustomHelper ),
					} )
				);
			}
		} );

		return markings;
	}

	/**
	 * Checks if the word complexity assessment is applicable to the paper.
	 *
	 * @param {Paper}       paper       The paper to check.
	 * @param {Researcher}  researcher  The researcher object.
	 *
	 * @returns {boolean} Returns true if the paper has text and the researcher has word complexity research.
	 */
	isApplicable( paper, researcher ) {
		return this.hasEnoughContentForAssessment( paper ) && researcher.hasResearch( "wordComplexity" );
	}
}