npm install mos-read-pkg> Read a package.json file
- Gracefully handles filesystem issues
- Strips UTF-8 BOM
- Throws more helpful JSON errors
- Normalizes the data
This module is installed via npm:
``sh`
npm install mos-read-pkg --save
`js
var readPkg = require('mos-read-pkg');
var path = require('path');
readPkg().then(function (pkg) {
console.log(pkg);
//> { name: 'mos-read-pkg',
// version: '1.1.1',
// description: 'Read a package.json file',
// license: 'MIT',
// repository:
// { type: 'git',
// url: 'git+ssh://git@github.com/zkochan/read-pkg.git' },
// author:
// { name: 'Sindre Sorhus',
// email: 'sindresorhus@gmail.com',
// 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:
// { 'mos-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: 'mos-read-pkg@1.1.1' }
});
readPkg(__dirname).then(function (pkg) {
console.log(pkg);
//> { name: 'mos-read-pkg',
// version: '1.1.1',
// description: 'Read a package.json file',
// license: 'MIT',
// repository:
// { type: 'git',
// url: 'git+ssh://git@github.com/zkochan/read-pkg.git' },
// author:
// { name: 'Sindre Sorhus',
// email: 'sindresorhus@gmail.com',
// 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:
// { 'mos-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: 'mos-read-pkg@1.1.1' }
});
readPkg(path.join('unicorn', 'package.json')).then(function (pkg) {
console.log(pkg);
});
`
Returns a promise that resolves to the parsed JSON.
Returns the parsed JSON.
#### path
Type: string .
Default:
Path to a package.json file or its directory.
#### options
##### normalize
Type: boolean true
Default:
Normalize the package data.
- 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
MIT © Sindre Sorhus