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

eslint: For no-empty, set allowEmptyCatch false #38486

Merged
merged 6 commits into from
Jul 30, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Jul 23, 2024

Proposed changes:

The "no-empty" can be satisfied with anything, even a comment saying why we're ignoring the exception. Since that's probably a useful comment to have, let's do that.

For a few files, do something different:

  • projects/plugins/jetpack/extensions/shared/block-editor-asset-loader.js can return directly from the catch, the following check would only fail if the catch caught.
  • projects/plugins/jetpack/modules/shortcodes/js/jmpress.js is a copy-pasted external library. We should .eslintignore it as well as two others in that directory.
  • projects/plugins/jetpack/tools/webpack.config.extensions.js would error on the next line after the catch anyway, so skip catching at all.

This brings us more in line with the ruleset imported from @wordpress/eslint-plugin.

Also, have tools/cleanup-excludelists.sh clean up ignored files. The "File ignored because of a matching ignore pattern" warning shouldn't keep files in the list.

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

Followup to #38436

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

No

Testing instructions:

  • CI happy?
  • Added comments make sense?

The "no-empty" can be satisfied with anything, even a comment saying why
we're ignoring the exception. Since that's probably a useful comment to
have, let's do that.

For a few files, do something different:
* `projects/plugins/jetpack/extensions/shared/block-editor-asset-loader.js`
  can return directly from the `catch`, the following check would only
  fail if the catch caught.
* `projects/plugins/jetpack/modules/shortcodes/js/jmpress.js` is a
  copy-pasted external library. We should `.eslintignore` it as well as
  two others in that directory.
* `projects/plugins/jetpack/tools/webpack.config.extensions.js` would
  error on the next line after the catch anyway, so skip catching at
  all.

This brings us more in line with the ruleset imported from
`@wordpress/eslint-plugin`.

Also, have tools/cleanup-excludelists.sh clean up ignored files. The
"File ignored because of a matching ignore pattern" warning shouldn't
keep files in the list.
@anomiex anomiex added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial [Pri] Normal labels Jul 23, 2024
@anomiex anomiex requested a review from a team July 23, 2024 19:31
@anomiex anomiex self-assigned this Jul 23, 2024
@anomiex anomiex enabled auto-merge (squash) July 23, 2024 19:31
Copy link
Contributor

github-actions bot commented Jul 23, 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 fix/eslint-no-empty-catch-blocks 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 fix/eslint-no-empty-catch-blocks
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/eslint-no-empty-catch-blocks
    

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
Contributor

github-actions bot commented Jul 23, 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.


Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.


Jetpack plugin:

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

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for August 6, 2024 (scheduled code freeze on August 5, 2024).

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


Mu Wpcom plugin:

  • Next scheduled release: WordPress.com Simple releases happen daily.

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


Wpcomsh plugin:

  • Next scheduled release: on demand (usually Mondays if not sooner).

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

@anomiex anomiex merged commit d1c2b52 into trunk Jul 30, 2024
70 of 71 checks passed
@anomiex anomiex deleted the fix/eslint-no-empty-catch-blocks branch July 30, 2024 12:02
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants