search

nodejs / admin

Administrative space for policies of the TSC
153 stars 134 forks source link

Create a new repository for documenting CJS/ESM package shipping patterns #917

Open joyeecheung opened 1 week ago

joyeecheung commented 1 week ago

When working on https://github.com/nodejs/node/pull/54648 I noticed that the package API documentation has been documenting some opinionated patterns that some consider dangerous. I think instead of continue piling more opinionated patterns or bikeshed about them in the API docs, we should just move these into their own repository (similar to https://github.com/nodejs/node-addon-examples), with example folders containing the multi-file structures that they are describing, and maybe some links to the discussions about their pros and cons. This repository can be named package-examples, etc., and we can extend it to describe other patterns such as how TypeScript packages can configure themselves before being shipped to npm.

cc @nodejs/package-maintenance @nodejs/loaders @nodejs/tsc

mcollina commented 1 week ago

We might want to move some of that to the Learn section of the website too.