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

jetpack-mu-wpcom: remove linting rule overrides #40578

Merged
merged 3 commits into from
Dec 12, 2024

Conversation

tbradsha
Copy link
Contributor

This corrects some lints and then removes the following overrides in said package:

'jsdoc/require-returns': 'off',
'jsdoc/require-param-type': 'off',

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

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

Testing instructions:

  • Is CI happy?
  • Does this run fine? pnpm lint-file projects/packages/jetpack-mu-wpcom/

Copy link
Contributor

github-actions bot commented Dec 11, 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/jetpack-mu-wpcom/eslint_fixes 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-mu-wpcom-plugin fix/jetpack-mu-wpcom/eslint_fixes
    

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

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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!

Copy link
Contributor

@anomiex anomiex left a comment

Choose a reason for hiding this comment

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

The added docs seem plausible, but I didn't dig in to verify them.

@@ -7,9 +7,6 @@ export default [
rules: {
'testing-library/prefer-screen-queries': 'off',
'react/jsx-no-bind': 'off',
// @todo Turn these back on for JS here. The block below handles TS.
'jsdoc/require-returns': 'off',
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like I had a typo here, that should have been jsdoc/require-returns-type like below and in the old code. 😳

@@ -28,6 +28,7 @@ const KeyboardNavigation: React.FunctionComponent< Props > = ( {
} ) => {
/**
* Expand Tour Nav
* @return {null} This component is non-rendering.
Copy link
Contributor

Choose a reason for hiding this comment

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

I verified that in TS files it's also ok with something like this

	 * @return This component is non-rendering.

I have no opinion on whether you should make that sort of change here and in other TS files in this PR. 🙂

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 opinion myself either, but the extra doc shouldn't hurt here so I'll leave it.

@tbradsha tbradsha merged commit f7cfbf4 into trunk Dec 12, 2024
58 of 59 checks passed
@tbradsha tbradsha deleted the fix/jetpack-mu-wpcom/eslint_fixes branch December 12, 2024 19:51
anomiex added a commit that referenced this pull request Dec 12, 2024
anomiex added a commit that referenced this pull request Dec 12, 2024
#40578 adjusted the eslint config and fixed existing errors, but #40583 snuck in just ahead of it adding a new instance of the error.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment