Azure / azure-sdk-for-js

This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/javascript/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-js.
MIT License
2.09k stars 1.2k forks source link

Should we continue to distribute rolled up dts? #31310

Open maorleger opened 1 month ago

maorleger commented 1 month ago

Packages using tshy generally contain multiple dts files - CJS, ESM, etc.

Each directory contains dts files and the package.json points to specific flavor depending on the import type.

Prior to the migration, we shipped a single rolled-up d.ts file using API Extractor.

We still include it in the build, but it is no longer referenced in package.json.

Should we continue to ship rolled up dts? If so, should we create a rollup dts per output target?

          I don't recall what we are doing for the other packages, but is it intentional that we're not using the rolled-up d.ts from API extractor (dist/keyvault-secrets.d.ts) here? If so, maybe we don't need to ship the rolled-up version.

_Originally posted by @timovv in https://github.com/Azure/azure-sdk-for-js/pull/31254#discussion_r1786858583_

xirzec commented 1 month ago

Since we're not using api-extractor's pruning feature to remove @beta apis and such, does the rollup offer any improvement other than perhaps some speedier parsing? Can we measure a difference?