feat(unstable): support using a local copy of npm packages #28512
+1,011
−180
Conversation
This file contains 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
dsherret
commented
Mar 20, 2025
| @@ -236,6 +237,54 @@ impl CliLockfile { | |||
| )) | |||
| }) | |||
| .collect(), | |||
| patches: if workspace.has_unstable("npm-patch") { | |||
There was a problem hiding this comment.
This requires putting this in the deno.json. I think that's fine because the patch feature needs to be in a deno.json and I think it's not worth it to support --unstable-npm-patch because this is only going to exist for a few weeks.
dsherret
commented
Mar 20, 2025
| .filter(|f| !from_config_file.contains(f)), | ||
| ) | ||
| .map(|f| f.to_owned()) | ||
| .collect::<Vec<_>>(); |
There was a problem hiding this comment.
Unrelated cleanup because I had trouble reading this code ("from_config_file")...
ry
pushed a commit
that referenced
this pull request
Mar 21, 2025
This adds support for using a local copy of an npm package.
```js
// deno.json
{
"patch": [
"../path/to/local_npm_package"
],
// required until Deno 2.3, but it will still be considered unstable
"unstable": ["npm-patch"]
}
```
1. Requires using a node_modules folder.
2. When using `"nodeModulesDir": "auto"`, it recreates the folder in the
node_modules directory on each run which will slightly increase startup
time.
3. When using the default with a package.json (`"nodeModulesDir":
"manual"`), updating the package requires running `deno install`. This
is to get the package into the node_modules directory of the current
workspace. This is necessary instead of linking because packages can
have multiple "copy packages" due to peer dep resolution.
Caveat: Specifying a local copy of an npm package or making changes to
its dependencies will purge npm packages from the lockfile. This might
cause npm resolution to resolve differently and it may end up not using
the local copy of the npm package. It's very difficult to only
invalidate resolution midway through the graph and then only rebuild
that part of the resolution, so this is just a first pass that can be
improved in the future. In practice, this probably won't be an issue for
most people.
Another limitation is this also requires the npm package name to exist
in the registry at the moment.
15 tasks
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 adds support for using a local copy of an npm package.
"nodeModulesDir": "auto", it recreates the folder in the node_modules directory on each run which will slightly increase startup time."nodeModulesDir": "manual"), updating the package requires runningdeno install. This is to get the package into the node_modules directory of the current workspace. This is necessary instead of linking because packages can have multiple "copy packages" due to peer dep resolution.Caveat: Specifying a local copy of an npm package or making changes to its dependencies will purge npm packages from the lockfile. This might cause npm resolution to resolve differently and it may end up not using the local copy of the npm package. It's very difficult to only invalidate resolution midway through the graph and then only rebuild that part of the resolution, so this is just a first pass that can be improved in the future. In practice, this probably won't be an issue for most people.
Another limitation is this also requires the npm package name to exist in the registry at the moment.
Closes #27854
Closes #19621
Closes #15624