Get installation path where the given package is installed. Works for globally and locally installed packages
You might also be interested in detect-installed.
If you have any how-to kind of questions, please read Code of Conduct and join the chat room or open an issue.
You may also read the Contributing Guide. There, beside "How to contribute?", we describe everything stated by the badges.
(TOC generated by verb using markdown-toc)
This project requires Node.js v6 and above. Use yarn v1 / npm v5 or above to install it.
$ yarn add get-installed-path
Review carefully the provided examples and the working tests.
Get installed path of globally or locally
namepackage. By default it checks ifnameexists as directory in global-modules directory of the system. Passopts.localto get path ofnamepackage from local directory or fromopts.cwd. Returns rejected promise if module not found in global/localnode_modulesfolder or if it exist but is not a directory.
Params
name{string}: package nameopts{Object}: passopts.localto check locallyreturns{Promise}: rejected promise ifnamenot a string or is empty string
Example
const { getInstalledPath } = require('get-installed-path')
getInstalledPath('npm').then((path) => {
console.log(path)
// => '/home/charlike/.nvm/path/to/lib/node_modules/npm'
})
getInstalledPath('foo-bar-barwerwlekrjw').catch((err) => {
console.log(err.message)
// => 'module not found "foo-bar-barwerwlekrjw" in path ...'
})
getInstalledPath('npm', {
local: true
}).catch((err) => {
console.log(err.message)
// => 'module not found "foo-bar-barwerwlekrjw" in path ...'
})
getInstalledPath('global-modules', {
local: true
}).then((path) => {
console.log(path)
// => '~/code/get-installed-path/node_modules/global-modules'
})
// If you are using it for some sub-directory
// pass `opts.cwd` to be where the `node_modules`
// folder is.
process.chidr('foo-bar-baz')
getInstalledPath('global-modules', {
local: true,
cwd: '../'
}).then((path) => {
console.log(path)
// => '~/code/get-installed-path/node_modules/global-modules'
})
// When searching for the path of a package that is required
// by several other packages, its path may not be in the
// closest node_modules. In this case, to search recursively,
// you can use the following:
getInstalledPath('npm', {
paths: process.mainModule.paths
}).then((path) => {
// ...
})
// `process.mainModule` refers to the location of the current
// entry script.Get installed path of a
namepackage synchronous. Returnsbooleanwhenpathsoption is used and filepath is directory, otherwise returns a full filepath OR throws error.
Params
name{string}: package nameopts{Object}: passopts.localto check locallyreturns{string}: The full filepath or throwTypeErrorifnamenot a string or is empty string
Example
const { getInstalledPathSync } = require('get-installed-path')
const npmPath = getInstalledPathSync('npm')
console.log(npmPath)
// => '/home/charlike/.nvm/path/to/lib/node_modules/npm'
const gmPath = getInstalledPathSync('global-modules', { local: true })
console.log(gmPath)
// => '~/code/get-installed-path/node_modules/global-modules'- always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child… more | homepage
- detect-installed: Checks that given package is installed globally or locally. | homepage
- global-modules: The directory used by npm for globally installed npm modules. | homepage
- global-paths: Returns an array of unique "global" directories based on the user's platform… more | [homepage](https://github.com/jonschlinkert/global-paths "Returns an array of unique "global" directories based on the user's platform and environment. The resulting paths can be used for doing lookups for generators or other globally installed npm packages. Node.js / JavaScript.")
- global-prefix: Get the npm global path prefix. | homepage
- is-installed: Checks that given package is installed locally or globally. Useful for robust… more | homepage
- minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins… more | homepage
- try-catch-core: Low-level package to handle completion and errors of sync or asynchronous functions… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the Contributing Guide and Code of Conduct documents for advices.
Copyright © 2016-2017, Charlike Mike Reagent. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on October 12, 2017.
Project scaffolded and managed with hela.
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent