History

Lee Hanken ca3866eae3 added unit tests		2022-12-23 12:03:25 +00:00
..
index.d.ts	added unit tests	2022-12-23 12:03:25 +00:00
index.js	added unit tests	2022-12-23 12:03:25 +00:00
license	added unit tests	2022-12-23 12:03:25 +00:00
package.json	added unit tests	2022-12-23 12:03:25 +00:00
readme.md	added unit tests	2022-12-23 12:03:25 +00:00

readme.md

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