Skip to content

Analysis Report: Refactor defaultProps to be defaultArguments #22263

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

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

Conversation

igorschoester
Copy link
Member

@igorschoester igorschoester commented May 13, 2025

Context

Important

Based of #22256
The merge base should be updated to trunk automatically if that is merged first

Summary

This PR can be summarized in the following changelog entry:

  • [@yoast/analysis-report 0.1.0] Refactors the defaultProps to be defaultArguments instead.

Relevant technical choices:

Refactor defaultProps to defaultArguments

  • fix JS doc
  • use prop spreading
  • specify which props in "areMarkButtonsHidden"
  • remove unused "hasAIButton" prop
  • remove import comments (as they interfere with my auto ordering)

Decrease allowed warning count
Still 2 more than before the ESLint config bump. The defaults count as complexity, due to their if/else nature I suppose.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Smoke test the analysis results in each editor.
  • Smoke test the SiteSEOReport on the WP dashboard:
    image

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:

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/reserved-tasks/issues/570

@igorschoester igorschoester added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label May 13, 2025
@igorschoester igorschoester force-pushed the 553-update-to-the-new-yoasteslint-config-version-in-our-projects branch from 3d689a8 to 93c5ecc Compare May 14, 2025 09:29
@igorschoester igorschoester requested a review from a team as a code owner May 14, 2025 09:29
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.

* fix JS doc
* use prop spreading
* specify which props in "areMarkButtonsHidden"
* remove unused "hasAIButton" prop
* remove import comments (as they interfere with my auto ordering)
Still 2 more than before the ESLint config bump. The defaults count as complexity, due to their if/else nature I suppose.
@igorschoester igorschoester force-pushed the 567-analysis-report branch from 8a2c84c to e5dcd80 Compare May 14, 2025 09:32
@igorschoester igorschoester changed the title 567 analysis report Analysis Report: refactor defaultProps to be defaultArguments May 14, 2025
@igorschoester igorschoester changed the title Analysis Report: refactor defaultProps to be defaultArguments Analysis Report: Refactor defaultProps to be defaultArguments May 14, 2025
Base automatically changed from 553-update-to-the-new-yoasteslint-config-version-in-our-projects to trunk May 19, 2025 08:20
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant