sindresorhus/ pkg-dir
Need help with pkg-dir?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
About the developer
167 Stars 
21 Forks 
MIT License 
32 Commits 
1 Opened issues 
Description
Find the root directory of a Node.js project or npm package
Services available
Contributors list
Readme
pkg-dir
Find the root directory of a Node.js project or npm package
Install
npm install pkg-dir
Usage
/
└── Users
└── sindresorhus
└── foo
├── package.json
└── bar
├── baz
└── example.js
// example.js
import {packageDirectory} from 'pkg-dir';
console.log(await packageDirectory());
//=> '/Users/sindresorhus/foo'
API
packageDirectory(option?)
Returns a
Promisefor either the project root path or
undefinedif it could not be found.
packageDirectorySync(options?)
Returns the project root path or
undefinedif it could not be found.
options
Type:
object
cwd
Type:
string\ Default:
process.cwd()
The directory to start searching from.
Related
- pkg-dir-cli - CLI for this module
- pkg-up - Find the closest package.json file
- find-up - Find a file by walking up parent directories
Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.