Skip to content

module: package exports dot main support - #29494

Closed
guybedford wants to merge 4 commits into
nodejs:masterfrom
guybedford:dot-main
Closed

module: package exports dot main support#29494
guybedford wants to merge 4 commits into
nodejs:masterfrom
guybedford:dot-main

Conversation

@guybedford

@guybedfordguybedford commented Sep 8, 2019

Copy link
Copy Markdown
Contributor

This reintroduces the dot main in exports as discussed in the previous Node.js modules meeting.

The implementation includes both CommonJS and ES module resolution with the associated documentation and resolver specification changes.

In addition to the dot main, "exports" as a string or direct fallback array is supported as well.

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 the c++ Issues and PRs that require attention from people who are familiar with C++. label Sep 8, 2019
@guybedford

guybedford commented Sep 8, 2019

Copy link
Copy Markdown
ContributorAuthor

//cc @nodejs/modules-active-members

GeoffreyBooth
GeoffreyBooth approved these changes Sep 8, 2019
View reviewed changes
Comment threaddoc/api/esm.md Outdated
Comment threaddoc/api/esm.md Outdated
@GeoffreyBoothGeoffreyBooth mentioned this pull request Sep 8, 2019
Closed
2 tasks
guybedfordand others added 3 commits September 8, 2019 15:29
@guybedford
linting fix
a9e9bb5
@guybedford@GeoffreyBooth
Update doc/api/esm.md
690237d
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
@guybedford@GeoffreyBooth
Update doc/api/esm.md
9f7bc64
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
@benjamingr

benjamingr commented Sep 8, 2019

Copy link
Copy Markdown
Member

Random governance question - who is supposed to approve these changes? Modules team members or core collaborators?

Has the TSC chartered the module team to make changes to this area of the code on its own or something similar?

(I am asking because I see two approvals by non-collaborator members and I am a bit confused if those LGTMs are "I agree with this change and it can land" "I agree with this change" or "This is what the team said" and if regular collaborators are expected to review those or not)

@devsnek

devsnek commented Sep 8, 2019

Copy link
Copy Markdown
Member

cc @MylesBorins ^

@guybedford

guybedford commented Sep 8, 2019

Copy link
Copy Markdown
ContributorAuthor

@benjamingr the standard Node.js core approval process applies since the modules group is not chartered. We typically seek consensus from the modules group before landing non-patch changes to the module system though.

@benjamingr

benjamingr commented Sep 9, 2019

Copy link
Copy Markdown
Member

Thanks for explaining @guybedford!

hybrist
hybrist reviewed Sep 9, 2019
View reviewed changes
Comment threadsrc/module_wrap.cc
hybrist
hybrist approved these changes Sep 9, 2019
View reviewed changes

@hybristhybrist left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in general but I'd prefer if we can remove the duplication between the code for . and other exports keys.

Comment threadsrc/module_wrap.cc
target =
exports_obj->Get(env->context(), dot_string).ToLocalChecked();
}
if (target->IsString()) {

@hybristhybristSep 9, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to reuse the existing logic for string/array in PackageExportsResolve?

@guybedfordguybedfordSep 9, 2019•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be better, it's just a refactoring I haven't had the time for. Would you be ok with moving that to a follow-up?

@hybristhybristSep 9, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works for me.

@guybedford

guybedford commented Sep 10, 2019

Copy link
Copy Markdown
ContributorAuthor

It's worth noting here, that:

{"exports": "./esm-main.js"}

is supported by this PR, but:

{"exports": "esm-main.js"}

would not be supported and would throw an error that exports must start with ./.

This is based on various long-standing discussions, but still worth noting in how it deviates from "main".

@hybristhybrist mentioned this pull request Sep 11, 2019
Closed
MylesBorins
MylesBorins approved these changes Sep 11, 2019
View reviewed changes

@MylesBorinsMylesBorins left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@guybedfordguybedford added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 16, 2019
@nodejs-github-bot

nodejs-github-bot commented Sep 16, 2019

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/25498/

@nodejs-github-bot

nodejs-github-bot commented Sep 16, 2019

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/25502/

@hybrist

hybrist commented Sep 16, 2019

Copy link
Copy Markdown
Contributor

🍏

@Trott

Trott commented Sep 18, 2019

Copy link
Copy Markdown
Member

Landed in 3f3ad38

@TrottTrott closed this Sep 18, 2019
Trott pushed a commit that referenced this pull request Sep 18, 2019
@guybedford@GeoffreyBooth@Trott
module: reintroduce package exports dot main
3f3ad38
This reintroduces the dot main in exports as discussed in the previous
Node.js modules meeting.
The implementation includes both CommonJS and ES module resolution with
the associated documentation and resolver specification changes.
In addition to the dot main, "exports" as a string or direct fallback
array is supported as well.
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
PR-URL: #29494
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
targos pushed a commit that referenced this pull request Sep 20, 2019
@guybedford@GeoffreyBooth@targos
module: reintroduce package exports dot main
4b3b4ff
This reintroduces the dot main in exports as discussed in the previous
Node.js modules meeting.
The implementation includes both CommonJS and ES module resolution with
the associated documentation and resolver specification changes.
In addition to the dot main, "exports" as a string or direct fallback
array is supported as well.
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
PR-URL: #29494
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@BridgeARBridgeAR mentioned this pull request Sep 24, 2019
Merged
BridgeAR pushed a commit that referenced this pull request Sep 25, 2019
@guybedford@GeoffreyBooth@BridgeAR
module: reintroduce package exports dot main
ce45aae
This reintroduces the dot main in exports as discussed in the previous
Node.js modules meeting.
The implementation includes both CommonJS and ES module resolution with
the associated documentation and resolver specification changes.
In addition to the dot main, "exports" as a string or direct fallback
array is supported as well.
Co-Authored-By: Geoffrey Booth <GeoffreyBooth@users.noreply.github.com>
PR-URL: #29494
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
This was referenced Sep 25, 2019
Closed
Closed
Closed
Closed
Closed
Closed
@aduh95aduh95 mentioned this pull request Feb 9, 2021
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hybristhybristhybrist approved these changes
@ljharbljharbljharb approved these changes
@GeoffreyBoothGeoffreyBoothGeoffreyBooth approved these changes
+1 more reviewer
@MylesBorinsMylesBorinsMylesBorins approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.c++Issues and PRs that require attention from people who are familiar with C++.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@guybedford@benjamingr@devsnek@nodejs-github-bot@hybrist@Trott@ljharb@GeoffreyBooth@MylesBorins