333

schangxiang@126.com

2025-09-19 18966e02fb573c7e2bb0c6426ed792b38b910940

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# read-pkg-up [![Build Status](https://travis-ci.org/sindresorhus/read-pkg-up.svg?branch=master)](https://travis-ci.org/sindresorhus/read-pkg-up)
 
> Read the closest package.json file
 
 
## Why
 
- [Finds the closest package.json](https://github.com/sindresorhus/find-up)
- [Gracefully handles filesystem issues](https://github.com/isaacs/node-graceful-fs)
- [Strips UTF-8 BOM](https://github.com/sindresorhus/strip-bom)
- [Throws more helpful JSON errors](https://github.com/sindresorhus/parse-json)
- [Normalizes the data](https://github.com/npm/normalize-package-data#what-normalization-currently-entails)
 
 
## Install
 
```
$ npm install read-pkg-up
```
 
 
## Usage
 
```js
const readPkgUp = require('read-pkg-up');
 
(async () => {
    console.log(await readPkgUp());
    /*
    {
        pkg: {
            name: 'awesome-package',
            version: '1.0.0',
            …
        },
        path: '/Users/sindresorhus/dev/awesome-package/package.json'
    }
    */
})();
```
 
 
## API
 
### readPkgUp([options])
 
Returns a `Promise` for the result object.
 
### readPkgUp.sync([options])
 
Returns the result object.
 
#### options
 
Type: `Object`
 
##### cwd
 
Type: `string`<br>
Default: `process.cwd()`
 
Directory to start looking for a package.json file.
 
##### normalize
 
Type: `boolean`<br>
Default: `true`
 
[Normalize](https://github.com/npm/normalize-package-data#what-normalization-currently-entails) the package data.
 
 
## Related
 
- [read-pkg](https://github.com/sindresorhus/read-pkg) - Read a package.json file
- [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
- [find-up](https://github.com/sindresorhus/find-up) - Find a file by walking up parent directories
- [pkg-conf](https://github.com/sindresorhus/pkg-conf) - Get namespaced config from the closest package.json
 
 
## License
 
MIT © [Sindre Sorhus](https://sindresorhus.com)