axyseo 2.0.0-alpha.0.0.4 → 2.0.0-alpha.0.0.6

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

@@ -1,107 +0,0 @@
-import {merge} from 'lodash';
-import {Text} from '@shopify/polaris';
-
-import Assessment from '../assessment';
-import AssessmentResult from '../../../values/AssessmentResult';
-
-/**
- * Represents the assessment that assesses the SEO title width and gives the feedback accordingly.
- */
-export default class NumberInMetaTitleAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object}  [config]        The configuration to use.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'numberTitle',
-      ctaType: 'fix',
-      status: 'good',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#using-number-in-title',
-      priority: 'high',
-      fixPosition: 'meta title',
-      title: 'Number in meta title',
-      content: {
-        good: 'Number is used effectively in the title tag.',
-        improve: '',
-        bad: 'No number found in title tag. Consider adding a number to make it more engaging.'
-      }
-    };
-
-    this.identifier = 'numberTitle';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Runs the h1 research and based on this returns an assessment result with a 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 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 title = paper.getTitle();
-
-    let status = '';
-    if (!/\d/.test(title)) {
-      status = 'bad';
-    }
-
-    if (!title || /\d/.test(title)) {
-      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 {boolean} True when there is text.
-   */
-  isApplicable(paper) {
-    return paper.hasTitle();
-  }
-}

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

@@ -1,111 +0,0 @@
-import {isEmpty, merge} from 'lodash';
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-import Assessment from '../assessment';
-import AssessmentResult from '../../../values/AssessmentResult';
-import {ExternalIcon} from '@shopify/polaris-icons';
-
-/**
- * Assessment for calculating the outbound links in the text.
- */
-export default class OutboundLinksAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object} [config] The configuration to use.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'externalLinks',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#internal-links-outbound-links',
-      fixPosition: 'description',
-      icon: ExternalIcon,
-      title: 'External links',
-      priority: 'high',
-      content: {
-        improve: '',
-        good: 'External links are used effectively.',
-        bad: 'No external links found. Add relevant links to be more authoritative and informative.'
-      }
-    };
-
-    this.identifier = 'externalLinks';
-    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 assessment result.
-   */
-  getResult(paper, researcher, i18n) {
-    const linkStatistics = researcher.getResearch('getLinkStatistics');
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    const calculatedResult = this.calculateResult(linkStatistics, i18n);
-
-    if (!isEmpty(linkStatistics)) {
-      assessmentResult.setScore(calculatedResult.score);
-      assessmentResult.setStatus(calculatedResult.status);
-      assessmentResult.setBody(calculatedResult.body);
-    }
-    return assessmentResult;
-  }
-
-  /**
-   * Checks whether 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();
-  }
-
-  /**
-   *
-   * @param linkStatistics
-   * @param i18n
-   * @returns {{score: number, body: React.JSX.Element, status: string}}
-   */
-  calculateResult(linkStatistics, i18n) {
-    let status = '';
-    if (linkStatistics.externalTotal === 0) {
-      status = 'bad';
-    } else if (linkStatistics.externalNofollow === linkStatistics.externalTotal) {
-      status = 'bad';
-    } else if (linkStatistics.externalDofollow < linkStatistics.externalTotal) {
-      status = 'good';
-    } else if (linkStatistics.externalDofollow === linkStatistics.externalTotal) {
-      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/PageTitleWidthAssessment.js

@@ -1,104 +0,0 @@
-import {merge} from 'lodash';
-import {Text} from '@shopify/polaris';
-
-import Assessment from '../assessment';
-import AssessmentResult from '../../../values/AssessmentResult';
-
-/**
- * Represents the assessment that assesses the SEO title width and gives the feedback accordingly.
- */
-export default class PageTitleWidthAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object}  [config]        The configuration to use.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'titleWidth',
-      fixPosition: 'meta title',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#title-width',
-      ctaType: 'fix',
-      priority: 'high',
-      title: 'Meta title width',
-      content: {
-        good: 'Title width is optimized, between 50 - 70 characters.',
-        improve: '',
-        bad:
-          'Title too long or too short. Aim for 50-70 characters for best display in search results.'
-      }
-    };
-
-    this.identifier = 'titleWidth';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Runs the h1 research and based on this returns an assessment result with a 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 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.getTitle().length;
-
-    let status = '';
-    if (length <= 70 && length >= 50) {
-      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.hasTitle();
-  }
-}

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

@@ -1,118 +0,0 @@
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-import {isUndefined, merge} from 'lodash';
-
-import Assessment from '../assessment.js';
-import AssessmentResult from '../../../values/AssessmentResult.js';
-
-/**
- * Assessment to check whether the body of the text contains more than 1 H1s in the body.
- * This assessment doesn't penalize H1 that is not in the very beginning of the body.
- */
-class SingleH1Assessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object} config The configuration to use.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'singleH1',
-      docUrl: 'https://help.seoon.io/seo/seo-checklist',
-      fixPosition: 'description',
-      ctaType: 'contactUs',
-      priority: 'high',
-      title: 'H1 tag',
-      content: {
-        good: 'H1 tag is optimized.',
-        improve: 'You should use only one H1 tag',
-        bad: 'Missing H1 tag. Add one H1 to clearly define your page`s topic.'
-      }
-    };
-
-    this.identifier = 'singleH1';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Runs the h1 research and based on this returns an assessment result with a 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 assessment result.
-   */
-  getResult(paper, researcher, i18n) {
-    this._h1Count = researcher.getResearch('h1s');
-
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    const calculatedResult = this.calculateResult(paper, i18n);
-
-    if (!isUndefined(calculatedResult)) {
-      assessmentResult.setScore(calculatedResult.score);
-      assessmentResult.setStatus(calculatedResult.status);
-      assessmentResult.setBody(calculatedResult.body);
-    }
-
-    return assessmentResult;
-  }
-
-  /**
-   * Returns the score and the feedback string for the single H1 assessment.
-   *
-   * @returns {Object|null} The calculated score and the feedback string.
-   */
-  calculateResult(paper, i18n) {
-    const htmlString = paper.getText();
-    const desHasH1Tag = htmlString.includes('<h1>');
-
-    let status = '';
-    if (this._h1Count === 1) {
-      status = 'good';
-    }
-
-    if (this._h1Count === 0 && !desHasH1Tag) {
-      status = 'good';
-    }
-
-    if (this._h1Count > 1) {
-      status = 'improve';
-    }
-
-    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.hasText();
-  }
-}
-
-export default SingleH1Assessment;

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

@@ -1,108 +0,0 @@
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-import {isUndefined, merge} from 'lodash';
-
-import Assessment from '../assessment.js';
-import AssessmentResult from '../../../values/AssessmentResult.js';
-
-/**
- * Assessment to check whether the body of the text contains more than 1 H1s in the body.
- * This assessment doesn't penalize H1 that is not in the very beginning of the body.
- */
-class SingleTitleAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {Object} config The configuration to use.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'singleTitle',
-      docUrl: 'https://help.seoon.io/seo/seo-checklist',
-      ctaType: 'contactUs',
-      priority: 'high',
-      title: 'Duplicate title',
-      content: {
-        improve: '',
-        bad: 'Found duplicate titles. Check your content and create unique titles.',
-        good: 'No duplicate titles found.'
-      }
-    };
-
-    this.identifier = 'singleTitle';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Runs the h1 research and based on this returns an assessment result with a 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 assessment result.
-   */
-  getResult(paper, researcher, i18n) {
-    const assessmentResult = new AssessmentResult({config: this._config});
-
-    const calculatedResult = this.calculateResult(paper, i18n);
-
-    if (!isUndefined(calculatedResult)) {
-      assessmentResult.setScore(calculatedResult.score);
-      assessmentResult.setStatus(calculatedResult.status);
-      assessmentResult.setBody(calculatedResult.body);
-    }
-
-    return assessmentResult;
-  }
-
-  /**
-   * Returns the score and the feedback string for the single H1 assessment.
-   *
-   * @returns {Object|null} The calculated score and the feedback string.
-   */
-  calculateResult(paper, i18n) {
-    const count = paper.getTitleCount();
-
-    let status = '';
-    if (count === 1) {
-      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.hasTitle();
-  }
-}
-
-export default SingleTitleAssessment;

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

@@ -1,107 +0,0 @@
-import React from 'react';
-import {Text} from '@shopify/polaris';
-
-import {merge} from 'lodash';
-import Assessment from '../assessment';
-import AssessmentResult from '../../../values/AssessmentResult';
-import {containsKeywordInSubheadings} from '../../../helpers';
-
-/**
- * Represents the assessment that checks if the keyword is present in one of the subheadings.
- */
-export default class SubHeadingsKeywordAssessment extends Assessment {
-  /**
-   * Sets the identifier and the config.
-   *
-   * @param {object} config The configuration to use.
-   *
-   * @returns {void}
-   */
-  constructor(config = {}) {
-    super();
-
-    const defaultConfig = {
-      id: 'subheadingsKeyword',
-      ctaType: 'fix',
-      docUrl:
-        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-in-subheading',
-      priority: 'medium',
-      fixPosition: 'subheading',
-      title: 'Keyword in Subheading',
-      content: {
-        good: 'Keywords are included in subheadings.',
-        bad:
-          'Keyword not found in any subheadings. Include it in at least one subheading (H2, H3, etc.).',
-        improve: ''
-      }
-    };
-
-    this.identifier = 'subheadingsKeyword';
-    this._config = merge(defaultConfig, config);
-  }
-
-  /**
-   * Runs the h1 research and based on this returns an assessment result with a 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 assessment result.
-   */
-  getResult(paper, researcher, i18n) {
-    this._subHeadings = researcher.getResearch('matchKeywordInSubheadings');
-
-    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) {
-    let status = '';
-    if (this._subHeadings.match > 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 text.
-   *
-   * @param {Paper}       paper       The paper to use for the assessment.
-   *
-   * @returns {boolean} True when there is text.
-   */
-  isApplicable(paper) {
-    return paper.hasKeyword();
-  }
-}