Skip to content

docs: refine conditional exports documentation - #32098

Closed
guybedford wants to merge 39 commits into
masterfrom
doc-exports-pattern
Closed

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

Conversation

@guybedford

@guybedfordguybedford 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-botnodejs-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
@guybedfordguybedford changed the title docs: update conditional exports recommendationsdocs: refine conditional exports documentationMar 4, 2020
@guybedford

guybedford commented Mar 4, 2020

Copy link
Copy Markdown
ContributorAuthor

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

guybedford commented Mar 6, 2020

Copy link
Copy Markdown
ContributorAuthor

@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
ljharb reviewed Mar 6, 2020
View reviewed changes
Comment threaddoc/api/esm.md Outdated
GeoffreyBooth
GeoffreyBooth reviewed Mar 6, 2020
View reviewed changes
Comment threaddoc/api/esm.md
GeoffreyBooth
GeoffreyBooth reviewed Mar 6, 2020
View reviewed changes
Comment threaddoc/api/esm.md Outdated
guybedfordand others added 10 commits March 11, 2020 22:15
@guybedford@GeoffreyBooth
Update doc/api/esm.md
fc7f258
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
@guybedford@GeoffreyBooth
Update doc/api/esm.md
606eec3
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
@guybedford@GeoffreyBooth
Update doc/api/esm.md
6a28834
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
@guybedford@GeoffreyBooth
Update doc/api/esm.md
598da72
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
@guybedford@GeoffreyBooth
Update doc/api/esm.md
59729d4
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
@guybedford@GeoffreyBooth
Update doc/api/esm.md
15bdd25
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
@guybedford
fixup line length
a74474c
@guybedford@GeoffreyBooth
Update doc/api/esm.md
20ebd1a
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
@guybedford@GeoffreyBooth
Update doc/api/esm.md
33d7d9c
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
@guybedford@GeoffreyBooth
Update doc/api/esm.md
13e1c71
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
GeoffreyBooth
GeoffreyBooth reviewed Mar 11, 2020
View reviewed changes
Comment threaddoc/api/esm.md Outdated
addaleax pushed a commit that referenced this pull request Mar 13, 2020
@guybedford@GeoffreyBooth@addaleax
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

addaleax commented Mar 13, 2020

Copy link
Copy Markdown
Member

Landed in 04028aa

@addaleax
addaleax deleted the doc-exports-pattern branch March 13, 2020 09:09
BridgeAR pushed a commit that referenced this pull request Mar 17, 2020
@guybedford@GeoffreyBooth@BridgeAR
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>
@MylesBorinsMylesBorins mentioned this pull request Mar 19, 2020
Merged
MylesBorins pushed a commit that referenced this pull request Mar 24, 2020
@guybedford@GeoffreyBooth@MylesBorins
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
@guybedford@GeoffreyBooth@MylesBorins
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
@guybedford@GeoffreyBooth@MylesBorins
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>
@codebyterecodebytere mentioned this pull request Apr 4, 2020
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ljharbljharbljharb left review comments
@GeoffreyBoothGeoffreyBoothGeoffreyBooth approved these changes
+1 more reviewer
@JLHwungJLHwungJLHwung left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.esmIssues 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

@guybedford@addaleax@ljharb@GeoffreyBooth@JLHwung@nodejs-github-bot@MylesBorins