Skip to content

Conversation

manzoorwanijk
Copy link
Member

@manzoorwanijk manzoorwanijk commented Jul 3, 2025

Right now the components package has tons of TS files but only a couple of them are included for type checking.

"include": [ "./index.ts", "./tools/jp-redirect/index.ts" ],

We have TS files for unit tests and storybook stories but none of them are included in type checking.

Related p1751525387197869/1750998434.606469-slack-C05Q5HSS013

Proposed changes:

  • Include all the TS files for type checking, including unit test and stories
  • Create a separate tsconfig for build to exclude the tests and stories

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:

  • Do a sanity check for some admin pages
  • CI should be happy

@manzoorwanijk manzoorwanijk requested a review from Copilot July 3, 2025 07:03
@manzoorwanijk manzoorwanijk self-assigned this Jul 3, 2025
@manzoorwanijk manzoorwanijk added the [Type] Bug When a feature is broken and / or not performing as intended label Jul 3, 2025
Copy link
Contributor

github-actions bot commented Jul 3, 2025

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 WoA dev 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 (Jetpack or WordPress.com Site Helper), and enable the fix/components/tsconfig branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack fix/components/tsconfig
bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/components/tsconfig

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

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR broadens the TypeScript configuration to include all TS files for type checking and introduces a separate build config that excludes tests and stories.

  • Expand tsconfig.json to cover all source directories
  • Add tsconfig.build.json to exclude test and story files during build
  • Update the compile-ts script in package.json to use the new build config

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
projects/js-packages/components/tsconfig.json Expanded include to source, lib, and tools directories
projects/js-packages/components/tsconfig.build.json Added build-only config excluding tests and stories
projects/js-packages/components/package.json Updated compile-ts script to use tsconfig.build.json
components/toggle-control/index.tsx Exported ToggleControlProps
components/testimonials/test/component.tsx Switched userEvent to named import
components/status/index.tsx Exported StatusProps
components/radio-control/index.tsx Exported RadioControlProps
components/pricing-card/test/component.tsx Added @ts-expect-error comment for pure subpath import
components/jetpack-footer/test/component.tsx Switched userEvent to named import
changelog/fix-components-tsconfig Added changelog entry

Copy link
Contributor

github-actions bot commented Jul 3, 2025

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 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 🤖


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Jul 3, 2025
@manzoorwanijk manzoorwanijk force-pushed the fix/components/tsconfig branch from e3871d9 to 0c47561 Compare July 3, 2025 07:07
@manzoorwanijk manzoorwanijk added [Status] Needs Review This PR is ready for review. and removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Status] In Progress labels Jul 3, 2025
@manzoorwanijk manzoorwanijk requested a review from a team July 3, 2025 07:11
@manzoorwanijk manzoorwanijk marked this pull request as ready for review July 3, 2025 07:11
Copy link

jp-launch-control bot commented Jul 3, 2025

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

@manzoorwanijk manzoorwanijk force-pushed the fix/components/tsconfig branch from 0c47561 to bcf7bbe Compare July 3, 2025 07:31
@manzoorwanijk manzoorwanijk requested a review from anomiex July 7, 2025 06:21
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.

LGTM now 👍

We should probably look at where we can do this for other TS-using stuff too, and see what we can do about having jetpack generate nudge people in the right direction. 😀

@manzoorwanijk manzoorwanijk merged commit d36c69c into trunk Jul 8, 2025
81 checks passed
@manzoorwanijk manzoorwanijk deleted the fix/components/tsconfig branch July 8, 2025 03:49
@github-actions github-actions bot removed the [Status] Needs Review This PR is ready for review. label Jul 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[JS Package] Components RNA [Tests] Includes Tests [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants