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

ci: Check that React-using projects use react eslint rules #39214

Merged
merged 1 commit into from
Sep 5, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Sep 3, 2024

Proposed changes:

I noticed that several of our projects are using React but did not have our jetpack-js-tools/eslintrc/react eslint ruleset enabled. This adds a linting check for that, and enables it on most of the projects where it was not enabled.

For a few I instead added a @todo comment about turning it on, due to a lot of cleanup being needed in order to successfully do so. I hope people more familiar with React and these projects will follow up on that.

  • js-packages/ai-client: 32 × react/jsx-no-bind 33 × react-hooks/exhaustive-deps
  • packages/videopress: 8 × react-hooks/rules-of-hooks 69 × react-hooks/exhaustive-deps 157 × react/jsx-no-bind
  • plugins/boost: 1 × react/no-danger 81 × react/jsx-no-bind
  • plugins/crm: 1 × react-hooks/rules-of-hooks 2 × react/jsx-no-bind 3 × react-hooks/exhaustive-deps

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:

  • CI happy?
  • Try removing the extends added here. Does .github/files/lint-project-structure.sh catch it?

I noticed that several of our projects are using React but did not have
our `jetpack-js-tools/eslintrc/react` eslint ruleset enabled. This adds
a linting check for that, and enables it on most of the projects where
it was not enabled.

For a few I instead added a `@todo` comment about turning it on, due to
a lot of cleanup being needed in order to successfully do so. I hope
people more familiar with React and these projects will follow up on
that.

* js-packages/ai-client:
   32 × react/jsx-no-bind
   33 × react-hooks/exhaustive-deps
* packages/videopress:
    8 × react-hooks/rules-of-hooks
   69 × react-hooks/exhaustive-deps
  157 × react/jsx-no-bind
* plugins/boost:
    1 × react/no-danger
   81 × react/jsx-no-bind
* plugins/crm:
    1 × react-hooks/rules-of-hooks
    2 × react/jsx-no-bind
    3 × react-hooks/exhaustive-deps
@anomiex anomiex added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial [Pri] Normal labels Sep 3, 2024
@anomiex anomiex requested a review from a team September 3, 2024 19:39
@anomiex anomiex self-assigned this Sep 3, 2024
Copy link
Contributor

github-actions bot commented Sep 3, 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 add/structure-lint-eslint-react 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 add/structure-lint-eslint-react
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/structure-lint-eslint-react
    

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

@github-actions github-actions bot added [JS Package] AI Client [JS Package] React Data Sync Client [JS Package] Scan [JS Package] Social Logos [Package] Assets [Package] Blaze [Package] Connection [Package] VideoPress [Package] Yoast Promo [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] CRM Issues about the Jetpack CRM plugin Actions GitHub actions used to automate some of the work around releases and repository management RNA labels Sep 3, 2024
Copy link
Contributor

github-actions bot commented Sep 3, 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!


Boost plugin:

  • Next scheduled release: none scheduled.

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

@kraftbj kraftbj merged commit d586800 into trunk Sep 5, 2024
75 checks passed
@kraftbj kraftbj deleted the add/structure-lint-eslint-react branch September 5, 2024 14:31
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Sep 5, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
I noticed that several of our projects are using React but did not have
our `jetpack-js-tools/eslintrc/react` eslint ruleset enabled. This adds
a linting check for that, and enables it on most of the projects where
it was not enabled.

For a few I instead added a `@todo` comment about turning it on, due to
a lot of cleanup being needed in order to successfully do so. I hope
people more familiar with React and these projects will follow up on
that.

* js-packages/ai-client:
   32 × react/jsx-no-bind
   33 × react-hooks/exhaustive-deps
* packages/videopress:
    8 × react-hooks/rules-of-hooks
   69 × react-hooks/exhaustive-deps
  157 × react/jsx-no-bind
* plugins/boost:
    1 × react/no-danger
   81 × react/jsx-no-bind
* plugins/crm:
    1 × react-hooks/rules-of-hooks
    2 × react/jsx-no-bind
    3 × react-hooks/exhaustive-deps
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