\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","engines":{"node":">=10.13"},"funding":"https://opencollective.com/pnpm","license":"MIT","scripts":{"lint":"tslint -c ../../tslint.json src/**/*.ts test/**/*.ts","test":"pnpm run compile && pnpm run _test","_test":"cross-env PNPM_REGISTRY_MOCK_PORT=4873 pnpm run test:e2e","start":"pnpm run tsc -- --watch","commit":"commit","?commit":"echo 'Run Git commit wizard'","compile":"rimraf lib tsconfig.tsbuildinfo && tsc --build","test:e2e":"registry-mock prepare && run-p -r registry-mock test:tap","test:tap":"cd ../.. && c8 --reporter lcov --reports-dir packages/supi/coverage ts-node packages/supi/test --type-check","commitmsg":"commitlint -e","registry-mock":"registry-mock","prepublishOnly":"pnpm run compile","test-with-preview":"preview && pnpm run test:e2e"},"typings":"lib/index.d.ts","_npmUser":{"name":"zkochan","email":"z@kochan.io"},"homepage":"https://github.com/pnpm/pnpm/blob/master/packages/supi#readme","keywords":["dependency manager","install","installer","uninstall","remove","link","prune","shrinkwrap","lockfile","fast","rapid","efficient","package.json","packages","dependencies","symlinks","hardlinks","modules","npm","package manager"],"deprecated":"This package was renamed to @pnpm/core","repository":{"url":"https://github.com/pnpm/pnpm/blob/master/packages/supi","type":"git"},"_npmVersion":"6.14.4","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.14.1","dependencies":{"mz":"2.7.0","ramda":"0.27.0","semver":"^7.3.2","p-every":"2.0.0","p-limit":"2.3.0","p-filter":"2.1.0","is-subdir":"1.1.1","run-groups":"2.0.3","@pnpm/error":"1.2.0","@pnpm/hoist":"2.2.3","@pnpm/types":"5.0.0","common-tags":"1.8.0","graceful-fs":"4.2.1","import-from":"3.0.0","semver-utils":"1.1.4","@pnpm/matcher":"1.0.2","is-inner-link":"2.0.2","path-absolute":"1.0.1","@pnpm/headless":"12.2.2","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.2.0","@pnpm/link-bins":"5.3.2","@zkochan/rimraf":"1.0.0","dependency-path":"4.0.6","encode-registry":"2.0.2","graph-sequencer":"2.0.0","@pnpm/get-context":"1.2.1","@pnpm/core-loggers":"4.0.1","@pnpm/modules-yaml":"6.0.2","@pnpm/build-modules":"4.1.14","@pnpm/check-package":"3.0.1","@pnpm/lockfile-file":"3.0.8","@pnpm/resolver-base":"7.0.0","get-npm-tarball-url":"2.0.1","@pnpm/lockfile-utils":"2.0.11","@pnpm/manifest-utils":"1.0.0","@pnpm/prune-lockfile":"2.0.7","@pnpm/filter-lockfile":"3.2.2","@pnpm/lockfile-walker":"2.0.2","@pnpm/modules-cleaner":"8.0.16","version-selector-type":"2.0.1","@pnpm/read-modules-dir":"2.0.1","@pnpm/package-requester":"11.0.6","@pnpm/pkgid-to-filename":"2.0.0","@pnpm/read-package-json":"3.1.0","@pnpm/symlink-dependency":"3.0.4","@zkochan/npm-package-arg":"1.0.2","@pnpm/normalize-registries":"1.0.0","@pnpm/resolve-dependencies":"14.4.4","@pnpm/read-project-manifest":"1.0.5","@pnpm/store-controller-types":"7.0.0","@pnpm/parse-wanted-dependency":"1.0.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ncp":"2.0.0","supi":"link:","execa":"4.0.0","is-ci":"2.0.0","sinon":"9.0.2","fs-extra":"9.0.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.2","exists-link":"2.0.0","npm-run-all":"4.1.5","path-exists":"4.0.0","symlink-dir":"^4.0.1","@pnpm/logger":"3.2.2","@types/is-ci":"2.0.0","@types/ramda":"^0.27.4","@types/sinon":"^9.0.0","tape-promise":"4.0.0","@pnpm/prepare":"0.0.1","@types/mkdirp":"1.0.0","@types/semver":"^7.1.0","read-yaml-file":"2.0.0","@types/fs-extra":"^8.1.0","write-json-file":"4.0.0","write-yaml-file":"^4.1.0","@pnpm/store-path":"^3.0.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":"8.1.0","@pnpm/test-fixtures":"0.0.0","@types/tape-promise":"4.0.0","resolve-link-target":"1.0.1","@pnpm/assert-project":"2.0.1","@pnpm/default-fetcher":"5.1.18","@types/normalize-path":"3.0.0","dir-is-case-sensitive":"1.0.2","@pnpm/default-resolver":"7.4.9","anonymous-npm-registry-client":"0.1.2"},"peerDependencies":{"@pnpm/logger":"^3.1.0"},"_npmOperationalInternal":{"tmp":"tmp/supi_0.38.30_1588413386722_0.5643242865239204","host":"s3://npm-registry-packages"},"_id":"supi@0.38.30","version":"0.38.30"}
![\"supi](\"https://cdn.rawgit.com/pnpm/supi/master/logo.svg\"){kind=logo}
\n