Scan Package: Fix Build

nateweller commented 13 hours ago

Following up on https://github.com/Automattic/jetpack/pull/40262, this PR ensures the js-packages/scan project actually builds the build folder using tsc.

Proposed changes:

Restore the changes to tsconfig.json made in https://github.com/Automattic/jetpack/pull/39754/files#diff-1a0db43237e720fa764bf7d3052b6c672d5c26f7c7479154dca7c215f16270fa
Extend tsconfig.base.json instead of tsconfig.tsc.json.
Remove babel deps and references since we are only using tsc.

Other information:

[ ] Have you written new tests for your changes, if applicable?
[x] 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

https://github.com/Automattic/jetpack/pull/40262

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

No

Testing instructions:

Run jetpack build js-packages/scan and validate the build directory is generated.

github-actions[bot] commented 13 hours ago

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/scan/build 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 fix/scan/build

bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/scan/build

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[bot] commented 13 hours ago

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

:white_check_mark: Include a description of your PR changes.
:white_check_mark: Add a "[Status]" label (In Progress, Needs Team Review, ...).
:white_check_mark: Add testing instructions.
:white_check_mark: Specify whether this PR includes any changes to data or privacy.
:white_check_mark: 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 :robot:

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:

Ensure all required checks appearing at the bottom of this PR are passing.
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.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

nateweller commented 10 hours ago

@anomiex What do you think about this alternate to https://github.com/Automattic/jetpack/pull/40262?

I had to extend tsconfig.base.json instead of tsconfig.tsc.json to get tests passing. Is that change appropriate for the use case of this package?

My ultimate hope and dream for the scan package is to have a reusable TS lib that exports types, functions, and translatable strings related to Jetpack Scan features. Initially for use across Jetpack and Jetpack Protect plugins, and then potentially sharing code with Calypso if/as possible and useful.

I know the inclusion of @wordpress/i18n complicates things. I appreciate any notes! Thanks 😄

Edit: Could we use the declaration-only base to export types, and then have consumers (Jetpack, Jetpack Protect) be responsible for compiling the TS?

Automattic / jetpack