Popularity
2.4
Growing
Activity
0.0
Stable
136
8
14

Monthly Downloads: 0
Programming language: JavaScript
License: MIT License
Tags: JSON     Search     Filesystem     Path     Match     NPM     File     Find     Package     Directory     Folder     Dir     Root     Walk     Walking     Parents     Parent     Resolve     Look     Look-up     Findup     Find-up     Up     Entry    
Latest version: v5.0.0

pkg-dir alternatives and similar modules

Based on the "Filesystem" category

Do you think we are missing an alternative of pkg-dir or a related project?

Add another 'Filesystem' Module

README

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.

  • 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 companiesassurances about security, maintenance, and licensing for their dependencies.