yoastseo/build/scoring/assessments/readability/PassiveVoiceAssessment.js

Yoast client-side content analysis

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;
var _i18n = require("@wordpress/i18n");
var _lodash = require("lodash");
var _formatNumber = _interopRequireDefault(require("../../../helpers/formatNumber"));
var _inRange = require("../../helpers/assessments/inRange");
var _addMark = _interopRequireDefault(require("../../../markers/addMark"));
var _helpers = require("../../../helpers");
var _stripHTMLTags = require("../../../languageProcessing/helpers/sanitize/stripHTMLTags");
var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
var _Mark = _interopRequireDefault(require("../../../values/Mark"));
var _assessment = _interopRequireDefault(require("../assessment"));
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
/**
 * @typedef {import("../../../languageProcessing/AbstractResearcher").default } Researcher
 * @typedef {import("../../../values/").Paper } Paper
 */

/**
 * Represents the assessment that checks whether there are passive sentences in the text.
 */
class PassiveVoiceAssessment extends _assessment.default {
  /**
   * Sets the identifier and the config.
   *
   * @param {object} config The configuration to use.
   */
  constructor(config = {}) {
    super();
    const defaultConfig = {
      urlTitle: (0, _helpers.createAnchorOpeningTag)("https://yoa.st/34t"),
      urlCallToAction: (0, _helpers.createAnchorOpeningTag)("https://yoa.st/34u")
    };
    this.identifier = "passiveVoice";
    this._config = (0, _lodash.merge)(defaultConfig, config);
  }

  /**
   * Calculates the result based on the number of sentences and passives.
   *
   * @param {{total: number, passives:{length: number, total: number}}} passiveVoice Object containing the number of sentences and passives.
   *
   * @returns {{score: number, text: string, hasMarks: boolean}} Result object with score and text, and whether there are marks.
   */
  calculatePassiveVoiceResult(passiveVoice) {
    let score = 0;
    let percentage = 0;
    const recommendedValue = 10;

    // Prevent division by zero errors.
    if (passiveVoice.total !== 0) {
      percentage = (0, _formatNumber.default)(passiveVoice.passives.length / passiveVoice.total * 100);
    }
    const hasMarks = percentage > 0;
    if (percentage <= 10) {
      // Green indicator.
      score = 9;
    }
    if ((0, _inRange.inRangeEndInclusive)(percentage, 10, 15)) {
      // Orange indicator.
      score = 6;
    }
    if (percentage > 15) {
      // Red indicator.
      score = 3;
    }
    if (score >= 7) {
      return {
        score: score,
        hasMarks: hasMarks,
        text: (0, _i18n.sprintf)(/* translators: %1$s expands to a link on yoast.com, %2$s expands to the anchor end tag. */
        (0, _i18n.__)("%1$sPassive voice%2$s: You are not using too much passive voice. That's great!", "wordpress-seo"), this._config.urlTitle, "</a>")
      };
    }
    return {
      score: score,
      hasMarks: hasMarks,
      text: (0, _i18n.sprintf)(
      /* translators: %1$s and %5$s expand to a link on yoast.com, %2$s expands to the anchor end tag,
      %3$s expands to the percentage of sentences in passive voice, %4$s expands to the recommended value. */
      (0, _i18n.__)("%1$sPassive voice%2$s: %3$s of the sentences contain passive voice, which is more than the recommended maximum of %4$s. %5$sTry to use their active counterparts%2$s.", "wordpress-seo"), this._config.urlTitle, "</a>", percentage + "%", recommendedValue + "%", this._config.urlCallToAction)
    };
  }

  /**
   * Marks all sentences that have the passive voice.
   *
   * @param {Paper} paper The paper to use for the assessment.
   * @param {Researcher} researcher The researcher used for calling research.
   *
   * @returns {Mark[]} All marked sentences.
   */
  getMarks(paper, researcher) {
    const passiveVoice = researcher.getResearch("getPassiveVoiceResult");
    return (0, _lodash.map)(passiveVoice.passives, function (sentence) {
      sentence = (0, _stripHTMLTags.stripIncompleteTags)(sentence);
      const marked = (0, _addMark.default)(sentence);
      return new _Mark.default({
        original: sentence,
        marked: marked
      });
    });
  }

  /**
   * Runs the passiveVoice module, based on this returns an assessment result with score and text.
   *
   * @param {Paper} paper The paper to use for the assessment.
   * @param {Researcher} researcher The researcher used for calling research.
   *
   * @returns {AssessmentResult} The result of the assessment.
   */
  getResult(paper, researcher) {
    const passiveVoice = researcher.getResearch("getPassiveVoiceResult");
    const passiveVoiceResult = this.calculatePassiveVoiceResult(passiveVoice);
    const assessmentResult = new _AssessmentResult.default();
    assessmentResult.setScore(passiveVoiceResult.score);
    assessmentResult.setText(passiveVoiceResult.text);
    assessmentResult.setHasMarks(passiveVoiceResult.hasMarks);
    return assessmentResult;
  }

  /**
   * Checks if passive voice analysis is available for the language of the paper.
   *
   * @param {Paper}       paper       The paper to check.
   * @param {Researcher}  researcher  The researcher object.
   *
   * @returns {boolean} Returns true if the researcher has the passive voice research.
   */
  isApplicable(paper, researcher) {
    return researcher.hasResearch("getPassiveVoiceResult");
  }
}
exports.default = PassiveVoiceAssessment;
//# sourceMappingURL=PassiveVoiceAssessment.js.map