module: package imports targets outside package #52641
Open
Conversation
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
|
Review requested:
|
nodejs-github-bot
added
esm
| @@ -485,7 +485,7 @@ where `import '#dep'` does not get the resolution of the external package | |||
| file `./dep-polyfill.js` relative to the package in other environments. | |||
|
|
|||
| Unlike the `"exports"` field, the `"imports"` field permits mapping to external | |||
| packages. | |||
| packages and locations. | |||
There was a problem hiding this comment.
Does https://nodejs.org/api/esm.html#resolution-algorithm-specification need to be updated as well?
lib/internal/modules/esm/resolve.js
Outdated
| @@ -414,7 +416,8 @@ function resolvePackageTargetString( | |||
| const resolvedPath = resolved.pathname; | |||
| const packagePath = new URL('.', packageJSONUrl).pathname; | |||
|
|
|||
| if (!StringPrototypeStartsWith(resolvedPath, packagePath)) { | |||
| // if (mustBeInternalTarget && !StringPrototypeStartsWith(resolvedPath, packagePath)) { | |||
There was a problem hiding this comment.
Unsure why this is here.
Suggested change
| // if (mustBeInternalTarget && !StringPrototypeStartsWith(resolvedPath, packagePath)) { |
lib/internal/modules/esm/resolve.js
Outdated
| @@ -465,14 +468,15 @@ function isArrayIndex(key) { | |||
| * @param {boolean} internal - Whether the package is internal. | |||
| * @param {boolean} isPathMap - Whether the package is a path map. | |||
| * @param {Set<string>} conditions - The conditions to match. | |||
| * @param {boolean} mustBeInternalTarget - If the target must be in the package boundary. | |||
There was a problem hiding this comment.
This might be a bit much for a JSDoc comment, but is it possible to briefly explain when we would want this restriction? Is it like If the target must be in the package scope: yes for "exports", no for "imports"?
mcollina
reviewed
Apr 24, 2024
There was a problem hiding this comment.
@RafaelGSS does this needs to do anything specific for permissions?
jasnell
reviewed
Apr 27, 2024
this allows the imports field of package.json to target a location outside of the package boundary. doing so allows for imports to work in directories just altering things like the type field of package.json and to enable monorepo workspace workflows.
bmeck
force-pushed
the
unlock-external-package-imports
branch
from
7def52e to
a2eed40
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
this allows the imports field of package.json to target a location outside of the package boundary. doing so allows for imports to work in directories just altering things like the type field of package.json and to enable monorepo workspace workflows.
Node already allows resolving to external packages for
"imports"; this fixes some usability problems of mixing monorepos and directories containing a{"type":"module"}(or vice versa)package.jsonpreventing the ability to properly use"imports"to resolve to reasonable locations. It does not enable..in a specifiers to escape still per the tests it must be in the target of thepackage.jsonto allow escaping.An example of a case where this feature is high friction is:
Note: this still requires duplication of imports for this use case with this PR.
Another example is in a monorepo situation: