pkg-dir

What is pkg-dir?

The pkg-dir npm package is designed to help developers find the root directory of a Node.js project or npm package. This is particularly useful in situations where your code needs to access project-wide resources or configurations, and you need a reliable way to locate the root directory of the project, regardless of the current working directory of the process.

What are pkg-dir's main functionalities?

Find the root directory of a project

This feature allows you to asynchronously find the root directory of a project by passing the current directory to the function. It returns a promise that resolves with the path to the nearest package directory.

const pkgDir = require('pkg-dir');

(async () => {
  const rootDir = await pkgDir(__dirname);
  console.log(rootDir);
})();

Synchronous finding of the project root directory

For scenarios where asynchronous code is not ideal, pkg-dir provides a synchronous method to find the project root directory. This method is useful in synchronous scripts or module initialization.

const pkgDir = require('pkg-dir');

const rootDir = pkgDir.sync(__dirname);
console.log(rootDir);

Other packages similar to pkg-dir

find-root

find-root is a package with a similar purpose to pkg-dir, aiming to find the root directory of a Node.js project by looking for a 'package.json' file. Compared to pkg-dir, find-root only offers a synchronous API and does not provide an asynchronous method.

app-root-path

app-root-path provides functionality to determine the root path of the current Node.js application. Unlike pkg-dir, which is focused on finding the nearest package directory, app-root-path is designed to find the application's root directory. It offers both synchronous and asynchronous methods, but its approach and use cases can be slightly different, focusing more on application root rather than package root.

README

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.

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