chore: Prepare to use TypeScript natively by JPeer264 · Pull Request #2910 · getsentry/sentry-cli

JPeer264 · 2025-11-04T13:49:26Z

Description

This PR is a starting point of upgrading to TypeScript and preparing for future upgrades around testing and maintenance.

I've seen that couple of types between the *.js files and the index.d.ts were not 100% in sync, which is one of the reasons the move to TypeScript natively could help here.

What's new / changed

moved js to lib in order to keep js as the same output folder which is delivered to NPM
js/index.d.ts stays as type export for NPM and the types are re-exported via the jsdoc @typedef
types.ts is actually the same as the previous index.d.ts excluding the SentryCli class
TypeScript is partially used to keep the changes minimal
I aligned the jsdoc types with the actual text from the previous index.d.ts

JPeer264 · 2025-11-04T15:06:08Z

@andreiborza this is now ready to review. Had some issues with the postinstall, but this is solved now.

szokeasaurusrex

Added some comments, mostly containing some noob JS questions.

My one concern is: several of the changes here look like they might break the public JS API; am I understanding that correctly?

.github/workflows/build.yml

.github/workflows/test_node.yml

js/releases/index.js

JPeer264 · 2025-11-05T09:09:08Z

My one concern is: several of the changes here look like they might break the public JS API; am I understanding that correctly?

If you run npm install --ignore-scripts and npm run build locally - you'll see that the index.d.ts inside js-dist is exporting the same types as before (just a slightly different format). So there shouldn't be any breaking changes regarding the API.

andreiborza

Very nice!

.github/workflows/test_node.yml

js/releases/index.js

lib/releases/index.js

lib/types.ts

package.json

cursor · 2025-11-07T11:31:59Z

package.json

-    "postinstall": "node ./scripts/install.js",
+    "postinstall": "npm run install-cli",
+    "build": "tsc",
+    "postbuild": "npm run install-cli",


Bug: NPM Postbuild Re-downloads Binary After Compile

The postbuild hook running npm run install-cli causes the CLI binary download script to execute after every TypeScript compilation. This creates unnecessary overhead during development since rebuilding TypeScript source doesn't require re-downloading or re-verifying the binary, and could fail in offline environments or slow down builds significantly with network latency.

package.json

szokeasaurusrex

I'll wait for @andreiborza to approve this, then I can provide a stamp (I think my approval is needed for some of the changes based on the code owner config)

andreiborza · 2025-11-10T14:48:34Z

@szokeasaurusrex approved :)

szokeasaurusrex

noice

This script is actually not needed for our testing purpose. This was initially in #2910 added, since we call `--ignore-scripts` before, which doesn't call the `postinstall` script (so it was mainly added to keep the same functionality as before). This line actually also caused issues for our release process - that should be fixed now

JPeer264 requested review from andreiborza and szokeasaurusrex November 4, 2025 13:49

JPeer264 requested a review from a team as a code owner November 4, 2025 13:49

JPeer264 force-pushed the jp/change-to-typescript branch from da498c2 to b90e8fa Compare November 4, 2025 14:26

This comment was marked as outdated.

Sign in to view

JPeer264 mentioned this pull request Nov 4, 2025

Align JS API between commands that accept multiple projects #2902

Closed

JPeer264 requested a review from a team as a code owner November 4, 2025 14:59

JPeer264 requested a review from nicohrubec November 4, 2025 14:59

This comment was marked as outdated.

Sign in to view

JPeer264 force-pushed the jp/change-to-typescript branch from 1d8386e to 40f67ab Compare November 4, 2025 15:03

szokeasaurusrex reviewed Nov 5, 2025

View reviewed changes

.github/workflows/build.yml Show resolved Hide resolved

.github/workflows/test_node.yml Outdated Show resolved Hide resolved

.github/workflows/test_node.yml Show resolved Hide resolved

js/releases/index.js Show resolved Hide resolved

andreiborza reviewed Nov 5, 2025

View reviewed changes

.github/workflows/test_node.yml Show resolved Hide resolved

js/releases/index.js Outdated Show resolved Hide resolved

lib/releases/index.js Show resolved Hide resolved

lib/types.ts Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

JPeer264 force-pushed the jp/change-to-typescript branch from 9815a2d to 46189d1 Compare November 7, 2025 11:29

JPeer264 requested a review from andreiborza November 7, 2025 11:31

cursor bot reviewed Nov 7, 2025

View reviewed changes

JPeer264 force-pushed the jp/change-to-typescript branch from 46189d1 to 587c934 Compare November 7, 2025 11:47

szokeasaurusrex reviewed Nov 10, 2025

View reviewed changes

andreiborza approved these changes Nov 10, 2025

View reviewed changes

szokeasaurusrex approved these changes Nov 10, 2025

View reviewed changes

JPeer264 added 4 commits November 17, 2025 08:44

chore: Prepare to use TypeScript natively

df8e1d9

chore: Move types as they were before

c50084d

chore: Update cursor hints for JavaScript development

6d04477

chore: prebuild dist folder | add changelog

be48e79

JPeer264 force-pushed the jp/change-to-typescript branch from 587c934 to be48e79 Compare November 17, 2025 07:44

JPeer264 enabled auto-merge (squash) November 17, 2025 07:46

JPeer264 merged commit f9878c8 into master Nov 17, 2025
28 checks passed

JPeer264 deleted the jp/change-to-typescript branch November 17, 2025 07:48

JPeer264 mentioned this pull request Dec 10, 2025

chore: Remove install script in GitHub Actions #3020

Merged

Uh oh!

Conversation

JPeer264 commented Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

What's new / changed

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

JPeer264 commented Nov 4, 2025

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JPeer264 commented Nov 5, 2025

Uh oh!

andreiborza left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot Nov 7, 2025

Choose a reason for hiding this comment

Bug: NPM Postbuild Re-downloads Binary After Compile

Uh oh!

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

andreiborza commented Nov 10, 2025

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JPeer264 commented Nov 4, 2025 •

edited

Loading