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 Promise for either the project root path or undefined if it could not be found.

packageDirectorySync(options?)

Returns the project root path or undefined if it could not be found.

options

Type: object

cwd

Type: string
Default: process.cwd()

The directory to start searching from.

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

Current Tags

8.0.0 ... latest (a year ago)