# find-package-json

> Find package.json files in parent directories, keep finding until you find the right one using iterators.

Latest version **1.2.0** (published 2019-02-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install find-package-json
pnpm add find-package-json
yarn add find-package-json
bun add find-package-json
```

## 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 | 1.2.0 |
| Published | 2019-02-19 |
| First published | 2015-08-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/find-package-json) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Arnout Kazemier |
| Maintainers | 3rdeden |
| Keywords | package, package.json, json, find-package-json, directory, parent, package-json, read-package-json |

## Links

- npm: https://www.npmjs.com/package/find-package-json
- Repository: https://github.com/3rd-Eden/find-package-json
- Homepage: https://github.com/3rd-Eden/find-package-json#readme
- Issues: https://github.com/3rd-Eden/find-package-json/issues
- npm.io page: https://npm.io/package/find-package-json

## 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

- 1.2.0 (latest) — 2019-02-19
- 1.1.0 — 2018-04-17
- 1.0.0 — 2015-08-21

## README

# find-package-json

Easily find package.json files that you're searching for. It spiders parent
directories for `package.json` files and correctly reads the results. It follows
an ES6 iterator design so it should be easy to implement. 

## Installation

The module is released in the public npm registry and can be installed by
running:

```
npm install --save find-package-json
```

## Usage

We expose a single function as module interface. So in all examples we assume
that you've already required the code as illustrated in the example below:

```js
'use strict';

var finder = require('find-package-json');
```

The function accepts 1 optional argument which is the directory it should start
searching in or a module object with a `filename` key. If nothing is provided
it will default to `process.cwd()` as entry point.

As we're build upon the iterator interface you can simply call the `.next()`
function of the returned result to find the first package.json. If you don't
like the result, call `.next()` again to find the next file. Please do note that
these methods do synchronous API calls in Node.js so they are blocking.

```js
var f = finder(__dirname);

console.log(f.next().value); // the package.json object
console.log(f.next().filename); // the path to the package.json file
```

You can also search for the global `module` object:

```js
var f = finder(module);

console.log(f.next().value); // the package.json object
console.log(f.next().filename); // the path to the package.json file
```

If there is no more package.json's to be found, the method will set the returned
`done` key as `true`;

```js
var f = finder(__dirname);

f.next().done // false
f.next().done // true
```

## License

MIT

---
_Source: https://npm.io/package/find-package-json · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._