History

jkjoy 9a9cb42f53 20231003 update		2023-10-03 11:14:36 +08:00
..
index.d.ts	20231003 update	2023-10-03 11:14:36 +08:00
index.js	20231003 update	2023-10-03 11:14:36 +08:00
license	20231003 update	2023-10-03 11:14:36 +08:00
package.json	20231003 update	2023-10-03 11:14:36 +08:00
readme.md	20231003 update	2023-10-03 11:14:36 +08:00

readme.md

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.

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