Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Uses the HTML parser for the text alignment assessment #21721

Open
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

mhkuu
Copy link
Contributor

@mhkuu mhkuu commented Oct 18, 2024

Context

  • We want to expand our usage of the HTML parser and hence rely less on regular expressions throughout our yoastseo package. This PR converts the text alignment assessment to use the HTML parser.

Summary

This PR can be summarized in the following changelog entry:

  • [yoastseo] Uses the HTML parser for the text alignment assessment.
  • [yoastseo] Removes the matchStringWithRegex helper from the index, as its use is discouraged.

Relevant technical choices:

  • In this PR we also remove the unused helper findEmptyDivisions, and remove the matchStringWithRegex helper from the index, as its use is discouraged. It will be removed in a follow-up PR.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Use the instructions from this ATP, sections 2.1-2.4, for an LTR language (e.g., English), and a RTL language (e.g., Arabic).
  • Note that this assessment is only available for the block editor, so no cross-testing between editors required. Do note that Yoast SEO Premium is required.

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • With this PR, the text alignment assessment is refactored.

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes https://github.com/Yoast/lingo-other-tasks/issues/362

@mhkuu mhkuu added innovation Innovative issue. Relating to performance, memory or data-flow. changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog labels Oct 18, 2024
@coveralls
Copy link

coveralls commented Oct 18, 2024

Pull Request Test Coverage Report for Build 8fafea474e61f805dec26913692b1b8756236857

Details

  • 8 of 8 (100.0%) changed or added relevant lines in 2 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.007%) to 49.399%

Totals Coverage Status
Change from base Build ad2c4b607f7daae862318f3d8e622f745e25b2c7: -0.007%
Covered Lines: 25653
Relevant Lines: 53653

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog innovation Innovative issue. Relating to performance, memory or data-flow.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants