https://github.com/sindresorhus/pkg-up

Find the closest package.json file
https://github.com/sindresorhus/pkg-up

Last synced: 11 days ago
JSON representation

Find the closest package.json file

• Host: GitHub
• URL: https://github.com/sindresorhus/pkg-up
• Owner: sindresorhus
• License: mit
• Created: 2015-09-21T09:55:42.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2023-11-04T10:01:56.000Z (about 1 year ago)
• Last Synced: 2024-12-07T15:04:36.567Z (14 days ago)
• Language: JavaScript
• Size: 17.6 KB
• Stars: 159
• Watchers: 10
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-github-star - pkg-up

README

        
# package-up

> Find the closest package.json file

## Install

```sh

npm install package-up

```

## Usage

```

/

└── Users

    └── sindresorhus

        └── foo

            ├── package.json

            └── bar

                ├── baz

                └── example.js

```

```js

// example.js

import {packageUp} from 'package-up';

console.log(await packageUp());

//=> '/Users/sindresorhus/foo/package.json'

```

## API

### packageUp(options?)

Returns a `Promise` for the file path, or `Promise` 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.

## Related

- [read-package-up](https://github.com/sindresorhus/read-package-up) - Read the closest package.json file

- [pkg-dir](https://github.com/sindresorhus/pkg-dir) - Find the root directory of an npm package

- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories