pkg-dir

by sindresorhus

sindresorhus / pkg-dir

Find the root directory of a Node.js project or npm package

132 Stars 14 Forks Last release: over 1 year ago (v4.2.0) MIT License 23 Commits 6 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

pkg-dir Build Status

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.

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

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.