package/package.json000644 000765 000024 0000001321 12572535462013025 0ustar00000000 000000 { "name": "read-pkg", "version": "1.1.0", "description": "Read a package.json file", "license": "MIT", "repository": "sindresorhus/read-pkg", "author": { "name": "Sindre Sorhus", "email": "sindresorhus@gmail.com", "url": "sindresorhus.com" }, "engines": { "node": ">=0.10.0" }, "scripts": { "test": "xo && ava" }, "files": [ "index.js" ], "keywords": [ "json", "read", "parse", "file", "fs", "graceful", "load", "pkg", "package", "normalize" ], "dependencies": { "load-json-file": "^1.0.0", "normalize-package-data": "^2.3.2", "path-type": "^1.0.0" }, "devDependencies": { "ava": "*", "xo": "*" } } package/index.js000644 000765 000024 0000001550 12572535411012202 0ustar00000000 000000 'use strict'; var path = require('path'); var loadJsonFile = require('load-json-file'); var normalizePackageData = require('normalize-package-data'); var pathType = require('path-type'); module.exports = function (fp, opts) { if (typeof fp !== 'string') { opts = fp; fp = '.'; } opts = opts || {}; return pathType.dir(fp) .then(function (isDir) { if (isDir) { fp = path.join(fp, 'package.json'); } return loadJsonFile(fp); }) .then(function (x) { if (opts.normalize !== false) { normalizePackageData(x); } return x; }); }; module.exports.sync = function (fp, opts) { if (typeof fp !== 'string') { opts = fp; fp = '.'; } opts = opts || {}; fp = pathType.dirSync(fp) ? path.join(fp, 'package.json') : fp; var x = loadJsonFile.sync(fp); if (opts.normalize !== false) { normalizePackageData(x); } return x; }; package/license000644 000765 000024 0000002137 12320273017012074 0ustar00000000 000000 The MIT License (MIT) Copyright (c) Sindre Sorhus (sindresorhus.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. package/readme.md000644 000765 000024 0000003256 12571751235012324 0ustar00000000 000000 # read-pkg [![Build Status](https://travis-ci.org/sindresorhus/read-pkg.svg?branch=master)](https://travis-ci.org/sindresorhus/read-pkg) > Read a package.json file ## Why - [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 --save read-pkg ``` ## Usage ```js var readPkg = require('read-pkg'); readPkg().then(function (pkg) { console.log(pkg); //=> {name: 'read-pkg', ...} }); readPkg(__dirname).then(function (pkg) { console.log(pkg); //=> {name: 'read-pkg', ...} }); readPkg(path.join('unicorn', 'package.json')).then(function (pkg) { console.log(pkg); //=> {name: 'read-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](https://github.com/npm/normalize-package-data#what-normalization-currently-entails) the package data. ## Related - [read-pkg-up](https://github.com/sindresorhus/read-pkg-up) - Read the closest package.json file - [write-pkg](https://github.com/sindresorhus/write-pkg) - Write a `package.json` file - [load-json-file](https://github.com/sindresorhus/load-json-file) - Read and parse a JSON file ## License MIT © [Sindre Sorhus](http://sindresorhus.com)