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

Deprecate eslint-config package in favor of Yoast/eslint-config #22081

Merged
merged 2 commits into from
Mar 6, 2025

Conversation

diedexx
Copy link
Member

@diedexx diedexx commented Feb 28, 2025

Context

  • This ESLint config is shared across all Yoast projects and not just the free plugin. It's being boved to a separate repository, where maintaining and releasing becomes disconnected from the plugin release cycle.

Summary

This PR can be summarized in the following changelog entry:

  • [eslint-config-yoast] Deprecate the package in favor of @yoast/eslint-config.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • n/a

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:

  • n/a

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.

This ESLint config is shared across all Yoast projects and not just the
free plugin. It's being boved to a separate repository, where
maintaining and releasing becomes disconnected from the plugin release
cycle.
@diedexx diedexx added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Feb 28, 2025
@diedexx diedexx requested a review from a team as a code owner February 28, 2025 15:11
Copy link

@diedexx Please be aware that following packages have been abandoned and are not actively maintained anymore:

Package name Path
@yoast/babel-preset packages/babel-preset
@yoast/components packages/components
@yoast/e2e-tests packages/e2e-tests
@yoast/helpers packages/helpers
@yoast/jest-preset packages/jest-preset
@yoast/style-guide packages/style-guide
eslint-config-yoast packages/esling-config-yoast

Please consider using the other packages instead.

@mhkuu
Copy link
Contributor

mhkuu commented Mar 6, 2025

LGTM! 🚀

@mhkuu mhkuu added this to the 24.8 milestone Mar 6, 2025
@mhkuu mhkuu merged commit b04fd31 into trunk Mar 6, 2025
22 checks passed
@mhkuu mhkuu deleted the deprecate-eslint-config branch March 6, 2025 08:37
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.

2 participants