![]() |
||
---|---|---|
.. | ||
index.js | ||
license | ||
package.json | ||
readme.md |
readme.md
pkg-dir ![Build Status](https://travis-ci.org/sindresorhus/pkg-dir.svg?branch=master)
Find the root directory of a Node.js project or npm package
Install
$ npm install --save pkg-dir
Usage
/
└── Users
└── sindresorhus
└── foo
├── package.json
└── bar
├── baz
└── example.js
// example.js
const pkgDir = require('pkg-dir');
pkgDir(__dirname).then(rootDir => {
console.log(rootDir);
//=> '/Users/sindresorhus/foo'
});
API
pkgDir([cwd])
Returns a Promise
for either the project root path or null
if it couldn't be found.
pkgDir.sync([cwd])
Returns the project root path or null
.
cwd
Type: string
Default: process.cwd()
Directory to start 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
License
MIT © Sindre Sorhus