doc: define "browser", "production", "development" conditions - #36856
Closed
guybedford wants to merge 9 commits into
Closed
doc: define "browser", "production", "development" conditions#36856guybedford wants to merge 9 commits into
guybedford wants to merge 9 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
ljharb
reviewed
Jan 9, 2021
Co-authored-by: Jordan Harband <ljharb@gmail.com>
jasnell
approved these changes
Jan 9, 2021
MylesBorins
reviewed
Jan 10, 2021
Comment thread
doc/api/packages.md
Outdated
Copy link
Copy Markdown
Member
|
This seems fine, but I'm not really hoping to add runtime checks for if a list of conditions is considered valid. |
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
Sure, I don't mind skipping adding those validations. |
Sorry, something went wrong.
Comment thread
doc/api/packages.md
Outdated
Comment thread
doc/api/packages.md
Comment thread
doc/api/packages.md
Co-authored-by: Geoffrey Booth <456802+GeoffreyBooth@users.noreply.github.com>
GeoffreyBooth
approved these changes
Jan 12, 2021
guybedford
added a commit
that referenced
this pull request
Jan 12, 2021
Defines the above exports conditions by convention as well as some guidance for further conditions definitions in future PR-URL: #36856 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
danielleadams
pushed a commit
that referenced
this pull request
Jan 13, 2021
Defines the above exports conditions by convention as well as some guidance for further conditions definitions in future PR-URL: #36856 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Merged
targos
pushed a commit
that referenced
this pull request
May 1, 2021
Defines the above exports conditions by convention as well as some guidance for further conditions definitions in future PR-URL: #36856 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Merged
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
7 participants
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.
As per recent conversations, this updates the conditions documentation to include a new Conditions Definitions section that defines the "browser", "production" and "development" conditions.
In terms of implemenation, we could possible add a simple validation that "production" and "development" are mutually exclusive when used in Node.js, but that could be a separate PR.
An alternative to the above would be to move these definitions to another home or location, which I'm completely open to as well.
In addition I've added some guidance on conditions defintions process, whether or not Node.js should be the primary home for this but as the original definition source of the "exports" field we can at least start the conversation here on this.
//cc @nodejs/modules @devongovett @sokra @developit