feat: Move javascript files to native typescript #2989

JPeer264 · 2025-11-26T16:02:56Z

(closes #2617)
(closes CLI-142)

This PR migrates all JavaScript files in the lib/ directory to native TypeScript, removing the need for JSDoc type annotations and improving type safety.

Main Changes

Converted all .js files to .ts with proper TypeScript syntax
Changed module system from CommonJS to ES6 modules for better TypeScript interoperability
Updated exports to use ES6 export syntax instead of module.exports
All types are now exported as named exports for better type inference and IDE support
OptionsSchema is now a union to satisfy SOURCEMAPS_OPTIONS, as this one didn't had the required param
The exports of lib/releases/options has changed its name

Breaking Changes

Module Exports

Before: module.exports = SentryCli; (CommonJS)
After: export class SentryCli { ... } (ES6 named export)

We could have maintained backwards compatibility with export = SentryCli;. The only problem were the types which needed to be exported as well. With ES6 named exports, we can now export all types alongside the class.

Internal Improvements

Simplified Release constructor

Before: new Releases({ ...this.options, configFile }) - configFile was merged into options
After: new Releases(this.options, configFile) - two separate parameters

With 2 parameters it's easier to maintain and makes the separation of concerns clearer.

github-actions · 2025-11-26T16:03:36Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against 0f60c1c

cursor

Bug: rejectOnError always rejects after resolving

When live is 'rejectOnError' and the command succeeds with exit code 0, the code resolves with 'success (live mode)' but then immediately continues to execute the reject statement because there's no return or else. This causes the promise to be settled twice and creates incorrect behavior where successful commands trigger rejection logic.

lib/helper.ts#L342-L348

sentry-cli/lib/helper.ts

Lines 342 to 348 in a8e7f1f

 pid.on('exit', (exitCode) => { 

 if (live === 'rejectOnError') { 

 if (exitCode === 0) { 

 resolve('success (live mode)'); 

 } 

 reject(new Error(`Command ${args.join(' ')} failed with exit code ${exitCode}`)); 

 }

cursor · 2025-11-26T16:37:12Z

lib/index.ts

+   * @param options More options to pass to the CLI
   */
- constructor(configFile, options) {
+ constructor(public configFile: string | null, public options: SentryCliOptions) {


Bug: SentryCli constructor breaks backwards compatibility

The constructor declares both configFile and options as required parameters without default values, but existing code calls new SentryCli() with no arguments. The original JavaScript version allowed both parameters to be optional. This breaks backwards compatibility beyond just the import syntax change documented in the CHANGELOG.

CHANGELOG.md

cursor · 2025-11-26T16:49:31Z

lib/helper.ts

- * @param {OptionsSchema} [schema] An options schema required by the command.
- * @param {object} [options] An options object according to the schema.
- * @returns {string[]} An arguments array that can be passed via command line.
+ * @param command The literal name of the command.


Bug: Undefined paramName used in non-boolean types

When OptionsSchema entries have only invertedParam without param, the paramName variable becomes undefined. For non-boolean types like string or number, line 237 concatenates undefined into the arguments array, creating invalid command-line arguments. This case needs proper handling to skip entries without a param for non-boolean types.

lib/releases/index.ts

andreiborza

Overall LGTM although I think we should rethink breaking the default export if avoidable. It makes migration slightly more annoying for little benefit to the user and I'm not sure it's worth the change, but your call.

lib/releases/index.ts

JPeer264 · 2025-12-01T10:39:17Z

It makes migration slightly more annoying for little benefit to the user and I'm not sure it's worth the change, but your call.

Yes it is a change that the user has to do. The problem however, is that with tsc alone it'd be hard to support ESM & CJS in the future easily. Changing the export seems to be the least harmful.

Just for the record those are the 3 options we have (maybe I miss someone):

Change the export to a named export (current) (this would work in CJS and ESM OOTB, but requires one change)
Change the export to a default export (that would require CJS users to add .default)
Use export = for backwards compatibility. With that we can't export additional types, which would defeat the purpose of having TypeScript (I think this one would also not work in ESM)

For point 2, we could theoretically add module.exports in the buildstep - but I guess tsc does not support that one.

lib/index.ts

+   * @param options More options to pass to the CLI
   */
- constructor(configFile, options) {
+ constructor(public configFile: string | null, public options: SentryCliOptions) {
 if (typeof configFile === 'string') {
 this.configFile = configFile;
 }
 this.options = options || { silent: false };


andreiborza

Right... fair enough then. I was thinking about our main repo, but totally different build system. I guess with that LGTM!

We just need to make sure we migrate all our repos correctly, few I can think of off of the top of my head:

szokeasaurusrex

I only briefly checked this since @andreiborza already approved, but lgtm!

szokeasaurusrex · 2025-12-02T15:24:21Z

lib/releases/options/uploadSourcemaps.ts

 type: 'boolean',
 },
-};
+} satisfies OptionsSchema;


[nit] please fix the missing newline

Suggested change

} satisfies OptionsSchema;

} satisfies OptionsSchema;

I should probably enable pre-commit to auto fix these

linear · 2025-12-03T08:20:09Z

CLI-142 Use `typescript` to generate type declarations

szokeasaurusrex · 2025-12-04T10:09:48Z

@JPeer264 is this PR ready to be added to my stack? I can take care of merging conflicts

JPeer264 · 2025-12-04T14:09:31Z

yes it is ready

lib/helper.ts

lib/index.ts

 if (typeof configFile === 'string') {
 this.configFile = configFile;
 }
 this.options = options || { silent: false };


lib/index.ts

+ constructor(public configFile: string | null, public options: SentryCliOptions) {
 if (typeof configFile === 'string') {
 this.configFile = configFile;
 }
 this.options = options || { silent: false };
- this.releases = new Releases({ ...this.options, configFile });
+ this.releases = new Releases(this.options, configFile);


lib/helper.ts

+async function execute(
+ args: string[],
+ live: boolean,
+ silent: boolean,
+ configFile: string | undefined,
+ config: SentryCliOptions = {}
+): Promise<string> {


lib/index.ts

+   * @param options More options to pass to the CLI
   */
- constructor(configFile, options) {
+ constructor(public configFile: string | null, public options: SentryCliOptions) {
 if (typeof configFile === 'string') {
 this.configFile = configFile;
 }
 this.options = options || { silent: false };
- this.releases = new Releases({ ...this.options, configFile });
+ this.releases = new Releases(this.options, configFile);


(closes #2617) (closes [CLI-142](https://linear.app/getsentry/issue/CLI-142/use-typescript-to-generate-type-declarations)) This PR migrates all JavaScript files in the `lib/` directory to native TypeScript, removing the need for JSDoc type annotations and improving type safety. ### Main Changes - Converted all `.js` files to `.ts` with proper TypeScript syntax - Changed module system from CommonJS to ES6 modules for better TypeScript interoperability - Updated exports to use ES6 `export` syntax instead of `module.exports` - All types are now exported as named exports for better type inference and IDE support - `OptionsSchema` is now a union to satisfy `SOURCEMAPS_OPTIONS`, as this one didn't had the required `param` - The exports of `lib/releases/options` has changed its name ### Breaking Changes **Module Exports** - **Before**: `module.exports = SentryCli;` (CommonJS) - **After**: `export class SentryCli { ... }` (ES6 named export) We could have maintained backwards compatibility with `export = SentryCli;`. The only problem were the types which needed to be exported as well. With ES6 named exports, we can now export all types alongside the class. ### Internal Improvements Simplified `Release` constructor - **Before**: `new Releases({ ...this.options, configFile })` - configFile was merged into options - **After**: `new Releases(this.options, configFile)` - two separate parameters With 2 parameters it's easier to maintain and makes the separation of concerns clearer.

JPeer264 requested review from andreiborza and szokeasaurusrex November 26, 2025 16:02

JPeer264 self-assigned this Nov 26, 2025

JPeer264 requested review from a team as code owners November 26, 2025 16:02

JPeer264 requested review from nicohrubec and removed request for a team November 26, 2025 16:02

JPeer264 added the v3.0 Breaking changes to include in version 3.0.0 of Sentry CLI label Nov 26, 2025

JPeer264 changed the title ~~feat: move javascript files to native typescript~~ feat: Move javascript files to native typescript Nov 26, 2025

JPeer264 force-pushed the jp/move-to-native-typescript branch from 15c05f5 to a8e7f1f Compare November 26, 2025 16:33

cursor bot reviewed Nov 26, 2025

View reviewed changes

JPeer264 force-pushed the jp/drop-node branch from a9f9165 to a809a5c Compare November 26, 2025 16:39

JPeer264 force-pushed the jp/move-to-native-typescript branch from a8e7f1f to d5414fc Compare November 26, 2025 16:45

cursor bot reviewed Nov 26, 2025

View reviewed changes

andreiborza approved these changes Dec 1, 2025

View reviewed changes

lib/releases/index.ts Outdated Show resolved Hide resolved

lib/releases/index.ts Outdated Show resolved Hide resolved

sentry bot reviewed Dec 1, 2025

View reviewed changes

andreiborza approved these changes Dec 1, 2025

View reviewed changes

szokeasaurusrex approved these changes Dec 2, 2025

View reviewed changes

szokeasaurusrex force-pushed the jp/drop-node branch from a809a5c to 3877b10 Compare December 3, 2025 09:24

szokeasaurusrex requested a review from a team as a code owner December 3, 2025 09:24

szokeasaurusrex force-pushed the jp/drop-node branch from 3877b10 to 7dce072 Compare December 3, 2025 10:00

cursor bot reviewed Dec 4, 2025

View reviewed changes

lib/helper.ts Show resolved Hide resolved

szokeasaurusrex force-pushed the jp/move-to-native-typescript branch from f1119df to 36bbead Compare December 10, 2025 13:31

szokeasaurusrex changed the base branch from jp/drop-node to graphite-base/2989 December 10, 2025 13:32

szokeasaurusrex changed the base branch from graphite-base/2989 to szokeasaurusrex/debugId December 10, 2025 13:32

sentry bot reviewed Dec 10, 2025

View reviewed changes

lib/index.ts

if (typeof configFile === 'string') {

this.configFile = configFile;

}

this.options = options || { silent: false };

This comment was marked as outdated.

Sign in to view

szokeasaurusrex removed request for a team and nicohrubec December 10, 2025 13:36

szokeasaurusrex force-pushed the jp/move-to-native-typescript branch from 36bbead to 60bb5c0 Compare December 10, 2025 13:41

sentry bot reviewed Dec 10, 2025

View reviewed changes

szokeasaurusrex force-pushed the jp/move-to-native-typescript branch from 60bb5c0 to c7f20b7 Compare December 10, 2025 13:53

This was referenced Dec 10, 2025

ref: Use undici to download binary #2993

Open

meta(changelog): Update supported self-hosted version #3022

Closed

szokeasaurusrex force-pushed the jp/move-to-native-typescript branch from c7f20b7 to d0453c4 Compare December 11, 2025 09:59

szokeasaurusrex force-pushed the szokeasaurusrex/debugId branch from a7bea4b to 5387d79 Compare December 11, 2025 09:59

szokeasaurusrex mentioned this pull request Dec 11, 2025

meta(versioning): Define versioning policy #3025

Open

szokeasaurusrex force-pushed the szokeasaurusrex/debugId branch from 5387d79 to 51ded13 Compare December 11, 2025 13:44

szokeasaurusrex force-pushed the jp/move-to-native-typescript branch from d0453c4 to 2c953fe Compare December 11, 2025 13:44

sentry bot reviewed Dec 11, 2025

View reviewed changes

szokeasaurusrex force-pushed the szokeasaurusrex/debugId branch from 51ded13 to f23b920 Compare December 11, 2025 16:10

szokeasaurusrex force-pushed the jp/move-to-native-typescript branch from 2c953fe to 98e6185 Compare December 11, 2025 16:10

szokeasaurusrex mentioned this pull request Dec 11, 2025

docs(readme): Set minimum self-hosted version #3027

Open

szokeasaurusrex force-pushed the szokeasaurusrex/debugId branch from f23b920 to ab53dc2 Compare December 11, 2025 16:25

szokeasaurusrex force-pushed the jp/move-to-native-typescript branch from 98e6185 to 6b32ed2 Compare December 11, 2025 16:25

szokeasaurusrex force-pushed the szokeasaurusrex/debugId branch from ab53dc2 to acf0e03 Compare December 11, 2025 17:20

szokeasaurusrex force-pushed the jp/move-to-native-typescript branch from 6b32ed2 to 3679dc2 Compare December 11, 2025 17:20

szokeasaurusrex force-pushed the szokeasaurusrex/debugId branch from acf0e03 to ee866b7 Compare December 12, 2025 12:04

szokeasaurusrex force-pushed the jp/move-to-native-typescript branch from 3679dc2 to 0f60c1c Compare December 12, 2025 12:04

	pid.on('exit', (exitCode) => {
	if (live === 'rejectOnError') {
	if (exitCode === 0) {
	resolve('success (live mode)');
	}
	reject(new Error(`Command ${args.join(' ')} failed with exit code ${exitCode}`));
	}

Uh oh!

feat: Move javascript files to native typescript #2989

Are you sure you want to change the base?

feat: Move javascript files to native typescript #2989

Conversation

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

Uh oh!

Main Changes

Breaking Changes

Internal Improvements

Uh oh!

github-actions bot commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: rejectOnError always rejects after resolving

Uh oh!

cursor bot Nov 26, 2025

Choose a reason for hiding this comment

Bug: SentryCli constructor breaks backwards compatibility

Uh oh!

Uh oh!

cursor bot Nov 26, 2025

Choose a reason for hiding this comment

Bug: Undefined paramName used in non-boolean types

Uh oh!

Uh oh!

andreiborza left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JPeer264 commented Dec 1, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

andreiborza left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex left a comment

Choose a reason for hiding this comment

Uh oh!

szokeasaurusrex Dec 2, 2025

Choose a reason for hiding this comment

Uh oh!

linear bot commented Dec 3, 2025

Uh oh!

szokeasaurusrex commented Dec 4, 2025

Uh oh!

JPeer264 commented Dec 4, 2025

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

JPeer264 commented Nov 26, 2025 •

edited

Loading

github-actions bot commented Nov 26, 2025 •

edited

Loading

andreiborza left a comment •

edited

Loading