mos-read-pkg-up

Read the closest package.json file

Why

• Finds the closest package.json
• Gracefully handles filesystem issues
• Strips UTF-8 BOM
• Throws more helpful JSON errors
• Normalizes the data

Installation

This module is installed via npm:

1npm install mos-read-pkg-up --save

Usage

1const readPkgUp = require('mos-read-pkg-up');
2
3readPkgUp().then(result => {
4	console.log(result);
5	//> { pkg:
6	//     { name: 'mos-read-pkg-up',
7	//       version: '1.0.2',
8	//       description: 'Read the closest package.json file',
9	//       license: 'MIT',
10	//       repository:
11	//        { type: 'git',
12	//          url: 'git+ssh://git@github.com/zkochan/read-pkg-up.git' },
13	//       author:
14	//        { name: 'Sindre Sorhus',
15	//          email: 'sindresorhus@gmail.com',
16	//          url: 'sindresorhus.com' },
17	//       engines: { node: '>=0.10.0' },
18	//       scripts: { test: 'xo && ava', md: 'mos' },
19	//       files: [ 'index.js' ],
20	//       keywords:
21	//        [ 'json',
22	//          'read',
23	//          'parse',
24	//          'file',
25	//          'fs',
26	//          'graceful',
27	//          'load',
28	//          'pkg',
29	//          'package',
30	//          'find',
31	//          'up',
32	//          'find-up',
33	//          'findup',
34	//          'look-up',
35	//          'look',
36	//          'file',
37	//          'search',
38	//          'match',
39	//          'package',
40	//          'resolve',
41	//          'parent',
42	//          'parents',
43	//          'folder',
44	//          'directory',
45	//          'dir',
46	//          'walk',
47	//          'walking',
48	//          'path' ],
49	//       dependencies: { 'mos-read-pkg': '^1.1.2', 'find-up': '^1.0.0' },
50	//       devDependencies: { ava: '*', mos: '^0.16.0', xo: '*' },
51	//       bugs: { url: 'https://github.com/zkochan/read-pkg-up/issues' },
52	//       readme: 'ERROR: No README data found!',
53	//       homepage: 'https://github.com/zkochan/read-pkg-up#readme',
54	//       _id: 'mos-read-pkg-up@1.0.2' },
55	//    path: '/home/zoltan/src/read-pkg-up/package.json' }
56});

API

readPkgUp([options])

Returns a promise for the result object.

readPkgUp.sync([options])

Returns a result object.

options

cwd

Type: string
Default: .

Directory to start looking for a package.json file.

normalize

Type: boolean
Default: true

Normalize the package data.

Related

• read-pkg - Read a package.json file
• pkg-up - Find the closest package.json file
• find-up - Find a file by walking up parent directories
• pkg-conf - Get namespaced config from the closest package.json

License

MIT © Sindre Sorhus