\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```\nnpm install supi\n```\n\nIt also depends on `@pnpm/logger` version `1`, so install it as well via:\n\n```\nnpm install @pnpm/logger@1\n```\n\n## API\n\n### `supi.mutateModules(importers, options)`\n\nTODO\n\n### `supi.uninstall(pkgsToUninstall, [options])`\n\nUninstalls a package, completely removing everything pnpm installed on its behalf.\n\n**Arguments:**\n\n* `pkgsToUninstall` - *String[]* - the package names to be uninstalled.\n* `options.saveProd` - *Boolean* - the package will be removed from `dependencies`.\n* `options.saveDev` - *Boolean* - the package will be removed from `devDependencies`.\n* `options.saveOptional` - *Boolean* - the package will be removed from `optionalDependencies`.\n* `options.global` - *Boolean* - the packages will be uninstalled globally.\n* `options.reporter` - *Function* - A function that listens for logs.\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* `globalPrefix` - *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* `globalPrefix` - *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(shr: Shrinkwrap): Shrinkwrap`\n\nThis hook is called after all dependencies are resolved. It recieves and returns the resolved shrinkwrap 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":">=8"},"license":"MIT","scripts":{"tsc":"rimraf lib && tsc","info":"npm-scripts-info","lint":"tslint -c tslint.json src/**/*.ts test/**/*.ts","test":"npm run lint && npm run tsc && npm run test:e2e","start":"npm run tsc -- --watch","commit":"commit","?commit":"echo 'Run Git commit wizard'","pretest":"rimraf ../../../.tmp/ && pnpm-registry-mock prepare","test:e2e":"npm-run-all -p -r pnpm-registry-mock test:tap","test:tap":"ts-node test","commitmsg":"commitlint -e","prepublishOnly":"npm run tsc","test-with-preview":"npm run lint && preview && npm run test:e2e","pnpm-registry-mock":"pnpm-registry-mock"},"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"],"deprecated":"This package was renamed to @pnpm/core","repository":{"url":"https://github.com/pnpm/pnpm/blob/master/packages/supi","type":"git"},"_npmVersion":"6.7.0","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":"10.12.0","dependencies":{"mz":"2.7.0","execa":"1.0.0","is-ci":"2.0.0","ramda":"0.26.1","semver":"5.6.0","p-every":"1.0.2","p-limit":"2.1.0","p-filter":"1.0.0","@types/mz":"0.0.32","@types/rc":"1.1.0","is-subdir":"1.0.2","write-pkg":"3.2.0","@types/npm":"2.0.29","run-groups":"1.0.0","@pnpm/types":"2.0.0","@pnpm/utils":"0.9.1","@types/node":"10.12.21","@types/nopt":"3.0.29","common-tags":"1.8.0","graceful-fs":"4.1.15","import-from":"2.1.0","rimraf-then":"1.0.1","symlink-dir":"2.0.2","@types/ramda":"0.25.34","@types/byline":"4.2.31","@types/semver":"5.5.0","is-inner-link":"2.0.2","path-absolute":"1.0.1","@pnpm/headless":"6.0.0-1","@types/p-every":"1.0.0","load-json-file":"5.1.0","mkdirp-promise":"5.0.1","normalize-path":"3.0.0","replace-string":"2.0.0","util.promisify":"1.0.0","@pnpm/fs-locker":"1.0.3","@pnpm/lifecycle":"4.2.0","@pnpm/link-bins":"3.0.3","@types/p-series":"1.0.1","dependency-path":"3.0.0-0","encode-registry":"1.1.0","graph-sequencer":"2.0.0","@pnpm/core-loggers":"2.0.0","@pnpm/modules-yaml":"2.0.1","@types/common-tags":"1.8.0","@pnpm/check-package":"2.0.0","@pnpm/resolver-base":"2.1.0","get-npm-tarball-url":"2.0.1","resolve-link-target":"1.0.1","@pnpm/read-manifests":"2.0.0-0","@pnpm/modules-cleaner":"3.0.0-0","@pnpm/shrinkwrap-file":"2.0.0-1","version-selector-type":"2.0.0","@pnpm/prune-shrinkwrap":"2.0.0-0","@pnpm/read-modules-dir":"1.0.0","@pnpm/shrinkwrap-utils":"2.0.0-0","normalize-registry-url":"1.0.0","@pnpm/filter-shrinkwrap":"2.0.0-0","@pnpm/package-requester":"6.1.0","@pnpm/pkgid-to-filename":"2.0.0","@pnpm/read-package-json":"1.1.1","@pnpm/shamefully-flatten":"3.0.0-0","@pnpm/symlink-dependency":"1.1.3","@zkochan/npm-package-arg":"1.0.1","validate-npm-package-name":"3.0.0","@pnpm/resolve-dependencies":"5.0.0-1","@pnpm/store-controller-types":"2.1.0","remove-all-except-outer-links":"1.0.3"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"caw":"2.0.1","ncp":"2.0.0","supi":"link:","tape":"4.9.2","sepia":"2.0.2","sinon":"7.2.3","mkdirp":"0.5.1","rimraf":"2.6.3","tslint":"5.12.1","ts-node":"6.2.0","fs-extra":"7.0.1","read-pkg":"4.0.1","path-name":"1.0.0","is-windows":"1.0.2","typescript":"3.3.1","@types/tape":"4.2.33","cross-spawn":"6.0.5","exists-link":"2.0.0","npm-run-all":"4.1.5","path-exists":"3.0.0","@pnpm/logger":"2.1.0","@types/sinon":"7.0.5","tape-promise":"4.0.0","@pnpm/prepare":"0.0.0","@types/mkdirp":"0.5.2","read-yaml-file":"1.1.0","@types/fs-extra":"5.0.4","write-json-file":"3.0.2","write-yaml-file":"2.0.0","@pnpm/store-path":"1.0.4","deep-require-cwd":"1.0.0","npm-scripts-info":"0.3.9","@types/is-windows":"0.2.0","@pnpm/assert-store":"link:../../privatePackages/assert-store","pnpm-registry-mock":"2.6.0","@pnpm/package-store":"3.1.0","@pnpm/tslint-config":"0.0.0","@pnpm/assert-project":"link:../../privatePackages/assert-project","@pnpm/default-fetcher":"3.0.0-0","@pnpm/default-resolver":"3.0.0-0","anonymous-npm-registry-client":"0.1.2"},"peerDependencies":{"@pnpm/logger":"^2.1.0"},"_npmOperationalInternal":{"tmp":"tmp/supi_0.30.0-2_1549199200257_0.1074910455132918","host":"s3://npm-registry-packages"},"_id":"supi@0.30.0-2","version":"0.30.0-2"}
![\"supi](\"https://cdn.rawgit.com/pnpm/supi/master/logo.svg\"){kind=logo}
\n