pkg-up

Find the closest package.json file

Install

$ npm install pkg-up

Usage

/
└── Users
    └── sindresorhus
        └── foo
            ├── package.json
            └── bar
                ├── baz
                └── example.js

// example.js
const pkgUp = require('pkg-up');

(async () => {
	console.log(await pkgUp());
	//=> '/Users/sindresorhus/foo/package.json'
})();

API

pkgUp([options])

Returns a Promise<string> for the filepath, or Promise<null> if it couldn't be found.

pkgUp.sync([options])

Returns the filepath, or null if it couldn't be found.

options

Type: Object

cwd

Type: string
Default: process.cwd()

Directory to start from.

Related

• 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

License

MIT © Sindre Sorhus

Current Tags

• 4.0.0                                ...           latest (4 years ago)

4 Versions

• 4.0.0                                ...           4 years ago
• 3.1.0                                ...           6 years ago
• 1.0.0                                ...           10 years ago
• 2.0.0                                ...           8 years ago