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

Converts the sentence beginnings assessment to use the HTML parser #21974

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

Conversation

mhkuu
Copy link
Contributor

@mhkuu mhkuu commented Jan 17, 2025

Context

Summary

This PR can be summarized in the following changelog entry:

  • Introduces more robust HTML processing and highlighting for the consecutive sentences assessment.
  • [shopify-seo] Introduces more robust HTML processing and highlighting for the consecutive sentences assessment.
  • [yoastseo] Converts the consecutive sentences assessment to use HTML parser in its analysis.
  • [yoastseo] Converts the consecutive sentences assessment highlighting approach from search and replace to position-based approach.

Relevant technical choices:

  • Moved some tree traversal methods to the Node class.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Please see the ATP over here.

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:

  • The sentence beginnings assessment.

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/173

@mhkuu mhkuu added changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog Shopify This PR impacts Shopify. labels Jan 17, 2025
@coveralls
Copy link

coveralls commented Jan 17, 2025

Pull Request Test Coverage Report for Build 59dc44dfe3bfb7a70de4304bb748af2addb5667a

Details

  • 52 of 52 (100.0%) changed or added relevant lines in 9 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.02%) to 57.787%

Totals Coverage Status
Change from base Build 3888b28d83f272168937506af6d7607a8f5e2e51: -0.02%
Covered Lines: 13648
Relevant Lines: 23252

💛 - Coveralls

Comment on lines +288 to +289
// This test currently fails because "no." is regarded an abbreviation.
xit( "returns an object with sentence beginnings and counts for two sentences in Spanish starting with the same word.", function() {
Copy link
Contributor Author

@mhkuu mhkuu Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that this test fails (because no. is an abbreviation), hence the xit.

Copy link

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

@mhkuu mhkuu marked this pull request as ready for review February 21, 2025 14:57
@mhkuu
Copy link
Contributor Author

mhkuu commented Feb 21, 2025

This PR is ready for a first round of review. I'll admit that I haven't been able to test the functionality on different editors pretty deeply, but as it's pretty straightforward I don't expect many problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: enhancement Needs to be included in the 'Enhancements' category in the changelog Shopify This PR impacts Shopify.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants