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

Update @wordpress/eslint-plugin #39305

Merged
merged 2 commits into from
Sep 11, 2024
Merged

Update @wordpress/eslint-plugin #39305

merged 2 commits into from
Sep 11, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Sep 9, 2024

Proposed changes:

This brings two new rules that needed fixing:

  • @wordpress/i18n-no-flanking-whitespace complains about leading or trailing whitespace in JS i18n messages. Fix depends on context:
    • Sometimes it makes no difference, the browser (or React) strips it out. Removed these.
    • Sometimes it does, or it's unclear. In these cases I added it back outside the i18n call.
  • @wordpress/i18n-hyphenated-range wants en-dashes (or em-dashes) for numeric ranges. Switched them to en-dashes.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

None

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  • Places where these messages are used still looks right?

This brings two new rules that needed fixing:

* `@wordpress/i18n-no-flanking-whitespace` complains about leading or
  trailing whitespace in JS i18n messages. Fix depends on context:
  * Sometimes it makes no difference, the browser (or React) strips it
	out. Removed these.
  * Sometimes it does, or it's unclear. In these cases I added it back
	outside the i18n call.
* `@wordpress/i18n-hyphenated-range` wants en-dashes (or em-dashes) for
  numeric ranges. Switched them to en-dashes.
@anomiex anomiex requested a review from a team September 9, 2024 19:51
@anomiex anomiex added [Status] Needs Review To request a review from Crew. Label will be renamed soon. [Type] Janitorial [Pri] Normal labels Sep 9, 2024
@anomiex anomiex self-assigned this Sep 9, 2024
@github-actions github-actions bot added [Block] AI Assistant [Block] AI Paragraph [Block] Contact Form Form block (also see Contact Form label) [Block] Podcast Player [Extension] AI Assistant Plugin [Feature] Contact Form [Package] Backup [Package] Forms [Package] Search Contains core Search functionality for Jetpack and Search plugins [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Migration [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Super Cache A fast caching plugin for WordPress. Admin Page React-powered dashboard under the Jetpack menu labels Sep 9, 2024
Copy link
Contributor

github-actions bot commented Sep 9, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for October 1, 2024 (scheduled code freeze on September 30, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.


Protect plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.


Super Cache plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.


Migration plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Copy link
Contributor

github-actions bot commented Sep 9, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/wordpress-eslint-plugin branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack update/wordpress-eslint-plugin
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/wordpress-eslint-plugin
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

Copy link
Member

@zinigor zinigor left a comment

Choose a reason for hiding this comment

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

I have some questions about preserving spaces here, maybe we should test these to make sure.

'jetpack-search-pkg'
) }
</span>
</span>{ ' ' }
Copy link
Member

Choose a reason for hiding this comment

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

Should we put the space inside the span element to preserve the original behavior?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

🤷 No idea. In practice CSS currently sets display: block on these spans so the whitespace gets ignored either way.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Before:
before

After:
after

@@ -70,7 +70,7 @@ const ShareDebugData = () => {

return (
<div className={ styles[ 'share-data-section' ] }>
<Title mb={ 2 }>{ __( ' Share detailed data with Jetpack', 'jetpack-protect' ) }</Title>
<Title mb={ 2 }>{ __( 'Share detailed data with Jetpack', 'jetpack-protect' ) }</Title>
Copy link
Member

Choose a reason for hiding this comment

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

Have you been able to figure out why there was a space here in the first place? Maybe we should preserve this one too?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems to go back to 021eb6a, beyond that I have no idea.

It made no difference to the rendering when I tried it. HTML ignores whitespace at the start of block elements like the <h2> generated here.

Before:
before

After:
after

@@ -33,7 +33,7 @@ const ProductPromotion = () => {
<Title>{ __( 'Get access to our Cloud', 'jetpack-protect' ) }</Title>
<Text mb={ 3 }>
{ __(
'With your Protect upgrade, you have free access to scan your site on our Cloud, so you can be aware and fix your threats even if your site goes down. ',
'With your Protect upgrade, you have free access to scan your site on our Cloud, so you can be aware and fix your threats even if your site goes down.',
Copy link
Member

Choose a reason for hiding this comment

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

I'm afraid we'll have to preserve this too for inline elements.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What inline elements? The following element is a block-formatted button.

Screenshot

Copy link
Member

@zinigor zinigor left a comment

Choose a reason for hiding this comment

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

Thank you for doing the legwork and actually testing the changes!

@anomiex anomiex merged commit 3a06084 into trunk Sep 11, 2024
73 checks passed
@anomiex anomiex deleted the update/wordpress-eslint-plugin branch September 11, 2024 16:19
@github-actions github-actions bot removed the [Status] Needs Review To request a review from Crew. Label will be renamed soon. label Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Page React-powered dashboard under the Jetpack menu [Block] AI Assistant [Block] AI Paragraph [Block] Contact Form Form block (also see Contact Form label) [Block] Podcast Player [Extension] AI Assistant Plugin [Feature] Contact Form [Package] Backup [Package] Forms [Package] Search Contains core Search functionality for Jetpack and Search plugins [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Migration [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Super Cache A fast caching plugin for WordPress. [Pri] Normal [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants