@zkochan/read-pkg

Read a package.json file

Why

• Gracefully handles filesystem issues
• Strips UTF-8 BOM
• Throws more helpful JSON errors
• Normalizes the data

Installation

This module is installed via npm:

npm install @zkochan/read-pkg --save

Usage

var readPkg = require('@zkochan/read-pkg');
var path = require('path');

readPkg().then(function (pkg) {
	console.log(pkg);
	//> { name: '@zkochan/read-pkg',
	//    version: '1.1.1',
	//    description: 'Read a package.json file',
	//    license: 'MIT',
	//    repository: 
	//     { type: 'git',
	//       url: 'git+ssh://[e-mail]/zkochan/read-pkg.git' },
	//    author: 
	//     { name: 'Sindre Sorhus',
	//       email: '[e-mail]',
	//       url: 'sindresorhus.com' },
	//    engines: { node: '>=0.10.0' },
	//    scripts: { test: 'xo && ava', md: 'mos' },
	//    files: [ 'index.js' ],
	//    keywords: 
	//     [ 'json',
	//       'read',
	//       'parse',
	//       'file',
	//       'fs',
	//       'graceful',
	//       'load',
	//       'pkg',
	//       'package',
	//       'normalize' ],
	//    dependencies: 
	//     { '@zkochan/normalize-package-data': '^2.3.6',
	//       'load-json-file': '^1.0.0',
	//       'path-type': '^1.0.0' },
	//    devDependencies: { ava: '*', mos: '^0.16.0', xo: '*' },
	//    bugs: { url: 'https://github.com/zkochan/read-pkg/issues' },
	//    readme: 'ERROR: No README data found!',
	//    homepage: 'https://github.com/zkochan/read-pkg#readme',
	//    _id: '@zkochan/read-pkg@1.1.1' }
});

readPkg(__dirname).then(function (pkg) {
	console.log(pkg);
	//> { name: '@zkochan/read-pkg',
	//    version: '1.1.1',
	//    description: 'Read a package.json file',
	//    license: 'MIT',
	//    repository: 
	//     { type: 'git',
	//       url: 'git+ssh://[e-mail]/zkochan/read-pkg.git' },
	//    author: 
	//     { name: 'Sindre Sorhus',
	//       email: '[e-mail]',
	//       url: 'sindresorhus.com' },
	//    engines: { node: '>=0.10.0' },
	//    scripts: { test: 'xo && ava', md: 'mos' },
	//    files: [ 'index.js' ],
	//    keywords: 
	//     [ 'json',
	//       'read',
	//       'parse',
	//       'file',
	//       'fs',
	//       'graceful',
	//       'load',
	//       'pkg',
	//       'package',
	//       'normalize' ],
	//    dependencies: 
	//     { '@zkochan/normalize-package-data': '^2.3.6',
	//       'load-json-file': '^1.0.0',
	//       'path-type': '^1.0.0' },
	//    devDependencies: { ava: '*', mos: '^0.16.0', xo: '*' },
	//    bugs: { url: 'https://github.com/zkochan/read-pkg/issues' },
	//    readme: 'ERROR: No README data found!',
	//    homepage: 'https://github.com/zkochan/read-pkg#readme',
	//    _id: '@zkochan/read-pkg@1.1.1' }
});

readPkg(path.join('unicorn', 'package.json')).then(function (pkg) {
	console.log(pkg);
});

API

readPkg([path], [options])

Returns a promise that resolves to the parsed JSON.

readPkg.sync([path], [options])

Returns the parsed JSON.

path

Type: string
Default: .

Path to a package.json file or its directory.

options

normalize

Type: boolean
Default: true

Normalize the package data.

Related

• read-pkg-up - Read the closest package.json file
• write-pkg - Write a package.json file
• load-json-file - Read and parse a JSON file

License

MIT © Sindre Sorhus