FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: refine conditional exports documentation by guybedford · Pull Request #32098 · nodejs/node · GitHub

/ node Public

docs: refine conditional exports documentation - #32098

Closed
guybedford wants to merge 39 commits into
masterfrom
doc-exports-pattern
ConversationCommits (39)ChecksFiles changed
Closed

docs: refine conditional exports documentation#32098
guybedford wants to merge 39 commits into
masterfrom
doc-exports-pattern

Conversation

guybedford commented Mar 4, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

This began as a bigger change of guidance but has been pulled back to a simple docs refactoring.

  • Moves exports sugar section up
  • Makes conditional exports examples using main form directly
  • Explains conditional exports sugar second
  • Adds some extra guidance on conditions usage
  • Cuts down on some unnecessary explanations to try aid readability
  • Removes incorrect statement about export main falling back to package.json main

Resolves #32107.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • [] tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

nodejs-github-bot added doc Issues and PRs related to the documentations. esm Issues and PRs related to the ECMAScript Modules implementation. labels Mar 4, 2020
guybedford changed the title docs: update conditional exports recommendations docs: refine conditional exports documentation Mar 4, 2020

guybedford commented Mar 4, 2020

Copy link
Copy Markdown
Contributor Author

Discussing this further, early 13.x support not working isn't that bad, and it may make sense not to skew things towards this compatibility after all.

I've completely pulled this back to just be a docs refactoring in that case.

GeoffreyBooth reviewed Mar 4, 2020
View reviewed changes
Comment thread doc/api/esm.md Outdated
Comment thread doc/api/esm.md Outdated
Comment thread doc/api/esm.md Outdated
Comment thread doc/api/esm.md Outdated
Comment thread doc/api/esm.md Outdated
Comment thread doc/api/esm.md Outdated
Comment thread doc/api/esm.md Outdated
Comment thread doc/api/esm.md
Comment thread doc/api/esm.md Outdated
MylesBorins and others added 9 commits March 4, 2020 18:16
Update doc/api/esm.md
177d3dc 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
86f417b 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
b41d5b6 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
d030297 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
f2e8b26 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
05ee0db 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
e9ed602 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
c251c50 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
reorder conditions, note nesting, update encapsulation note, exports …
74206e7 
…updates

guybedford commented Mar 6, 2020

Copy link
Copy Markdown
Contributor Author

@GeoffreyBooth thanks for the initial review - I've added some further refactorings here in 74206e7.

If you have a moment to review that would be great.

ljharb reviewed Mar 6, 2020
View reviewed changes
Comment thread doc/api/esm.md Outdated
GeoffreyBooth reviewed Mar 6, 2020
View reviewed changes
Comment thread doc/api/esm.md
GeoffreyBooth reviewed Mar 6, 2020
View reviewed changes
Comment thread doc/api/esm.md Outdated
guybedford and others added 10 commits March 11, 2020 22:15
Update doc/api/esm.md
fc7f258 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
606eec3 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
6a28834 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
598da72 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
59729d4 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
15bdd25 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
fixup line length
a74474c
Update doc/api/esm.md
20ebd1a 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
33d7d9c 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
Update doc/api/esm.md
13e1c71 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
GeoffreyBooth reviewed Mar 11, 2020
View reviewed changes
Comment thread doc/api/esm.md Outdated
addaleax pushed a commit that referenced this pull request Mar 13, 2020
doc: update conditional exports recommendations
04028aa 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
PR-URL: #32098
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>

addaleax commented Mar 13, 2020

Copy link
Copy Markdown
Member

Landed in 04028aa

addaleax closed this Mar 13, 2020
addaleax deleted the doc-exports-pattern branch March 13, 2020 09:09
BridgeAR pushed a commit that referenced this pull request Mar 17, 2020
doc: update conditional exports recommendations
ce58e02 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
PR-URL: #32098
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
MylesBorins mentioned this pull request Mar 19, 2020
Merged
MylesBorins pushed a commit that referenced this pull request Mar 24, 2020
doc: update conditional exports recommendations
597bcb5 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
PR-URL: #32098
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
MylesBorins pushed a commit to MylesBorins/node that referenced this pull request Apr 3, 2020
doc: update conditional exports recommendations
4ab422a 
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
PR-URL: nodejs#32098
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
MylesBorins pushed a commit that referenced this pull request Apr 3, 2020
doc: update conditional exports recommendations
155a6c3 
Backport-PR-URL: #32610
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
PR-URL: #32098
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
codebytere mentioned this pull request Apr 4, 2020
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ljharb ljharb left review comments
GeoffreyBooth GeoffreyBooth approved these changes
+1 more reviewer
JLHwung JLHwung left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations. esm Issues and PRs related to the ECMAScript Modules implementation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

package.exports: false is not working with module loader

7 participants

Back | FazBrowse Home | New Git URL