Create a new repository for documenting CJS/ESM package shipping patterns
Closed this issue · 6 comments
When working on nodejs/node#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
We might want to move some of that to the Learn section of the website too.
I think Learn is the ideal place for recommendations :)
I think this is good to go?
yes
+1 from me
Created https://github.com/nodejs/package-examples and chose the MIT license (since the addons example repo also used that). Will work on files to add there.