9a2393f67e
* feat: enable injected local packages to work with global virtual store by leveraging `pkgLocationsByDepPath` for `file:` dependencies. * fix: populate `pkgLocationsByDepPath` directly for directory dependencies in the graph builder * refactor: store directory dependencies as a Map instead of an object * refactor: improve file: dependency target directory resolution by prioritizing `directoryDepsByDepPath` and providing a lockfile fallback. * refactor: remove `pkgLocationsByDepPath` from hoisted dependency graph generation parameters * test: fix * test: fix * refactor: simplify directory lookup for injected workspace packages by directly using the dependency graph * refactor: move extendProjectsWithTargetDirs to headless module and update imports * refactor: make `directoryDepsByDepPath` required in `LockfileToDepGraphOptions` and remove its nullish coalescing in headless * refactor: directory dependency tracking by renaming `directoryDepsByDepPath` to `injectionTargetsByDepPath` and extracting related logic, and remove an unused export. * docs: add changesets * fix: implemented CR suggestions
@pnpm/core
Fast, disk space efficient installation engine. Used by pnpm
Install
Install it via npm.
pnpm add @pnpm/core
It also depends on @pnpm/logger version 1, so install it as well via:
pnpm add @pnpm/logger@1
API
mutateModules(importers, options)
TODO
link(linkFromPkgs, linkToModules, [options])
Create symbolic links from the linked packages to the target package's node_modules (and its node_modules/.bin).
Arguments:
linkFromPkgs- String[] - paths to the packages that should be linked.linkToModules- String - path to the dependent package'snode_modulesdirectory.options.reporter- Function - A function that listens for logs.
linkToGlobal(linkFrom, options)
Create a symbolic link from the specified package to the global node_modules.
Arguments:
linkFrom- String - path to the package that should be linked.globalDir- String - path to the global directory.options.reporter- Function - A function that listens for logs.
linkFromGlobal(pkgNames, linkTo, options)
Create symbolic links from the global pkgNames to the linkTo/node_modules folder.
Arguments:
pkgNames- String[] - packages to link.linkTo- String - package to link to.globalDir- String - path to the global directory.options.reporter- Function - A function that listens for logs.
storeStatus([options])
Return the list of modified dependencies.
Arguments:
options.reporter- Function - A function that listens for logs.
Returns: Promise<string[]> - the paths to the modified packages of the current project. The paths contain the location of packages in the store,
not in the projects node_modules folder.
storePrune([options])
Remove unreferenced packages from the store.
Hooks
Hooks are functions that can step into the installation process.
readPackage(pkg: Manifest): Manifest | Promise<Manifest>
This hook is called with every dependency's manifest information.
The modified manifest returned by this hook is then used by @pnpm/core during installation.
An async function is supported.
Example:
const { installPkgs } = require('@pnpm/core')
installPkgs({
hooks: {readPackage}
})
function readPackage (pkg) {
if (pkg.name === 'foo') {
pkg.dependencies = {
bar: '^2.0.0',
}
}
return pkg
}
afterAllResolved(lockfile: Lockfile): Lockfile | Promise<Lockfile>
This hook is called after all dependencies are resolved. It receives and returns the resolved lockfile object. An async function is supported.