axyseo 2.0.0-alpha.0.0.20 → 2.0.0-alpha.0.0.4

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

@@ -0,0 +1,144 @@
+import {merge} from 'lodash';
+import {Text} from '@shopify/polaris';
+import React from 'react';
+
+import Assessment from '../assessment';
+import AssessmentResult from '../../../values/AssessmentResult';
+import {checkMissingAlt} from '../../../helpers';
+import {ExternalIcon} from '@shopify/polaris-icons';
+
+/**
+ * Represents the assessment that assesses the SEO title width and gives the feedback accordingly.
+ */
+export default class TextImagesAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object}  [config]        The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+
+    const defaultConfig = {
+      id: 'textImages',
+      ctaType: 'fix',
+      docUrl:
+        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#alt-text',
+      fixPosition: 'description',
+      icon: ExternalIcon,
+      priority: 'high',
+      title: 'Alt text',
+      content: {
+        good: 'All images have descriptive and relevant alt text.',
+        improve: '',
+        bad: 'Missing alt text. Add descriptive alt text for accessibility and SEO.'
+      }
+    };
+
+    this.identifier = 'textImages';
+    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});
+    this.altTagsProperties = researcher.getResearch('altTagCount');
+    this.imageCount = researcher.getResearch('imageCount');
+
+    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 imagesNoAlt = this.altTagsProperties.noAlt;
+
+    let status = '';
+    if (imagesNoAlt === this.imageCount || imagesNoAlt > 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>
+      )
+    };
+  }
+
+  /**
+   *
+   * @param shop
+   * @param data
+   * @returns {string}
+   */
+  fix({shop, data}) {
+    if (!shop) {
+      console.log('Shop is missing');
+      return data.body || '';
+    }
+
+    if (!data.body) {
+      console.log('body is missing');
+      return '';
+    }
+
+    const altText = shop?.name || 'Shop' + ' | ' + data?.title || 'Title';
+
+    const parser = new DOMParser();
+    const doc = parser.parseFromString(data.body, 'text/html');
+
+    const imgTags = doc.querySelectorAll('img');
+
+    imgTags.forEach(img => {
+      if (!img.hasAttribute('alt') || img.getAttribute('alt') === '') {
+        img.setAttribute('alt', altText);
+      }
+    });
+
+    return doc.body.innerHTML;
+  }
+
+  /**
+   * Checks whether the paper has a text.
+   *
+   * @param {Paper}       paper       The paper to use for the assessment.
+   * @param researcher
+   * @returns {boolean} True when there is text.
+   */
+  isApplicable(paper, researcher) {
+    this.imageCount = researcher.getResearch('imageCount');
+    return paper.hasText() && this.imageCount > 0;
+  }
+}

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

@@ -0,0 +1,100 @@
+import {merge} from 'lodash';
+import React from 'react';
+import {Text} from '@shopify/polaris';
+
+import Assessment from '../assessment';
+import AssessmentResult from '../../../values/AssessmentResult';
+import {countWordInHtml} from '../../../helpers';
+
+/**
+ * Represents an assessment that checks the length of the text and gives feedback accordingly.
+ */
+export default class TextLengthAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+
+    const defaultConfig = {
+      id: 'textLength',
+      ctaType: 'fix',
+      docUrl:
+        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#text-length',
+      priority: 'high',
+      fixPosition: 'description',
+      title: 'Text length',
+      content: {
+        good: 'Text length is optimized.',
+        improve:
+          'Content length is acceptable, but could be expanded to 2,500 characters for more value.',
+        bad:
+          'Insufficient content. Aim for at least 600 words to provide value and rank well in search results.'
+      }
+    };
+
+    this.identifier = 'textLength';
+    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 calculatedResult = this.calculateResult(paper, i18n);
+
+    const assessmentResult = new AssessmentResult({config: this._config});
+    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 {wordCount, charCount} = countWordInHtml(paper.getText(), true);
+    let status = 'bad';
+    if (charCount < 2500 && wordCount >= 600) {
+      status = 'improve';
+    }
+    if (wordCount < 600 && charCount < 2500) {
+      status = 'bad';
+    }
+    if (charCount >= 2500 && wordCount >= 600) {
+      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/UrlKeywordAssessment.js

@@ -0,0 +1,111 @@
+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 SlugKeywordAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} config   The configuration to use.
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+
+    const defaultConfig = {
+      id: 'slugKeyword',
+      docUrl:
+        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-in-url',
+      fixPosition: 'url handle',
+      ctaType: 'fix',
+      priority: 'medium',
+      title: 'Keyword in URL',
+      content: {
+        good: 'Keyword is included in URL.',
+        improve: '',
+        bad: 'Missing keyword in URL. Include it for relevance and better SEO.'
+      }
+    };
+
+    this.identifier = 'slugKeyword';
+    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) {
+    this._keywordInSlug = researcher.getResearch('keywordCountInSlug');
+
+    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 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 (
+      !paper.isFrontPage() &&
+      paper.hasKeyword() &&
+      paper.hasSlug() &&
+      researcher.hasResearch('keywordCountInSlug')
+    );
+  }
+
+  /**
+   *
+   * @param i18n
+   * @returns {{score: number, body: React.JSX.Element, status: string}}
+   */
+  calculateResult(i18n) {
+    const status = (() => {
+      if (this._keywordInSlug.keyphraseLength < 3) {
+        return this._keywordInSlug.percentWordMatches === 100 ? 'good' : 'bad';
+      }
+      return this._keywordInSlug.percentWordMatches > 50 ? '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 SlugKeywordAssessment;

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

@@ -0,0 +1,103 @@
+import {merge} from 'lodash';
+import React from 'react';
+import {Text} from '@shopify/polaris';
+import AssessmentResult from '../../../values/AssessmentResult';
+import Assessment from '../assessment';
+
+/**
+ * Represents the assessment that checks whether there are three or more consecutive sentences beginning with the same word.
+ */
+export default class UrlLengthAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object} config The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+
+    const defaultConfig = {
+      id: 'urlLength',
+      priority: 'high',
+      docUrl:
+        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#url-length',
+      fixPosition: 'url handle',
+      ctaType: 'fix',
+      title: 'URL length',
+      content: {
+        good: 'URL length is optimized, less than 75 characters.',
+        improve: '',
+        bad: 'Keep it less than 75 characters for better readability and SEO.'
+      }
+    };
+
+    this.identifier = 'urlLength';
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   *
+   * @param paper
+   * @param i18n
+   * @returns {{score: number, body: React.JSX.Element, status: string}}
+   */
+  calculateResult(paper, i18n) {
+    let status = '';
+    const length = paper.getDomain().length + paper.getSlug().length + 11;
+
+    if (length < 75) {
+      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>
+      )
+    };
+  }
+
+  /**
+   *
+   * @param paper
+   * @param researcher
+   * @param i18n
+   * @returns {AssessmentResult}
+   */
+  getResult(paper, researcher, i18n) {
+    const calculatedResult = this.calculateResult(paper, i18n);
+    const assessmentResult = new AssessmentResult({config: this._config});
+
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if the sentence beginnings assessment is applicable to the paper.
+   *
+   * @param {Object}      paper       The paper to check.
+   * @param {Researcher}  researcher  The researcher object.
+   *
+   * @returns {boolean} Returns true if the language is available and the paper is not empty.
+   */
+  isApplicable(paper, researcher) {
+    return true;
+  }
+}