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: Remove eslint-plugin-wpcalypso, add more @wordpress rules, and clean up #38436

Merged
merged 1 commit into from
Jul 22, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Jul 19, 2024

Proposed changes:

It turns out we're not making very much use of eslint-plugin-wpcalypso:

  • Three of its rules we disable as being redundant to @wordpress rules.
  • We already disable four more of its rules as not being applicable to Jetpack.
  • Of the seven still enabled,
    • wpcalypso/i18n-no-this-translate is apparently obsolete, see Remove the mixin i18n-calypso#59.
    • wpcalypso/i18n-named-placeholders, wpcalypso/i18n-mismatched-placeholders, and wpcalypso/i18n-no-placeholders-only only work with Calypso's translate() function (which we don't use), not @wordpress/i18n.
    • We don't use @wordpress/react-i18n anywhere so wpcalypso/i18n-translate-identifier has nothing to check.

So let's drop it, and one of its dependencies that we're not using either.

Dropping wpcalypso leaves us without configuration of various other eslint plugins we have been using. To make up the difference, let's also enable the "recommended-with-formatting" config from @wordpress/eslint-plugin.

After adding back a few rules and removing some redundant overrides, this results in the following changes:

New rules:

  • no-caller
  • no-eval
  • no-multi-str
  • no-useless-constructor
  • react/jsx-equals-spacing
  • react/jsx-indent
  • react/jsx-indent-props
  • react/jsx-no-comment-textnodes
  • react/jsx-uses-react
  • react/no-danger-with-children
  • react/no-render-return-value
  • react/require-render-return

Removed rules:

  • no-negated-in-lhs (which is deprecated anyway)

Neutral changes:

  • A bunch of checks switched between "warn" and "error". Since we don't differentiate in CI, this shouldn't make any difference.
  • .parserOptions.sourceType and .parserOptions.babelOptions get set. Since we always use TypeScript's parser, these options have no effect.

Note none of the above are failing on our current codebase!

To avoid this PR getting too big, the following changes that do fail on our current codebase are temporarily overridden. We'll either fix these in future PRs, or "promote" them to non-temporary overrides.

Temporarily not added:

  • array-callback-return
  • jsdoc/check-line-alignment
  • no-alert
  • no-bitwise
  • no-fallthrough
  • no-prototype-builtins
  • no-undef-init
  • no-unused-expressions
  • no-useless-computed-key
  • no-useless-return
  • object-shorthand
  • react/jsx-key
  • react/no-direct-mutation-state
  • react/no-find-dom-node
  • react/no-unescaped-entities
  • react/no-unknown-property

Changed rule configurations overridden:

  • eqeqeq: No longer allows non-strict comparison with null.
  • jsdoc now prefers @return and @yield rather than @returns and @yields.
  • jsx-a11y/label-has-associated-control: assert is now "htmlFor", formerly defaulted to "either".
  • no-empty: No longer allows empty catch.
  • react-hooks/exhaustive-deps: Applies to useSelect and useSuspenseSelect too.

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

Tangential to pf4qpu-rJ-p2

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

No

Testing instructions:

  • CI happy?
  • Compare pnpm lint before and after. Should be all the same lints, just some change between 'warning' and 'error'.
  • Comparing the before and after output of pnpm exec eslint --print-config <file> | jq --tab --sort-keys . for various files may be instructive.

…, and clean up

It turns out we're not making very much use of `eslint-plugin-wpcalypso`:

* Three of its rules we disable as being redundant to `@wordpress`
  rules.
* We already disable four more of its rules as not being applicable to
  Jetpack.
* Of the seven still enabled,
  * `wpcalypso/i18n-no-this-translate` is apparently obsolete, see
	Automattic/i18n-calypso#59.
  * `wpcalypso/i18n-named-placeholders`, `wpcalypso/i18n-mismatched-placeholders`,
	and `wpcalypso/i18n-no-placeholders-only` only work with Calypso's
	`translate()` function (which we don't use), not `@wordpress/i18n`.
  * We don't use `@wordpress/react-i18n` anywhere so
	`wpcalypso/i18n-translate-identifier` has nothing to check.

So let's drop it, and one of its dependencies that we're not using
either.

Dropping wpcalypso leaves us without configuration of various other
eslint plugins we have been using. To make up the difference, let's also
enable the "recommended-with-formatting" config from `@wordpress/eslint-plugin`.

After adding back a few rules and removing some redundant overrides,
this results in the following changes:

New rules:
* no-caller
* no-eval
* no-multi-str
* no-useless-constructor
* react/jsx-equals-spacing
* react/jsx-indent
* react/jsx-indent-props
* react/jsx-no-comment-textnodes
* react/jsx-uses-react
* react/no-danger-with-children
* react/no-render-return-value
* react/require-render-return

Removed rules:
* no-negated-in-lhs (which is deprecated anyway)

Neutral changes:
* A bunch of checks switched between "warn" and "error". Since we don't
  differentiate in CI, this shouldn't make any difference.
* `.parserOptions.sourceType` and `.parserOptions.babelOptions` get set.
  Since we always use TypeScript's parser, these options have no effect.

Note none of the above are failing on our current codebase!

To avoid this PR getting too big, the following changes that do fail on
our current codebase are temporarily overridden. We'll either fix these
in future PRs, or "promote" them to non-temporary overrides.

Temporarily not added:
* array-callback-return
* jsdoc/check-line-alignment
* no-alert
* no-bitwise
* no-fallthrough
* no-prototype-builtins
* no-undef-init
* no-unused-expressions
* no-useless-computed-key
* no-useless-return
* object-shorthand
* react/jsx-key
* react/no-direct-mutation-state
* react/no-find-dom-node
* react/no-unescaped-entities
* react/no-unknown-property

Changed rule configurations overridden:
* eqeqeq: No longer allows non-strict comparison with `null`.
* jsdoc now prefers `@return` and `@yield` rather than `@returns` and
  `@yields`.
* jsx-a11y/label-has-associated-control: `assert` is now "htmlFor",
  formerly defaulted to "either".
* no-empty: No longer allows empty `catch`.
* react-hooks/exhaustive-deps: Applies to `useSelect` and
  `useSuspenseSelect` too.
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 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.

Copy link
Contributor

github-actions bot commented Jul 19, 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 remove/calypso-eslint 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 remove/calypso-eslint
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin remove/calypso-eslint
    

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

@ice9js ice9js left a comment

Choose a reason for hiding this comment

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

Looks like advertised to me :)

@anomiex anomiex merged commit 0bc9ec9 into trunk Jul 22, 2024
73 of 74 checks passed
@anomiex anomiex deleted the remove/calypso-eslint branch July 22, 2024 15:57
@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 22, 2024
@github-actions github-actions bot added this to the jetpack/13.7 milestone Jul 22, 2024
anomiex added a commit that referenced this pull request Dec 5, 2024
To make the eslint 9 upgrade PR smaller, let's fix some of the lints
that it'll complain about ahead of time.

Of particular note is that, when we added 'plugin:@wordpress/jsx-a11y'
in #38436, we accidentally left 'plugin:jsx-a11y/recommended' in place
after it which overrides some of the configuration that
'plugin:@wordpress/jsx-a11y' does. Fixing that disables a few rules we
had been inline-ignoring in various places: jsx-a11y/media-has-caption,
jsx-a11y/no-noninteractive-tabindex, and
jsx-a11y/role-has-required-aria-props.
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