\n\n# supi\n\n> Fast, disk space efficient installation engine. Used by [pnpm](https://github.com/pnpm/pnpm)\n\n## Install\n\nInstall it via npm.\n\n```\n add supi\n```\n\nIt also depends on `@pnpm/logger` version `1`, so install it as well via:\n\n```\n add @pnpm/logger@1\n```\n\n## API\n\n### `supi.mutateModules(importers, options)`\n\nTODO\n\n### `supi.link(linkFromPkgs, linkToNodeModules, [options])`\n\nCreate symbolic links from the linked packages to the target package's `node_modules` (and its `node_modules/.bin`).\n\n**Arguments:**\n\n* `linkFromPkgs` - *String[]* - paths to the packages that should be linked.\n* `linkToNodeModules` - *String* - path to the dependent package's `node_modules` directory.\n* `options.reporter` - *Function* - A function that listens for logs.\n\n### `supi.linkToGlobal(linkFrom, options)`\n\nCreate a symbolic link from the specified package to the global `node_modules`.\n\n**Arguments:**\n\n* `linkFrom` - *String* - path to the package that should be linked.\n* `globalDir` - *String* - path to the global directory.\n* `options.reporter` - *Function* - A function that listens for logs.\n\n### `supi.linkFromGlobal(pkgNames, linkTo, options)`\n\nCreate symbolic links from the global `pkgName`s to the `linkTo/node_modules` folder.\n\n**Arguments:**\n\n* `pkgNames` - *String[]* - packages to link.\n* `linkTo` - *String* - package to link to.\n* `globalDir` - *String* - path to the global directory.\n* `options.reporter` - *Function* - A function that listens for logs.\n\n### `supi.storeStatus([options])`\n\nReturn the list of modified dependencies.\n\n**Arguments:**\n\n* `options.reporter` - *Function* - A function that listens for logs.\n\n**Returns:** `Promise` - the paths to the modified packages of the current project. The paths contain the location of packages in the store,\nnot in the projects `node_modules` folder.\n\n### `supi.storePrune([options])`\n\nRemove unreferenced packages from the store.\n\n## Hooks\n\nHooks are functions that can step into the installation process.\n\n### `readPackage(pkg)`\n\nThis hook is called with every dependency's manifest information.\nThe modified manifest returned by this hook is then used by supi during installation.\n\n**Example:**\n\n```js\nconst supi = require('supi')\n\nsupi.installPkgs({\n hooks: {readPackage}\n})\n\nfunction readPackage (pkg) {\n if (pkg.name === 'foo') {\n pkg.dependencies = {\n bar: '^2.0.0',\n }\n }\n return pkg\n}\n```\n\n### `afterAllResolved(lockfile: Lockfile): Lockfile`\n\nThis hook is called after all dependencies are resolved. It recieves and returns the resolved lockfile object.\n\n## Acknowledgements\n\nThanks to [Valentina Kozlova](https://github.com/ValentinaKozlova) for the supi logo\n\n## License\n\n[MIT](LICENSE)\n","_shasum":"4208758c608a4cbaa4045eaf9fdd3f551b8f0b1d","engines":{"node":">=10"},"license":"MIT","scripts":{"tsc":"rimraf lib && tsc","lint":"tslint -c tslint.json src/**/*.ts test/**/*.ts","test":"pnpm run lint && pnpm run tsc && pnpm run test:e2e","start":"pnpm run tsc -- --watch","commit":"commit","?commit":"echo 'Run Git commit wizard'","pretest":"registry-mock prepare","test:e2e":"run-p -r registry-mock test:tap","test:tap":"ts-node test","commitmsg":"commitlint -e","registry-mock":"registry-mock","prepublishOnly":"pnpm run tsc","test-with-preview":"pnpm run lint && preview && pnpm run test:e2e"},"typings":"lib/index.d.ts","_npmUser":{"name":"zkochan","email":"z@kochan.io"},"homepage":"https://pnpm.js.org","keywords":["dependency manager","install","installer","uninstall","remove","link","prune","shrinkwrap","lockfile","fast","rapid","efficient","package.json","packages","dependencies","symlinks","hardlinks","modules","npm","package manager"],"_resolved":"file:packages/supi","deprecated":"This package was renamed to @pnpm/core","repository":{"url":"https://github.com/pnpm/pnpm/blob/master/packages/supi","type":"git"},"_npmVersion":"4.6.1","description":"Fast, disk space efficient installation engine","directories":{"test":"test"},"maintainers":[{"name":"etamponi","email":"emanuele.tamponi@gmail.com"},{"name":"zkochan","email":"z@kochan.io"}],"_nodeVersion":"12.11.0","dependencies":{"mz":"2.7.0","is-ci":"2.0.0","ramda":"0.26.1","semver":"7.1.1","p-every":"2.0.0","p-limit":"2.2.1","make-dir":"3.0.0","p-filter":"2.1.0","is-subdir":"1.1.1","run-groups":"2.0.1","@pnpm/error":"1.0.0","@pnpm/hoist":"2.0.4","@pnpm/types":"4.0.0","@pnpm/utils":"0.12.2","common-tags":"1.8.0","graceful-fs":"4.2.1","import-from":"3.0.0","semver-utils":"1.1.4","@pnpm/matcher":"1.0.0","is-inner-link":"2.0.2","path-absolute":"1.0.1","@pnpm/headless":"11.0.3","load-json-file":"6.2.0","normalize-path":"3.0.0","@pnpm/constants":"3.0.0","@pnpm/fs-locker":"3.0.1","@pnpm/lifecycle":"8.0.1","@pnpm/link-bins":"5.0.1","@zkochan/rimraf":"1.0.0","dependency-path":"4.0.2","encode-registry":"2.0.2","graph-sequencer":"2.0.0","@pnpm/core-loggers":"4.0.0","@pnpm/modules-yaml":"5.0.0","@pnpm/build-modules":"4.0.1","@pnpm/check-package":"3.0.1","@pnpm/lockfile-file":"3.0.1","@pnpm/resolver-base":"6.0.0","get-npm-tarball-url":"2.0.1","@pnpm/lockfile-utils":"2.0.5","@pnpm/prune-lockfile":"2.0.3","@pnpm/filter-lockfile":"3.0.4","@pnpm/lockfile-walker":"1.0.1","@pnpm/modules-cleaner":"8.0.2","version-selector-type":"2.0.1","@pnpm/read-modules-dir":"2.0.1","@pnpm/package-requester":"10.0.1","@pnpm/pkgid-to-filename":"2.0.0","@pnpm/read-package-json":"3.0.1","@pnpm/symlink-dependency":"3.0.0","@zkochan/npm-package-arg":"1.0.2","@pnpm/resolve-dependencies":"13.0.2","@pnpm/read-importer-manifest":"2.0.1","@pnpm/read-importers-context":"3.0.5","@pnpm/store-controller-types":"6.0.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ncp":"2.0.0","supi":"link:","tape":"4.11.0","execa":"3.4.0","sinon":"7.5.0","rimraf":"3.0.0","fs-extra":"8.1.0","@types/mz":"^2.7.0","path-name":"1.0.0","@types/ncp":"2.0.3","is-windows":"1.0.2","cross-spawn":"7.0.1","exists-link":"2.0.0","npm-run-all":"4.1.5","path-exists":"4.0.0","symlink-dir":"3.1.1","@pnpm/logger":"3.1.0","@types/is-ci":"2.0.0","@types/ramda":"^0.26.38","@types/sinon":"^7.5.1","tape-promise":"4.0.0","@pnpm/prepare":"0.0.0","@types/mkdirp":"0.5.2","@types/semver":"^6.2.0","read-yaml-file":"1.1.0","@types/fs-extra":"^8.0.1","write-json-file":"4.0.0","write-yaml-file":"3.0.1","@pnpm/store-path":"2.1.1","deep-require-cwd":"1.0.0","@types/is-windows":"^1.0.0","@pnpm/assert-store":"1.0.0","@types/common-tags":"1.8.0","@types/graceful-fs":"4.1.3","@pnpm/package-store":"7.0.2","resolve-link-target":"1.0.1","@pnpm/assert-project":"2.0.0","@pnpm/default-fetcher":"5.1.6","@types/normalize-path":"3.0.0","dir-is-case-sensitive":"1.0.2","@pnpm/default-resolver":"6.0.2","anonymous-npm-registry-client":"0.1.2"},"peerDependencies":{"@pnpm/logger":"^3.1.0"},"_npmOperationalInternal":{"tmp":"tmp/supi_0.37.5_1576632479336_0.9607244269818991","host":"s3://npm-registry-packages"},"_id":"supi@0.37.5","version":"0.37.5"}
![\"supi](\"https://cdn.rawgit.com/pnpm/supi/master/logo.svg\"){kind=logo}
\n