UNPKG

read-pkg

Version:

Read a package.json file

github.com/sindresorhus/read-pkg

sindresorhus/read-pkg

82 lines (47 loc) • 1.62 kB
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 > Read a package.json file ## Why - [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 ```sh npm install read-pkg ``` ## Usage ```js import {readPackage} from 'read-pkg'; console.log(await readPackage()); //=> {name: 'read-pkg', …} console.log(await readPackage({cwd: 'some-other-directory'})); //=> {name: 'unicorn', …} ``` ## API ### readPackage(options?) Returns a `Promise<object>` with the parsed JSON. ### readPackageSync(options?) Returns the parsed JSON. #### options Type: `object` ##### cwd Type: `URL | string`\ Default: `process.cwd()` Current working directory. ##### normalize Type: `boolean`\ Default: `true` [Normalize](https://github.com/npm/normalize-package-data#what-normalization-currently-entails) the package data. ### parsePackage(packageFile, options?) Parses an object or string into JSON. #### packageFile Type: `object | string` An object or a stringified object to be parsed as a package.json. #### options Type: `object` ##### normalize Type: `boolean`\ Default: `true` [Normalize](https://github.com/npm/normalize-package-data#what-normalization-currently-entails) the package data. ## Related - [read-package-up](https://github.com/sindresorhus/read-package-up) - Read the closest package.json file - [write-package](https://github.com/sindresorhus/write-package) - Write a `package.json` file - [load-json-file](https://github.com/sindresorhus/load-json-file) - Read and parse a JSON file