Skip to content

doc: move package.import content higher - #35535

Closed
MylesBorins wants to merge 1 commit into
nodejs:masterfrom
MylesBorins:imports-burried
Closed

doc: move package.import content higher#35535
MylesBorins wants to merge 1 commit into
nodejs:masterfrom
MylesBorins:imports-burried

Conversation

@MylesBorins

@MylesBorinsMylesBorins commented Oct 7, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

This is currently at the end of the doc, it likely should be found
right after the documentation about package.exports. Refactored the
docs while duplicating content as little as possible.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot

nodejs-github-bot commented Oct 7, 2020

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/modules

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 7, 2020
guybedford
guybedford approved these changes Oct 7, 2020
View reviewed changes
Comment threaddoc/api/packages.md Outdated
Comment threaddoc/api/packages.md Outdated
Comment threaddoc/api/packages.md Outdated

@guybedfordguybedfordOct 7, 2020

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.

Again, this is already included above.

Suggested change
Import maps permit mapping to external packages.

@MylesBorinsMylesBorinsOct 7, 2020

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.

While this is duplicated content I was trying to keep the most important stuff available in the reference doc

Comment threaddoc/api/packages.md Outdated
Comment threaddoc/api/packages.md Outdated
mcollina
mcollina approved these changes Oct 7, 2020
View reviewed changes

@mcollinamcollina left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm

Trott
Trott reviewed Oct 7, 2020
View reviewed changes
Comment threaddoc/api/packages.md Outdated
Trott
Trott reviewed Oct 7, 2020
View reviewed changes
Comment threaddoc/api/packages.md Outdated
Trott
Trott reviewed Oct 7, 2020
View reviewed changes
Comment threaddoc/api/packages.md Outdated
Trott
Trott reviewed Oct 7, 2020
View reviewed changes
Comment threaddoc/api/packages.md Outdated
@MylesBorins

MylesBorins commented Oct 7, 2020

Copy link
Copy Markdown
ContributorAuthor

I'm very confused about the linting error we are getting in CI. I can't reproduce locally and the line number I'm getting from the CI linter doesn't have any links in it (the error is link related)

@GeoffreyBooth

GeoffreyBooth commented Oct 7, 2020

Copy link
Copy Markdown
Member

I’m very confused about the linting error we are getting in CI. I can’t reproduce locally and the line number I’m getting from the CI linter doesn’t have any links in it (the error is link related)

It seems to make sense to me . . . ? It’s erroring on this line:

This field defines [subpath imports][] for the current package.

And it appears we don’t have a subpath imports link, only a subpath exports.

@MylesBorins@guybedford
@aduh95@Trott
doc: move package.import content higher
f1c4999
This is currently at the end of the doc, it likely should be found
right after the documentation about `package.exports`. Refactored the
docs while duplicating content as little as possible.
Co-authored-by: Guy Bedford <guybedford@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Rich Trott <rtrott@gmail.com>
Signed-off-by: Myles Borins <mylesborins@github.com>
MylesBorins added a commit that referenced this pull request Oct 9, 2020
@MylesBorins
doc: move package.import content higher
8d8e06a
This is currently at the end of the doc, it likely should be found
right after the documentation about `package.exports`. Refactored the
docs while duplicating content as little as possible.
Co-authored-by: Guy Bedford <guybedford@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Rich Trott <rtrott@gmail.com>
Signed-off-by: Myles Borins <mylesborins@github.com>
PR-URL: #35535
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@MylesBorins

MylesBorins commented Oct 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Landed in 8d8e06a

MylesBorins added a commit that referenced this pull request Oct 14, 2020
@MylesBorins
doc: move package.import content higher
7d1cdd4
This is currently at the end of the doc, it likely should be found
right after the documentation about `package.exports`. Refactored the
docs while duplicating content as little as possible.
Co-authored-by: Guy Bedford <guybedford@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Rich Trott <rtrott@gmail.com>
Signed-off-by: Myles Borins <mylesborins@github.com>
PR-URL: #35535
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@MylesBorinsMylesBorins mentioned this pull request Oct 14, 2020
Merged
MylesBorins added a commit that referenced this pull request Nov 3, 2020
@MylesBorins
doc: move package.import content higher
4697ad1
This is currently at the end of the doc, it likely should be found
right after the documentation about `package.exports`. Refactored the
docs while duplicating content as little as possible.
Co-authored-by: Guy Bedford <guybedford@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Rich Trott <rtrott@gmail.com>
Signed-off-by: Myles Borins <mylesborins@github.com>
PR-URL: #35535
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@MylesBorinsMylesBorins mentioned this pull request Nov 3, 2020
Merged
MylesBorins added a commit that referenced this pull request Nov 4, 2020
@MylesBorins
doc: move package.import content higher
7eacac4
This is currently at the end of the doc, it likely should be found
right after the documentation about `package.exports`. Refactored the
docs while duplicating content as little as possible.
Co-authored-by: Guy Bedford <guybedford@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Rich Trott <rtrott@gmail.com>
Signed-off-by: Myles Borins <mylesborins@github.com>
PR-URL: #35535
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
MylesBorins added a commit that referenced this pull request Nov 16, 2020
@MylesBorins
doc: move package.import content higher
1cd1d01
This is currently at the end of the doc, it likely should be found
right after the documentation about `package.exports`. Refactored the
docs while duplicating content as little as possible.
Co-authored-by: Guy Bedford <guybedford@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Rich Trott <rtrott@gmail.com>
Signed-off-by: Myles Borins <mylesborins@github.com>
PR-URL: #35535
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
@MylesBorins@joesepi
doc: move package.import content higher
fd63d03
This is currently at the end of the doc, it likely should be found
right after the documentation about `package.exports`. Refactored the
docs while duplicating content as little as possible.
Co-authored-by: Guy Bedford <guybedford@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Rich Trott <rtrott@gmail.com>
Signed-off-by: Myles Borins <mylesborins@github.com>
PR-URL: nodejs#35535
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aduh95aduh95aduh95 left review comments
@mcollinamcollinamcollina approved these changes
@guybedfordguybedfordguybedford approved these changes
@TrottTrottTrott approved these changes
@benjamingrbenjamingrbenjamingr approved these changes
+1 more reviewer
@ryzokukenryzokukenryzokuken approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@MylesBorins@nodejs-github-bot@GeoffreyBooth@mcollina@guybedford@Trott@benjamingr@ryzokuken@aduh95