# find-pkg
> Find the first directory with a package.json, recursing up, starting with the given directory. Similar to look-up but does not support globs and only searches for package.json. Async and sync.
Latest version **2.0.0** (published 2018-03-28) · MIT license · 0 weekly downloads
> **Better alternative:** See documentation for alternatives (https://github.com/AikidoSec/module-replacements/blob/main/docs/find-pkg)
## Install
```sh
npm install find-pkg
pnpm add find-pkg
yarn add find-pkg
bun add find-pkg
```
## Health
**Score 23/100 (F)** — status: abandoned.
Positive: has types package; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.0 |
| Published | 2018-03-28 |
| First published | 2015-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/find-pkg) |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | filepath, find, findup, findup-sync, json, lookup, package, package-json, pkg, resolve, sync |
## Links
- npm: https://www.npmjs.com/package/find-pkg
- Repository: https://github.com/jonschlinkert/find-pkg
- Issues: https://github.com/jonschlinkert/find-pkg/issues
- npm.io page: https://npm.io/package/find-pkg
## Dependencies (1)
- [find-file-up](https://npm.io/package/find-file-up.md) ^2.0.1
## Alternatives
- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads
## Recent versions
- 2.0.0 (latest) — 2018-03-28
- 1.0.0 — 2017-05-20
- 0.1.2 — 2016-06-05
- 0.1.1 — 2015-12-20
- 0.1.0 — 2015-11-28
## README
# find-pkg [](https://www.npmjs.com/package/find-pkg) [](https://npmjs.org/package/find-pkg) [](https://npmjs.org/package/find-pkg) [](https://travis-ci.org/jonschlinkert/find-pkg)
> Find the first directory with a package.json, recursing up, starting with the given directory. Similar to look-up but does not support globs and only searches for package.json. Async and sync.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save find-pkg
```
## Usage
```js
const findPkg = require('find-pkg');
```
**promise**
```js
findPkg('a/b/c/some/path')
.then(file => console.log(file)) //=> /User/jonschlinkert/dev/a/b/package.json
.catch(console.error);
```
**async-await**
```js
(async function() {
const file = await findPkg('a/b/c/some/path');
console.log(file);
//=> '/Users/jonschlinkert/dev/a/b/package.json'
})();
```
**callback**
```js
findPkg('a/b/c/some/path', function(err, file) {
if (err) throw err;
console.log(file);
//=> '/Users/jonschlinkert/dev/a/b/package.json'
});
```
**sync**
```js
const file = findPkg.sync('a/b/c/some/path');
//=> '/Users/jonschlinkert/dev/a/b/package.json'
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [find-file-up](https://www.npmjs.com/package/find-file-up): Find a file fast, by starting at the given cwd and recursing up one directory… [more](https://github.com/jonschlinkert/find-file-up) | [homepage](https://github.com/jonschlinkert/find-file-up "Find a file fast, by starting at the given cwd and recursing up one directory until the file is found or we run out of directories.")
* [findup-sync](https://www.npmjs.com/package/findup-sync): Find the first file matching a given pattern in the current directory or the nearest… [more](https://github.com/js-cli/node-findup-sync#readme) | [homepage](https://github.com/js-cli/node-findup-sync#readme "Find the first file matching a given pattern in the current directory or the nearest ancestor directory.")
* [global-modules](https://www.npmjs.com/package/global-modules): The directory used by npm for globally installed npm modules. | [homepage](https://github.com/jonschlinkert/global-modules "The directory used by npm for globally installed npm modules.")
### Author
**Jon Schlinkert**
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 28, 2018._
---
_Source: https://npm.io/package/find-pkg · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._