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

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

@@ -1,104 +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 Slug keyword assessment. This assessment checks if the keyword is present in the slug.
- */
-class KeyphraseAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object} config   The configuration to use.
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'keyphrase',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#use-of-main-keyword',
-      ctaType: 'fix',
-      fixPosition: 'keyword search',
-      priority: 'high',
-      title: 'Use of main keyword',
-      content: {
-        improve: '',
-        bad: 'No keywords found. Include keywords throughout the text.',
-        good: 'Main keyword is used effectively.'
-      }
-    };
-
-    this.identifier = 'keyphrase';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Executes the Assessment and returns 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) {
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    const calculatedResult = this.calculateResult(paper, i18n);
-
-    assessmentResult.setScore(calculatedResult.score);
-    assessmentResult.setStatus(calculatedResult.status);
-    assessmentResult.setBody(calculatedResult.body);
-    return assessmentResult;
-  }
-
-  /**
-   * Checks whether the paper has a keyword and a slug.
-   *
-   * @param {Paper}       paper       The paper to use for the assessment.
-   * @param {Researcher}  researcher  The researcher object.
-   *
-   * @returns {boolean} True if the paper contains a keyword and a slug, and if the keywordCountInSlug research is available on the researcher.
-   */
-  isApplicable(paper, researcher) {
-    return true;
-  }
-
-  /**
-   *
-   * @param paper
-   * @param i18n
-   * @returns {{score: number, body: React.JSX.Element, status: string}}
-   */
-  calculateResult(paper, i18n) {
-    const status = (() => {
-      const hasKeyphrase = paper.hasKeyword();
-
-      return hasKeyphrase ? 'good' : '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 KeyphraseAssessment;

package/src/scoring/assessments/seo/KeyphraseLengthAssessment.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 {countWords} from '../../../helpers';
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-/**
- * Assessment to check whether the keyphrase has a good length.
- */
-class KeyphraseLengthAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object} [config] The configuration to use.
-   *
-   * @returns {void}
-   */
-  constructor(config) {
-    super();
-
-    this.defaultConfig = {
-      id: 'keyphraseLength',
-      ctaType: 'fix',
-      priority: 'low',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-length',
-      fixPosition: 'keyword search',
-      icon: KeyIcon,
-      title: 'Keyword length',
-      content: {
-        improve: '',
-        bad: 'Keyword too long. Keep keyword length less than 4 words for readability.',
-        good: 'Keyword length is optimized, less than 4 words.'
-      }
-    };
-
-    this.identifier = 'keyphraseLength';
-    this._config = merge(this.defaultConfig, config);
-  }
-
-  /**
-   * Assesses the keyphrase presence and length.
-   *
-   * @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});
-
-    const calculatedResult = this.calculateResult(paper, i18n);
-
-    assessmentResult.setScore(calculatedResult.score);
-    assessmentResult.setStatus(calculatedResult.status);
-    assessmentResult.setBody(calculatedResult.body);
-
-    return assessmentResult;
-  }
-
-  /**
-   * Calculates the result based on the keyphraseLength research.
-   *
-   * @returns {Object} Object with score and text.
-   */
-  calculateResult(paper, i18n) {
-    const keywordLength = countWords(paper.getKeyword());
-
-    let status = '';
-    if (keywordLength <= 4) {
-      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>
-      )
-    };
-  }
-
-  /**
-   * Checks whether the paper has a text.
-   *
-   * @param {Paper}       paper       The paper to use for the assessment.
-   *
-   * @returns {boolean} True when there is text.
-   */
-  isApplicable(paper) {
-    return paper.hasKeyword();
-  }
-}
-
-export default KeyphraseLengthAssessment;

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

@@ -1,116 +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 {calculateKeywordDensity} from '../../../helpers';
-import keyphraseLengthFactor from '../../../scoring/helpers/assessments/keyphraseLengthFactor';
-
-/**
- * Represents the assessment that will look if the keyphrase density is within the recommended range.
- */
-class KeyphraseDensityAssessment extends Assessment {
-  /**
-   *
-   * @param config
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'keyphraseDensity',
-      fixPosition: 'highlightKeyword',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#main-keyword-density',
-      ctaType: 'fix',
-      priority: 'high',
-      content: {
-        good: 'Keyword density is optimized, between 1 - 1.5%.',
-        bad: 'Keep keyword density from 1% - 1.5%.',
-        improve: ''
-      }
-    };
-
-    this.identifier = 'keyphraseDensity';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Runs the keyphrase density 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 the research.
-   *
-   * @param i18n
-   * @returns {AssessmentResult} The result of the assessment.
-   */
-  getResult(paper, researcher, i18n) {
-    this._keyphraseCount = researcher.getResearch('getKeyphraseCount');
-    const keyphraseLength = this._keyphraseCount.keyphraseLength;
-
-    this._keyphraseDensity = researcher.getResearch('getKeyphraseDensity');
-    this._keyphraseDensity = this._keyphraseDensity * keyphraseLengthFactor(keyphraseLength);
-
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    const calculatedResult = this.calculateResult(paper, i18n);
-
-    assessmentResult.setScore(calculatedResult.score);
-    assessmentResult.setStatus(calculatedResult.status);
-    assessmentResult.setBody(calculatedResult.body);
-    assessmentResult.setTitle(calculatedResult.title);
-    return assessmentResult;
-  }
-
-  /**
-   * Returns the score for the keyphrase density.
-   *
-   * @returns {Object} The object with calculated score and resultText.
-   */
-  calculateResult(paper, i18n) {
-    const density = this._keyphraseDensity;
-    let status = '';
-    if (density < 1 || density > 1.5) {
-      status = 'bad';
-    }
-    if (density >= 1 && density <= 1.5) {
-      status = 'good';
-    }
-    const score = this.getScore(this._config.priority, status);
-
-    return {
-      title: 'Main keyword density' + ': ' + density.toFixed(2) + '%',
-      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>
-      )
-    };
-  }
-
-  /**
-   * Checks whether the paper has a text of the minimum required length and a keyphrase is set. 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 use for the assessment.
-   * @param {Researcher}  researcher  The paper to use for the assessment.
-   *
-   * @returns {boolean} True if applicable.
-   */
-  isApplicable(paper, researcher) {
-    return paper.hasText() && paper.hasKeyword();
-  }
-}
-
-export default KeyphraseDensityAssessment;

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

@@ -1,114 +0,0 @@
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-import {isNumber, merge} from 'lodash';
-import Assessment from '../assessment';
-import AssessmentResult from '../../../values/AssessmentResult';
-import {KeyIcon} from '@shopify/polaris-icons';
-import {isIncludes} from '../../../helpers';
-import matchTextWithWord from '../../../languageProcessing/helpers/match/matchTextWithWord';
-
-/**
- * Assessment for checking the keyword matches in the meta description.
- */
-class MetaDescriptionKeywordAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object} [config] The configuration to use.
-   * @param {number} [config.parameters.recommendedMinimum] The recommended minimum of keyword occurrences in the meta description.
-   * @param {number} [config.scores.good] The score to return if there are enough keyword occurrences in the meta description.
-   * @param {number} [config.scores.bad] The score to return if there aren't enough keyword occurrences in the meta description.
-   * @param {string} [config.url] The URL to the relevant article on Yoast.com.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'metaDescriptionKeyword',
-      priority: 'high',
-      fixPosition: 'meta description',
-      ctaType: 'fix',
-      docUrl: 'https://help.seoon.io/seo/seo-checklist',
-      icon: KeyIcon,
-      title: 'Meta description keyword',
-      content: {
-        bad: 'No keywords found in meta description. Add at least one to improve keyword rank.',
-        good: 'Keywords are included meta description.',
-        improve: ''
-      }
-    };
-
-    this.identifier = 'metaDescriptionKeyword';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Runs the metaDescriptionKeyword researcher and 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 assessment result.
-   */
-  getResult(paper, researcher, i18n) {
-    const assessmentResult = new AssessmentResult({config: this._config});
-    const calculatedResult = this.calculateResult(paper, i18n);
-
-    assessmentResult.setScore(calculatedResult.score);
-    assessmentResult.setStatus(calculatedResult.status);
-    assessmentResult.setBody(calculatedResult.body);
-
-    return assessmentResult;
-  }
-
-  /**
-   * Returns the result object based on the number of keyword matches in the meta description.
-   *
-   * @returns {Object} Result object with score and text.
-   */
-  calculateResult(paper, i18n) {
-    const keyword = paper.getKeyword();
-    const description = paper.getDescription();
-    const {count} = matchTextWithWord(description, keyword, paper.getLocale(), null);
-
-    let status = '';
-    if (isNumber(count) && count > 0) {
-      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>
-      )
-    };
-  }
-
-  /**
-   * Checks whether the paper has a keyword and a meta description.
-   *
-   * @param {Paper} paper The paper to use for the assessment.
-   *
-   * @returns {boolean} True if the paper has a keyword and a meta description.
-   */
-  isApplicable(paper) {
-    return paper.hasKeyword() && paper.hasDescription();
-  }
-}
-
-export default MetaDescriptionKeywordAssessment;

package/src/scoring/assessments/seo/MetaDescriptionLengthAssessment.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';
-
-/**
- * Assessment for calculating the length of the meta description.
- */
-export default class MetaDescriptionLengthAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object} [config] The configuration to use.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'metaDescriptionLength',
-      ctaType: 'fix',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#meta-description',
-      priority: 'high',
-      fixPosition: 'meta description',
-      title: 'Meta description length',
-      content: {
-        good: 'Meta description is optimized, less than 160 characters.',
-        improve: 'Write a unique and compelling description of 150-160 characters.',
-        bad:
-          'Missing meta description. Write a unique and compelling description under 160 characters.'
-      }
-    };
-
-    this.identifier = 'metaDescriptionLength';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Runs the metaDescriptionLength 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 assessment result.
-   */
-  getResult(paper, researcher, i18n) {
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    const calculatedResult = this.calculateResult(paper, i18n);
-
-    assessmentResult.setScore(calculatedResult.score);
-    assessmentResult.setStatus(calculatedResult.status);
-    assessmentResult.setBody(calculatedResult.body);
-
-    return assessmentResult;
-  }
-
-  /**
-   *
-   * @param paper
-   * @param i18n
-   * @returns {{score: number, body: React.JSX.Element, status: string}}
-   */
-  calculateResult(paper, i18n) {
-    const length = paper.getDescription().length;
-
-    let status = '';
-
-    if (length === 0) {
-      status = 'bad';
-    }
-    if (length > 0 && (length < 150 || length > 160)) {
-      status = 'improve';
-    }
-
-    if (length <= 160 && length >= 150) {
-      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>
-      )
-    };
-  }
-
-  /**
-   * Checks whether the paper has a text.
-   *
-   * @param {Paper}       paper       The paper to use for the assessment.
-   *
-   * @returns true
-   */
-  isApplicable(paper) {
-    return true;
-  }
-}

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

@@ -1,111 +0,0 @@
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-import {isNumber, merge} from 'lodash';
-import Assessment from '../assessment';
-import AssessmentResult from '../../../values/AssessmentResult';
-import matchTextWithWord from '../../../languageProcessing/helpers/match/matchTextWithWord';
-
-/**
- * Assessment for checking the keyword matches in the meta title.
- */
-export default class MetaTitleKeywordAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object} [config] The configuration to use.
-   * @param {number} [config.parameters.recommendedMinimum] The recommended minimum of keyword occurrences in the meta description.
-   * @param {number} [config.scores.good] The score to return if there are enough keyword occurrences in the meta description.
-   * @param {number} [config.scores.bad] The score to return if there aren't enough keyword occurrences in the meta description.
-   * @param {string} [config.url] The URL to the relevant article on Yoast.com.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'titleKeyword',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-in-title',
-      fixPosition: 'meta title',
-      ctaType: 'fix',
-      priority: 'high',
-      title: 'Keyword in meta title',
-      content: {
-        bad:
-          'No keywords found in meta title. Add one to improve keyword rank and click through rate.',
-        good: 'Keyword is included in meta title.',
-        improve: ''
-      }
-    };
-
-    this.identifier = 'titleKeyword';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Runs the metaDescriptionKeyword researcher and 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 assessment result.
-   */
-  getResult(paper, researcher, i18n) {
-    const assessmentResult = new AssessmentResult({config: this._config});
-    const calculatedResult = this.calculateResult(paper, i18n);
-
-    assessmentResult.setScore(calculatedResult.score);
-    assessmentResult.setStatus(calculatedResult.status);
-    assessmentResult.setBody(calculatedResult.body);
-
-    return assessmentResult;
-  }
-
-  /**
-   * Returns the result object based on the number of keyword matches in the meta description.
-   *
-   * @returns {Object} Result object with score and text.
-   */
-  calculateResult(paper, i18n) {
-    const keyword = paper.getKeyword();
-    const title = paper.getTitle();
-    const {count} = matchTextWithWord(title, keyword, paper.getLocale(), null);
-
-    let status = '';
-    if (isNumber(count) && count > 0) {
-      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>
-      )
-    };
-  }
-
-  /**
-   * Checks whether the paper has a keyword and a meta description.
-   *
-   * @param {Paper} paper The paper to use for the assessment.
-   *
-   * @returns {boolean} True if the paper has a keyword and a meta description.
-   */
-  isApplicable(paper) {
-    return paper.hasKeyword();
-  }
-}