-
Notifications
You must be signed in to change notification settings - Fork 135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create a new repository for documenting CJS/ESM package shipping patterns #917
Comments
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. |
joyeecheung
added a commit
to joyeecheung/node
that referenced
this issue
Oct 18, 2024
nodejs-github-bot
pushed a commit
to nodejs/node
that referenced
this issue
Oct 22, 2024
Refs: nodejs/admin#917 Refs: nodejs/package-examples#1 Refs: #54648 PR-URL: #55444 Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
aduh95
pushed a commit
to nodejs/node
that referenced
this issue
Oct 23, 2024
Refs: nodejs/admin#917 Refs: nodejs/package-examples#1 Refs: #54648 PR-URL: #55444 Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
louwers
pushed a commit
to louwers/node
that referenced
this issue
Nov 2, 2024
Refs: nodejs/admin#917 Refs: nodejs/package-examples#1 Refs: nodejs#54648 PR-URL: nodejs#55444 Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
tpoisseau
pushed a commit
to tpoisseau/node
that referenced
this issue
Nov 21, 2024
Refs: nodejs/admin#917 Refs: nodejs/package-examples#1 Refs: nodejs#54648 PR-URL: nodejs#55444 Reviewed-By: Chengzhong Wu <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
The text was updated successfully, but these errors were encountered: