Sha256: fbfb744957096694db3f8cd8fdb57667b4bbb5701de4a4bb358387847fb250b2
Contents?: true
Size: 1.2 KB
Versions: 52
Compression:
Stored size: 1.2 KB
Contents
# pkg-dir [](https://travis-ci.org/sindresorhus/pkg-dir)
> 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
```
```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`<br>
Default: `process.cwd()`
Directory to start from.
## Related
- [pkg-dir-cli](https://github.com/sindresorhus/pkg-dir-cli) - CLI for this module
- [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
Version data entries
52 entries across 52 versions & 6 rubygems