Ship Starlight using .js + .d.ts files

[HiDeoo]

What version of starlight are you using?

0.11.1

What is your idea?

Starlight is currently shipped as TypeScript code with no .d.ts files. This suggests to compile the TypeScript code and ship .js + .d.ts files.

Why is this feature necessary?

This discussion is a follow-up of #861.

Typechecking code importing various parts of Starlight can currently be difficult due to the fact that @astrojs/starlight is not compiled and ship TypeScript code with no .d.ts files.

For example, an integration importing a TypeScript file from @astrojs/starlight could fail to typecheck with tsc --noEmit for some stylistic reasons like noPropertyAccessFromIndexSignature if the integration uses this rule but @astrojs/starlight doesn't as the Starlight shipped TypeScript code will be typechecked with the integration's tsconfig.json.

As commented by a TS maintainer in this comment or this one, this is expected behavior with such a setup. The solution is to compile the TypeScript code and ship .js + .d.ts files.

Notes:

• A pre-requisite for this is to have a few remaining TypeScript errors fixed in Starlight (I have already started working on a PR for this).
• Using astro-scripts will not be a solution as this is not published

Do you have examples of this feature in other projects?

No response

Participation

• I am willing to submit a pull request for this feature.