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
const pkgDir = require('pkg-dir');

(async () => {
	const rootDir = await pkgDir(__dirname);

	console.log(rootDir);
	//=> '/Users/sindresorhus/foo'
})();

API

pkgDir(cwd?)

Returns a Promise for either the project root path or undefined if it couldn't be found.

pkgDir.sync(cwd?)

Returns the project root path or undefined if it couldn't be found.

cwd

Type: string
Default: process.cwd()

Directory to start 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

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.}

Current Tags

7.0.0 ... latest (3 years ago)

7 Versions

7.0.0 ... 3 years ago
6.0.1 ... 4 years ago
5.0.0 ... 5 years ago
1.0.0 ... 10 years ago
4.2.0 ... 6 years ago
2.0.0 ... 8 years ago
3.0.0 ... 7 years ago