yoastseo/build/scoring/assessments/inclusiveLanguage/helpers/createRuleDescriptions.js

Yoast client-side content analysis

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.isPreceded = isPreceded;
exports.nonInclusiveWhenStandalone = void 0;
exports.notFollowed = notFollowed;
exports.notPreceded = notPreceded;
exports.notPrecededAndNotFollowed = notPrecededAndNotFollowed;
const nonInclusiveWhenStandalone = exports.nonInclusiveWhenStandalone = "Targeted when followed by a participle, a function word (other than a noun), or punctuation.";

/**
 * Creates a rule description for phrases that are only targeted when preceded by specific words.
 *
 * @param {string[]} precedenceExceptionList The list of words that should precede the non-inclusive phrase.
 *
 * @returns {string} The rule description.
 */
function isPreceded(precedenceExceptionList) {
  return "Targeted when preceded by '" + precedenceExceptionList.join("', '") + "'.";
}

/**
 * Creates a rule description for phrases that are targeted unless preceded by specific words.
 *
 * @param {string[]} precedenceExceptionList  The list of words that shouldn't precede the non-inclusive phrase.
 *
 * @returns {string} The rule description.
 */
function notPreceded(precedenceExceptionList) {
  return "Targeted unless preceded by '" + precedenceExceptionList.join("', '") + "'.";
}

/**
 * Creates a rule description for phrases that are targeted unless followed by specific words.
 *
 * @param {string[]} followingExceptionList  The list of words that shouldn't follow the non-inclusive phrase.
 *
 * @returns {string} The rule description.
 */
function notFollowed(followingExceptionList) {
  return "Targeted unless followed by '" + followingExceptionList.join("', '") + "'.";
}

/**
 * Creates a rule description for phrases that are targeted unless followed or preceded by specific words.
 *
 * @param {string[]} precedenceExceptionList  The list of words that shouldn't precede the non-inclusive phrase.
 * @param {string[]} followingExceptionList  The list of words that shouldn't follow the non-inclusive phrase.
 *
 * @returns {string} The rule description.
 */
function notPrecededAndNotFollowed(precedenceExceptionList, followingExceptionList) {
  return "Targeted unless preceded by '" + precedenceExceptionList.join("', '") + "' and/or followed by '" + followingExceptionList.join("', '") + "'.";
}
//# sourceMappingURL=createRuleDescriptions.js.map