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 ESLint config for TypeScript files #40584

Open
wants to merge 12 commits into
base: trunk
Choose a base branch
from

Conversation

manzoorwanijk
Copy link
Member

Updates ESLint config as discussed in #40555 (comment)

Proposed changes:

  • Disable certain JSDoc related ESLint rules for TypeScript files which make types redundant.

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:

  • Open a TS file
  • Remove the JSDoc type for any param
  • Remove the JSDoc type for return
  • Confirm that there is no error
  • Do the same for a js file
  • Confirm that the errors show up as before

@manzoorwanijk manzoorwanijk added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Infrastructure labels Dec 12, 2024
@manzoorwanijk manzoorwanijk requested a review from a team December 12, 2024 05:03
@manzoorwanijk manzoorwanijk self-assigned this Dec 12, 2024
Copy link
Contributor

github-actions bot commented Dec 12, 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 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!


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 January 7, 2025 (scheduled code freeze on undefined).

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 Dec 12, 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/eslint-config-for-ts-files 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/eslint-config-for-ts-files
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/eslint-config-for-ts-files
    

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

@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.

This seems to disable some things that are unrelated to types, and doesn't disable one thing I thought it would. Details inline.

tools/js-tools/eslintrc/base.mjs Outdated Show resolved Hide resolved
tools/js-tools/eslintrc/base.mjs Outdated Show resolved Hide resolved
tools/js-tools/eslintrc/base.mjs Outdated Show resolved Hide resolved
tools/js-tools/eslintrc/base.mjs Outdated Show resolved Hide resolved
@anomiex
Copy link
Contributor

anomiex commented Dec 12, 2024

Also, you may as well clean up the now-redundant config at

{
files: typescriptFiles,
rules: {
// Not needed for TypeScript.
'jsdoc/require-param-type': 'off',
'jsdoc/require-returns-type': 'off',
},
},

since these are now disabled globally for TS.

@github-actions github-actions bot added [Block] AI Assistant [JS Package] AI Client [JS Package] Charts [Package] Jetpack mu wpcom WordPress.com Features [Package] My Jetpack [Package] VideoPress [Plugin] CRM Issues about the Jetpack CRM plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Dec 13, 2024
@manzoorwanijk
Copy link
Member Author

manzoorwanijk commented Dec 13, 2024

Also, you may as well clean up the now-redundant config at

{
files: typescriptFiles,
rules: {
// Not needed for TypeScript.
'jsdoc/require-param-type': 'off',
'jsdoc/require-returns-type': 'off',
},
},

since these are now disabled globally for TS.

Nuked.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] AI Assistant [JS Package] AI Client [JS Package] Charts [JS Package] Components [Package] Jetpack mu wpcom WordPress.com Features [Package] My Jetpack [Package] VideoPress [Plugin] CRM Issues about the Jetpack CRM plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ RNA [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants