Archived

This repository has been archived on 2020-11-02. You can view files and clone it, but cannot push or open issues or pull requests.

cranberry ed23347e56 Initial comission of TheLounge base files

2020-11-01 22:46:04 +00:00

1.2 KiB

Raw Blame History

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 null if it couldn’t be found.

pkgDir.sync(cwd)

Returns the project root path or null.

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

1.2 KiB Raw Blame History Unescape Escape