Post

arethetypeswrong.github.ioAre The Types Wrong?Tool for analyzing TypeScript types of npm packages

Nice post! Slightly adjacent but also useful is this tool by @andrewbran.ch which checks the state of types on a package.json - I've found it super helpful! arethetypeswrong.github.io

hirok.ioGuide to the Node.js `exports` fieldTake control of how your npm package is accessed with the package.json `exports` field

Thanks John! And great idea 🙌 Just added a section for it: hirok.io/posts/node-e...

Joyee Cheung

@joyeecheung.bsky.social

github.comBootstrapping the initiative: TODOs? · Issue #2 · nodejs/package-examplesA few TODOs come to mind: Starting a team for looking into the package shipping patterns. We'll need to set up contribution guidelines and team onboarding/offloading/consensus seeking. It would be ...

Nice article! FYI we are looking into better documenting the package shipping patterns with a repo full of examples, especially to come out with ESM upgrade guides with require(esm) rolling out to LTS soon github.com/nodejs/packa... will also take some notes from this post!

Joyee Cheung

@joyeecheung.bsky.social

github.comSession Proposal: module loading customization/optimization and CJS/ESM interoperability · Issue #422 · openjs-foundation/summitProposal Topic of the session Discuss recent module loading customization and interoperability efforts Type of the session Collaborate Workshop Talk Estimated duration of the session 1h Date and Ti...

There were a lot of ideas discussed from the collab summit last week (notes github.com/openjs-found...) planning to getting the ball rolling in the following weeks…

Wow that's a ton of insightful context! Will take some time to read through them and see if I can help in any way Always appreciate your thoughtful contributions Joyee 🙌

VanTanev

@vantanev.bsky.social

arethetypeswrong.github.ioAre The Types Wrong?Tool for analyzing TypeScript types of npm packages

Think it might be worth mentioning in the TS section that types must be first. For example, if you export types + ESM + CJS, the order must be "types, module, default". Also worth maybe mentioning this tool for validation of types + export conditions arethetypeswrong.github.io By @andrewbran.ch

hirok.ioGuide to the Node.js `exports` fieldTake control of how your npm package is accessed with the package.json `exports` field

Really good points! I addressed them all - hirok.io/posts/node-e... - hirok.io/posts/node-e... BTW `types` must be nested inside `require` and `import`. Exports with keys types, import, default was the classic mistake everyone made 😵‍💫

VanTanev

@vantanev.bsky.social

Hmm, I've used "types, import, default" and it seemed to work well? It's also used by eg preconstruct.tools Can you elaborate or point me to some resource on why it's wrong?

Yes, see the blog 😆 The TypeScript docs and 2 validation tools are linked The reason why it’s incorrect is because the d.ts file needs to match the module format of the file its paired with but there’s only one for both ESM and CJS

📌

This is helpful because it’s one of those things you tend to figure out once at the beginning of the project and then never revisit. Good to have a well written summary of it.

Thanks Tyler! I'm glad it helped 🙌

Kristóf Poduszló

@kripod.dev

15 Nov 2024

Guess who got lucky today, @jamie.build 😄 bsky.app/profile/jami...

Jamie Kyle@jamie.build

This might be the post that finally gets me to learn how package.json#exports works

Bjorn Lu

@bluwy.me

15 Nov 2024

Nice and comprehensive! It has been something I always wanted to write but never got the energy, now I can link to this instead

Thanks Bjorn! Please do 🙌 And LMK if there's anything I missed 🙏

Joaquín Sánchez

@userquin.bsky.social

Nice article, how about using typesVersions for node legacy consumers and subpackage exports?