Add better entry point description #1177
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current docs say > is used to define the entry point of your code used by programs like Node.js. If unspecified it will default to index.js. Since Node is not a program, is an execution environment, the description given proposes to change, to avoid misconceptions about how javascript and javascript packages really work. I think is convenient to try to unify definitions and criteria. Also, today NodeJS purpose the "exports" entry point usage instead of "main" entry, and this entry point (exports) has better support for universal packages.
|
Good little addition, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change fixes the missing flag in the first example. If you just run yarn version it will only plot the version, not change it.
Update the note from the end of the first example to the --new-version flag where it is related to.
The current docs say the next about NodeJS:
This PR proposes to change the NodeJS definition, seeking to avoid confusion about how javascript and javascript packages really work.
Also, today NodeJS purpose the "exports" entry point usage instead of "main" entry, and this entry point (exports) has better support for universal packages.
Also is proposed to add a mention of "exports" entry point which is taken over "main" entry point if it is defined. The paragraph is added after the explanation about the entry points contained.