Need help with pkg-dir?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sindresorhus
145 Stars 17 Forks MIT License 27 Commits 1 Opened issues

Description

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

Services available

!
?

Need anything else?

Contributors list

# 207
node
exec
test-fr...
nextjs
18 commits
# 32,357
webfram...
exec
Babel
test-fr...
2 commits
# 7,468
TypeScr...
typescr...
iterm2
Node.js
2 commits
# 7,315
TypeScr...
Visual ...
vscode
stringi...
1 commit
# 7,399
ESLint
commiti...
semanti...
exec
1 commit
# 34,479
JavaScr...
TypeScr...
lodash
html-we...
1 commit
# 6,447
chalk
Svelte
example...
Ada
1 commit

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.

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.