axyseo 2.0.0-alpha.0.0.4 → 2.0.0-alpha.0.0.5

package/src/scoring/assessments/readability/SentenceLengthInTextAssessment.js

@@ -1,186 +0,0 @@
-import {merge} from 'lodash';
-import React from 'react';
-import {Text} from '@shopify/polaris';
-import Assessment from '../assessment';
-import getTooLongSentences from '../../helpers/assessments/checkForTooLongSentences';
-import formatNumber from '../../../helpers/formatNumber';
-import {inRangeEndInclusive as inRange} from '../../helpers/assessments/inRange';
-import AssessmentResult from '../../../values/AssessmentResult';
-import {TextBlockIcon} from '@shopify/polaris-icons';
-
-/**
- * Represents the assessment that will calculate the length of sentences in the text.
- */
-class SentenceLengthInTextAssessment extends Assessment {
-  /**
-	 * Sets the identifier and the config.
-	 *
-	 * @param {object} config			The scoring configuration that should be used.
-	 * @param {boolean} isCornerstone	Whether cornerstone configuration should be used.
-	 * @param {boolean} isProduct		Whether product configuration should be used.
-
-	 * @returns {void}
-	 */
-  constructor(config = {}, isCornerstone = false, isProduct = false) {
-    super();
-
-    const defaultConfig = {
-      id: 'textSentenceLength',
-      priority: 'high',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#sentence-length',
-      ctaType: 'fix',
-      fixPosition: 'sentenceLength',
-      icon: TextBlockIcon,
-      recommendedLength: 20,
-      slightlyTooMany: 25,
-      farTooMany: 30,
-      title: 'Text Sentence Length',
-      content: {
-        improve: '',
-        bad:
-          'Sentence too long. Keep sentence length less than 20 words to improve readability and flow.',
-        good: 'Sentence length is optimized for readability, less than 20 words.'
-      }
-    };
-
-    this._config = merge(defaultConfig, config);
-    this.identifier = 'textSentenceLength';
-  }
-
-  /**
-   * Scores the percentage of sentences including more than the recommended number of words.
-   *
-   * @param {Paper} paper The paper to use for the assessment.
-   * @param {Researcher} researcher The researcher used for calling research.
-   *
-   * @param i18n
-   * @returns {AssessmentResult} The Assessment result.
-   */
-  getResult(paper, researcher, i18n) {
-    const sentences = researcher.getResearch('countSentencesFromText');
-    if (researcher.getConfig('sentenceLength')) {
-      this._config = this.getLanguageSpecificConfig(researcher);
-    }
-
-    const percentage = this.calculatePercentage(sentences);
-    const result = this.calculateResult(percentage, i18n);
-
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    assessmentResult.setScore(result.score);
-    assessmentResult.setStatus(result.status);
-    assessmentResult.setBody(result.body);
-
-    return assessmentResult;
-  }
-
-  /**
-   * Checks whether the paper has text.
-   *
-   * @param {Paper} paper The paper to use for the assessment.
-   *
-   * @returns {boolean} True when there is text.
-   */
-  isApplicable(paper) {
-    return this.hasEnoughContentForAssessment(paper);
-  }
-
-  /**
-   * Check if there is language-specific config, and if so, overwrite the current config with it.
-   *
-   * @param {Researcher} researcher The researcher to use.
-   *
-   * @returns {Object} The config that should be used.
-   */
-  getLanguageSpecificConfig(researcher) {
-    const currentConfig = this._config;
-    const languageSpecificConfig = researcher.getConfig('sentenceLength');
-
-    if (languageSpecificConfig.hasOwnProperty('recommendedLength')) {
-      currentConfig.recommendedLength = languageSpecificConfig.recommendedLength;
-    }
-
-    return currentConfig;
-  }
-
-  /**
-   * Calculates the percentage of sentences that are too long.
-   *
-   * @param {Array} sentences The sentences to calculate the percentage for.
-   * @returns {number} The calculates percentage of too long sentences.
-   */
-  calculatePercentage(sentences) {
-    let percentage = 0;
-
-    if (sentences.length !== 0) {
-      const tooLongTotal = this.countTooLongSentences(sentences);
-
-      percentage = formatNumber((tooLongTotal / sentences.length) * 100);
-    }
-
-    return percentage;
-  }
-
-  /**
-   *
-   * @param percentage
-   * @param i18n
-   * @returns {{score: number, body: React.JSX.Element, status: string}}
-   */
-  calculateResult(percentage, i18n) {
-    let status = '';
-    if (percentage <= this._config.recommendedLength) {
-      status = 'good';
-    }
-
-    if (percentage > this._config.recommendedLength) {
-      status = 'bad';
-    }
-
-    const score = this.getScore(this._config.priority, status);
-
-    this._config.content = {
-      improve: '',
-      bad: `Sentence too long. Keep sentence length less than ${this._config.recommendedLength} words to improve readability and flow.`,
-      good: `Sentence length is optimized for readability, less than ${this._config.recommendedLength} words.`
-    };
-
-    return {
-      score,
-      status,
-      body: (
-        <Text as={'span'}>
-          {this._config.content[status]}{' '}
-          {this._config.docUrl && (
-            <a href={this._config.docUrl} target="_blank" rel="noreferrer">
-              Learn more
-            </a>
-          )}
-        </Text>
-      )
-    };
-  }
-
-  /**
-   * Gets the sentences that are qualified as being too long.
-   *
-   * @param {array} sentences The sentences to filter through.
-   * @returns {array} Array with all the sentences considered to be too long.
-   */
-  getTooLongSentences(sentences) {
-    return getTooLongSentences(sentences, this._config.recommendedLength);
-  }
-
-  /**
-   * Get the total amount of sentences that are qualified as being too long.
-   *
-   * @param {Array} sentences The sentences to filter through.
-   * @returns {Number} The amount of sentences that are considered too long.
-   */
-  countTooLongSentences(sentences) {
-    return this.getTooLongSentences(sentences).length;
-  }
-}
-
-export default SentenceLengthInTextAssessment;

package/src/scoring/assessments/readability/TransitionWordsAssessment.js

@@ -1,168 +0,0 @@
-import {merge} from 'lodash';
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-import formatNumber from '../../../helpers/formatNumber';
-import {inRangeStartInclusive as inRange} from '../../helpers/assessments/inRange';
-import AssessmentResult from '../../../values/AssessmentResult';
-import Assessment from '../assessment';
-import removeHtmlBlocks from '../../../languageProcessing/helpers/html/htmlParser';
-import getWords from '../../../languageProcessing/helpers/word/getWords';
-import {filterShortcodesFromHTML} from '../../../languageProcessing/helpers';
-
-/**
- * Represents the assessment that checks whether there are enough transition words in the text.
- */
-export default class TransitionWordsAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {object} config The configuration to use.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'textTransitionWords',
-      fixPosition: 'longestParagraph',
-      ctaType: 'fix',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#use-of-transition-words',
-      priority: 'low',
-      applicableIfTextLongerThan: 200,
-      title: 'Use of transition words',
-      content: {
-        good: 'Transition words are used effectively.',
-        bad:
-          'Lack of transition words. Improve readability and flow by adding words like "however," "also," etc.',
-        improve: ''
-      }
-    };
-
-    this.identifier = 'textTransitionWords';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Calculates the actual percentage of transition words in the sentences.
-   *
-   * @param {object} sentences The object containing the total number of sentences and the number of sentences containing
-   * a transition word.
-   *
-   * @returns {number} The percentage of sentences containing a transition word.
-   */
-  calculateTransitionWordPercentage(sentences) {
-    if (sentences.transitionWordSentences === 0 || sentences.totalSentences === 0) {
-      return 0;
-    }
-
-    return formatNumber((sentences.transitionWordSentences / sentences.totalSentences) * 100);
-  }
-
-  /**
-   * Calculates the score for the assessment based on the percentage of sentences containing transition words.
-   *
-   * @param {number} percentage The percentage of sentences containing transition words.
-   *
-   * @returns {number} The score.
-   */
-  calculateScoreFromPercentage(percentage) {
-    if (percentage < 20) {
-      // Red indicator.
-      return 3;
-    }
-
-    if (inRange(percentage, 20, 30)) {
-      // Orange indicator.
-      return 6;
-    }
-
-    // Green indicator.
-    return 9;
-  }
-
-  /**
-   *
-   * @param transitionWordSentences
-   * @param i18n
-   * @returns {{score: number, body: React.JSX.Element, status: string}}
-   */
-  calculateTransitionWordResult(transitionWordSentences, i18n) {
-    const percentage = this.calculateTransitionWordPercentage(transitionWordSentences);
-    const score = this.calculateScoreFromPercentage(percentage);
-
-    let status = 'good';
-    if (score < 7 && percentage === 0) {
-      status = 'bad';
-    }
-
-    if (score < 7) {
-      status = 'bad';
-    }
-    const customScore = this.getScore(this._config.priority, status);
-
-    return {
-      score: customScore,
-      status,
-      body: (
-        <Text as={'span'}>
-          {this._config.content[status]}{' '}
-          {this._config.docUrl && (
-            <a href={this._config.docUrl} target="_blank" rel="noreferrer">
-              Learn more
-            </a>
-          )}
-        </Text>
-      )
-    };
-  }
-
-  /**
-   *
-   * @param paper
-   * @param researcher
-   * @param i18n
-   * @returns {AssessmentResult}
-   */
-  getResult(paper, researcher, i18n) {
-    const transitionWordSentences = researcher.getResearch('findTransitionWords');
-    const transitionWordResult = this.calculateTransitionWordResult(transitionWordSentences, i18n);
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    assessmentResult.setScore(transitionWordResult.score);
-    assessmentResult.setStatus(transitionWordResult.status);
-    assessmentResult.setBody(transitionWordResult.body);
-
-    return assessmentResult;
-  }
-
-  /**
-   * Checks if the transition words assessment is applicable to the paper. Language-specific length requirements and methods of counting text length
-   * may apply (e.g. for Japanese, the text should be counted in characters instead of words, which also makes the minimum required length higher).
-   *
-   * @param {Paper}       paper       The paper to check.
-   * @param {Researcher}  researcher  The researcher object.
-   *
-   * @returns {boolean} Returns true if the language is available, the paper is not empty and the text is longer than the minimum required length.
-   */
-  isApplicable(paper, researcher) {
-    const customCountLength = researcher.getHelper('customCountLength');
-    const customApplicabilityConfig = researcher.getConfig('assessmentApplicability')
-      .transitionWords;
-    if (customApplicabilityConfig) {
-      this._config.applicableIfTextLongerThan = customApplicabilityConfig;
-    }
-    let text = paper.getText();
-    text = removeHtmlBlocks(text);
-    text = filterShortcodesFromHTML(text, paper._attributes && paper._attributes.shortcodes);
-    const textLength = customCountLength ? customCountLength(text) : getWords(text).length;
-
-    // Do not use hasEnoughContent in this assessment as it is mostly redundant with `textLength >= this._config.applicableIfTextLongerThan`
-    return (
-      textLength >= this._config.applicableIfTextLongerThan &&
-      researcher.hasResearch('findTransitionWords')
-    );
-  }
-}

package/src/scoring/assessments/seo/ImageCountAssessment.js

@@ -1,112 +0,0 @@
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-import {merge} from 'lodash';
-
-import Assessment from '../assessment';
-import AssessmentResult from '../../../values/AssessmentResult';
-
-/**
- * Represents the assessment that checks if the text has any images present, including videos in product pages.
- */
-export default class TextImagesAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {object}  config      The configuration to use.
-   * @param {boolean} countVideos Whether videos are also included in the assessment or not.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}, countVideos = true) {
-    super();
-
-    const defaultConfig = {
-      id: 'images',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#images-and-videos',
-      priority: 'high',
-      fixPosition: 'description',
-      title: 'Media',
-      content: {
-        good: 'Media are used effectively.',
-        improve: '',
-        bad: 'No media found. Add visual content to enhance engagement.'
-      }
-    };
-
-    this.identifier = 'images';
-    this._config = merge(defaultConfig, config);
-    this._countVideos = countVideos;
-  }
-
-  /**
-   * Execute the Assessment and return a result.
-   *
-   * @param {Paper}       paper       The Paper object to assess.
-   * @param {Researcher}  researcher  The Researcher object containing all available researches.
-   *
-   * @param i18n
-   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.
-   */
-  getResult(paper, researcher, i18n) {
-    this.imageCount = researcher.getResearch('imageCount');
-    this.videoCount = researcher.getResearch('videoCount');
-
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    const calculatedResult = this.calculateResult(i18n);
-
-    assessmentResult.setScore(calculatedResult.score);
-    assessmentResult.setStatus(calculatedResult.status);
-    assessmentResult.setBody(calculatedResult.body);
-
-    return assessmentResult;
-  }
-
-  /**
-   * Checks whether the paper has text.
-   *
-   * @param {Paper}       paper       The paper to use for the assessment.
-   *
-   * @returns {boolean} True when there is text.
-   */
-  isApplicable(paper) {
-    return paper.hasText();
-  }
-
-  /**
-   * Calculate the result based on the availability of images in the text, including videos in product pages.
-   *
-   * @returns {Object} The calculated result.
-   */
-  calculateResult(i18n) {
-    // If "countVideos" is on, we include videos in the assessment
-    const mediaCount = this._countVideos ? this.imageCount + this.videoCount : this.imageCount;
-
-    let status = '';
-    // No images.
-    if (mediaCount === 0) {
-      status = 'bad';
-    } else {
-      status = 'good';
-    }
-
-    const score = this.getScore(this._config.priority, status);
-
-    return {
-      score,
-      status,
-      body: (
-        <Text as={'span'}>
-          {this._config.content[status]}{' '}
-          {this._config.docUrl && (
-            <a href={this._config.docUrl} target="_blank" rel="noreferrer">
-              Learn more
-            </a>
-          )}
-        </Text>
-      )
-    };
-  }
-}

package/src/scoring/assessments/seo/InternalLinksAssessment.js

@@ -1,114 +0,0 @@
-import {merge} from 'lodash';
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-import Assessment from '../assessment';
-import AssessmentResult from '../../../values/AssessmentResult';
-import {LinkIcon} from '@shopify/polaris-icons';
-
-/**
- * Assessment to check whether the text has internal links and whether they are followed or no-followed.
- */
-class InternalLinksAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object} [config] The configuration to use.
-   * @param {number} [config.parameters.recommendedMinimum] The recommended minimum number of internal links in the text.
-   * @param {number} [config.scores.allInternalFollow] The score to return if all internal links are do-follow.
-   * @param {number} [config.scores.someInternalFollow] The score to return if some but not all internal links are do-follow.
-   * @param {number} [config.scores.noneInternalFollow] The score to return if all internal links are no-follow.
-   * @param {number} [config.scores.noInternal] The score to return if there are no internal links.
-   * @param {string} [config.url] The URL to the relevant KB article.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'internalLinks',
-      fixPosition: '',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#internal-links-outbound-links',
-      icon: LinkIcon,
-      priority: 'high',
-      title: 'Internal links',
-      content: {
-        good: 'Internal links are used effectively.',
-        improve: '',
-        bad: 'No internal links found. Add links to other relevant pages on your website.'
-      }
-    };
-
-    this.identifier = 'internalLinks';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Runs the getLinkStatistics module, based on this returns an assessment result with score.
-   *
-   * @param {Paper} paper The paper to use for the assessment.
-   * @param {Researcher} researcher The researcher used for calling research.
-   * @param i18n
-   * @returns {AssessmentResult} The result of the assessment.
-   */
-  getResult(paper, researcher, i18n) {
-    this.linkStatistics = researcher.getResearch('getLinkStatistics');
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    const calculatedResult = this.calculateResult(i18n);
-    assessmentResult.setScore(calculatedResult.score);
-    assessmentResult.setStatus(calculatedResult.status);
-    assessmentResult.setBody(calculatedResult.body);
-
-    return assessmentResult;
-  }
-
-  /**
-   * Checks if assessment is applicable to the paper.
-   *
-   * @param {Paper} paper The paper to be analyzed.
-   *
-   * @returns {boolean} Whether the paper has text.
-   */
-  isApplicable(paper) {
-    return paper.hasText();
-  }
-
-  /**
-   * Returns a score and text based on the linkStatistics object.
-   *
-   * @returns {Object} ResultObject with score and text
-   */
-  calculateResult(i18n) {
-    let status = '';
-    if (
-      this.linkStatistics.internalTotal === 0 ||
-      this.linkStatistics.internalNofollow === this.linkStatistics.internalTotal
-    ) {
-      status = 'bad';
-    } else {
-      status = 'good';
-    }
-
-    const score = this.getScore(this._config.priority, status);
-
-    return {
-      score,
-      status,
-      body: (
-        <Text as={'span'}>
-          {this._config.content[status]}{' '}
-          {this._config.docUrl && (
-            <a href={this._config.docUrl} target="_blank" rel="noreferrer">
-              Learn more
-            </a>
-          )}
-        </Text>
-      )
-    };
-  }
-}
-
-export default InternalLinksAssessment;

package/src/scoring/assessments/seo/IntroductionKeywordAssessment.js

@@ -1,110 +0,0 @@
-import {merge} from 'lodash';
-
-import Assessment from '../assessment';
-import AssessmentResult from '../../../values/AssessmentResult';
-import {KeyIcon} from '@shopify/polaris-icons';
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-/**
- * Assessment to check whether the keyphrase or synonyms are encountered in the first paragraph of the article.
- */
-class IntroductionKeywordAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object} [config] The configuration to use.
-   * @param {string} [config.url] The URL to the relevant article on Yoast.com.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'introductionKeyword',
-      ctaType: 'fix',
-      priority: 'low',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-in-introduction',
-      fixPosition: 'highlightFirstParagraph',
-      icon: KeyIcon,
-      title: 'Introduction Keyword',
-      content: {
-        improve: '',
-        bad: 'No keywords found in the first sentence. Add one to improve keyword rank.',
-        good: 'Keyword is included in the first sentence.'
-      }
-    };
-
-    this.identifier = 'introductionKeyword';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Assesses the presence of keyphrase or synonyms in the first paragraph.
-   *
-   * @param {Paper} paper The paper to use for the assessment.
-   * @param {Researcher} researcher The researcher used for calling research.
-   *
-   * @param i18n
-   * @returns {AssessmentResult} The result of this assessment.
-   */
-  getResult(paper, researcher, i18n) {
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    this._firstParagraphMatches = researcher.getResearch('findKeywordInFirstParagraph');
-    const calculatedResult = this.calculateResult();
-
-    assessmentResult.setScore(calculatedResult.score);
-    assessmentResult.setStatus(calculatedResult.status);
-    assessmentResult.setBody(calculatedResult.body);
-
-    return assessmentResult;
-  }
-
-  /**
-   * Checks if the paper has both keyword and text.
-   *
-   * @param {Paper} paper The paper to be analyzed.
-   *
-   * @returns {boolean} Whether the assessment is applicable or not.
-   */
-  isApplicable(paper) {
-    return paper.hasKeyword() && paper.hasText();
-  }
-
-  /**
-   * Returns a result based on the number of occurrences of keyphrase in the first paragraph.
-   *
-   * @returns {Object} result object with a score and translation text.
-   */
-  calculateResult() {
-    let status = '';
-
-    if (this._firstParagraphMatches.foundInOneSentence) {
-      status = 'good';
-    } else {
-      status = 'bad';
-    }
-
-    const score = this.getScore(this._config.priority, status);
-
-    return {
-      score,
-      status,
-      body: (
-        <Text as={'span'}>
-          {this._config.content[status]}{' '}
-          {this._config.docUrl && (
-            <a href={this._config.docUrl} target="_blank" rel="noreferrer">
-              Learn more
-            </a>
-          )}
-        </Text>
-      )
-    };
-  }
-}
-
-export default IntroductionKeywordAssessment;