pkg-up

Find the closest package.json file


Keywords
pkg, package, file, find, up, find-up, findup, look-up, look, search, match, resolve, parent, parents, folder, directory, walk, walking, path
License
MIT
Install
npm install pkg-up@3.1.0

Documentation

package-up

Find the closest package.json file

Install

npm install package-up

Usage

/
└── Users
    └── sindresorhus
        └── foo
            ├── package.json
            └── bar
                ├── baz
                └── example.js
// example.js
import {packageUp} from 'package-up';

console.log(await packageUp());
//=> '/Users/sindresorhus/foo/package.json'

API

packageUp(options?)

Returns a Promise<string> for the file path, or Promise<undefined> if it could not be found.

packageUpSync(options?)

Returns the file path, or undefined if it could not be found.

options

Type: object

cwd

Type: string
Default: process.cwd()

The directory to start from.

  • read-pkg-up - Read the closest package.json file
  • pkg-dir - Find the root directory of an npm package
  • find-up - Find a file by walking up parent directories