Fixes grunt check warnings in yoastseo by FAMarfuaty · Pull Request #20952 · Yoast/wordpress-seo

FAMarfuaty · 2023-12-18T08:30:16Z

Context

Summary

This PR can be summarized in the following changelog entry:

[yoastseo] Fixes warnings from running yarn lint.

Relevant technical choices:

/* eslint-disable max-len */ statements are removed for strings and regexes. Adding the disabling statement is not relevant anymore. This is because in eslintrc.js the @stylistic/max-lex is disabled already for strings and regexes.
I fixed the complexity warning in packages/yoastseo/src/scoring/assessments/seo/KeyphraseLengthAssessment.js and in getTransliterations.js. I didn't fix all the complexity warnings since there is a separate issue to do it: https://github.com/Yoast/lingo-other-tasks/issues/73
I renamed transliterations.js to getTransliterations.js since it's actually a function. Hence naming the fnction with verb is better. I also added a spec file for it and added unit tests.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

QA testing shouldn't be necessary.
For Dev acceptance test:
- Make sure to be on at least Node 16.
- Run yarn to install all dependencies.
- In packages/yoastseo, run yarn lint and make sure that the only warnings are related to complexity and back reference.

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 (Block/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:

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.

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 #

FAMarfuaty · 2023-12-18T13:42:55Z

         * \u061B - Arabic semicolon
         */
-		wordBoundary = "[ \\u00a0\\u2014\\u06d4\\u061f\\u060C\\u061B\\n\\r\\t\.,\(\)”“〝〞〟‟„\"\+\\-;!¡\?¿:\/»«‹›" + extraWordBoundary + "<>";
+		wordBoundary = "[ \\u00a0\\u2014\\u06d4\\u061f\\u060C\\u061B\\n\\r\\t.,()”“〝〞〟‟„\"+\\-;!¡?¿:/»«‹›" + extraWordBoundary + "<>";


I removed the useless escape. It looks like it's okay to do so. All specs are still passing

…t rule

FAMarfuaty · 2023-12-18T16:19:42Z

    "pretest": "grunt get-premium-configuration",
    "test": "jest",
-    "lint": "eslint src",
+    "lint": "eslint src spec --max-warnings 12",


For now I set the maximum warnings to 12. But it can also be changed later

I'm going to lower it to 10, given that we currently have 10 warnings! 👍

mhkuu

CR: Great stuff, thanks so much @FAMarfuaty 🙌 I really appreciate you taking the time to clean up the package.

mhkuu · 2023-12-21T14:21:02Z

ACC: works as advertised, lowered the number of warnings to 10 🎉
The GitHub actions do not pass because of the node version mismatch, I am going to blissfully ignore that for now 😅

FAMarfuaty added 6 commits December 15, 2023 16:08

Update yarn.lock

628ffa5

Fix no-useless-escape regexes

39d1aef

remove unnecessary statements for disabling max-len

c8d25a0

Remove TODO

bfe9878

Remove comma dangling

616ca2b

Also check spec directory for linting

6e5760e

FAMarfuaty commented Dec 18, 2023

View reviewed changes

FAMarfuaty added 5 commits December 18, 2023 14:56

Use arrow functions so they won't require JSDoc

71fa95c

Move the variable declaration to avoid no-shadow eslint rule

09bc9b1

Disable no-loss-of-precision eslint rule

cdb2b31

Remove unnecessary statement to disable no-irregular-whitespace eslin…

c72b907

…t rule

Set maximum warnings to 12

60bd9d7

FAMarfuaty added this to the Releasing yoastseo milestone Dec 18, 2023

FAMarfuaty marked this pull request as ready for review December 18, 2023 14:26

FAMarfuaty added 4 commits December 18, 2023 16:09

Simplify function

91f454c

Rename function

3cb734a

Add unit tests for getTransliterations

ea669f9

Split the calculateResult method to decrease complexity

49b84c7

FAMarfuaty added the changelog: other Needs to be included in the 'Other' category in the changelog label Dec 18, 2023

FAMarfuaty commented Dec 18, 2023

View reviewed changes

mhkuu self-requested a review December 21, 2023 14:07

mhkuu approved these changes Dec 21, 2023

View reviewed changes

mhkuu changed the title ~~69 fix grunt check warnings in packagesyoastseo~~ Fixes grunt check warnings in yoastseo Dec 21, 2023

Lowers the number of eslint max-warnings to 10

6b41a84

mhkuu merged commit 4611e5b into releasing-yoastseo Dec 21, 2023

mhkuu deleted the 69-fix-grunt-check-warnings-in-packagesyoastseo branch December 21, 2023 14:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes grunt check warnings in yoastseo#20952

Fixes grunt check warnings in yoastseo#20952
mhkuu merged 16 commits intoreleasing-yoastseofrom
69-fix-grunt-check-warnings-in-packagesyoastseo

FAMarfuaty commented Dec 18, 2023 •

edited by mhkuu

Loading

Uh oh!

FAMarfuaty Dec 18, 2023

Uh oh!

FAMarfuaty Dec 18, 2023

Uh oh!

mhkuu Dec 21, 2023

Uh oh!

mhkuu left a comment

Uh oh!

mhkuu commented Dec 21, 2023 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

FAMarfuaty commented Dec 18, 2023 • edited by mhkuu Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Summary

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

Relevant test scenarios

Test instructions for QA when the code is in the RC

Impact check

UI changes

Other environments

Documentation

Quality assurance

Innovation

Uh oh!

FAMarfuaty Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

FAMarfuaty Dec 18, 2023

Choose a reason for hiding this comment

Uh oh!

mhkuu Dec 21, 2023

Choose a reason for hiding this comment

Uh oh!

mhkuu left a comment

Choose a reason for hiding this comment

Uh oh!

mhkuu commented Dec 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

FAMarfuaty commented Dec 18, 2023 •

edited by mhkuu

Loading

mhkuu commented Dec 21, 2023 •

edited

Loading