pax_global_header00006660000000000000000000000064127727013550014523gustar00rootroot0000000000000052 comment=c1664a2f42d1f1898b7648534576e6dcfa1f48c8 read-pkg-2.0.0/000077500000000000000000000000001277270135500132145ustar00rootroot00000000000000read-pkg-2.0.0/.editorconfig000066400000000000000000000002761277270135500156760ustar00rootroot00000000000000root = true [*] indent_style = tab end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true [{package.json,*.yml}] indent_style = space indent_size = 2 read-pkg-2.0.0/.gitattributes000066400000000000000000000000351277270135500161050ustar00rootroot00000000000000* text=auto *.js text eol=lf read-pkg-2.0.0/.gitignore000066400000000000000000000000151277270135500152000ustar00rootroot00000000000000node_modules read-pkg-2.0.0/.travis.yml000066400000000000000000000000531277270135500153230ustar00rootroot00000000000000language: node_js node_js: - '6' - '4' read-pkg-2.0.0/index.js000066400000000000000000000014601277270135500146620ustar00rootroot00000000000000'use strict'; const path = require('path'); const loadJsonFile = require('load-json-file'); const pathType = require('path-type'); module.exports = (fp, opts) => { if (typeof fp !== 'string') { opts = fp; fp = '.'; } opts = opts || {}; return pathType.dir(fp) .then(isDir => { if (isDir) { fp = path.join(fp, 'package.json'); } return loadJsonFile(fp); }) .then(x => { if (opts.normalize !== false) { require('normalize-package-data')(x); } return x; }); }; module.exports.sync = (fp, opts) => { if (typeof fp !== 'string') { opts = fp; fp = '.'; } opts = opts || {}; fp = pathType.dirSync(fp) ? path.join(fp, 'package.json') : fp; const x = loadJsonFile.sync(fp); if (opts.normalize !== false) { require('normalize-package-data')(x); } return x; }; read-pkg-2.0.0/license000066400000000000000000000021371277270135500145640ustar00rootroot00000000000000The 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. read-pkg-2.0.0/package.json000066400000000000000000000013561277270135500155070ustar00rootroot00000000000000{ "name": "read-pkg", "version": "2.0.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": ">=4" }, "scripts": { "test": "xo && ava" }, "files": [ "index.js" ], "keywords": [ "json", "read", "parse", "file", "fs", "graceful", "load", "pkg", "package", "normalize" ], "dependencies": { "load-json-file": "^2.0.0", "normalize-package-data": "^2.3.2", "path-type": "^2.0.0" }, "devDependencies": { "ava": "*", "xo": "*" }, "xo": { "esnext": true } } read-pkg-2.0.0/readme.md000066400000000000000000000032221277270135500147720ustar00rootroot00000000000000# 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 const readPkg = require('read-pkg'); readPkg().then(pkg => { console.log(pkg); //=> {name: 'read-pkg', ...} }); readPkg(__dirname).then(pkg => { console.log(pkg); //=> {name: 'read-pkg', ...} }); readPkg(path.join('unicorn', 'package.json')).then(pkg => { console.log(pkg); //=> {name: 'read-pkg', ...} }); ``` ## API ### readPkg([path], [options]) Returns a `Promise` for 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](https://sindresorhus.com) read-pkg-2.0.0/test/000077500000000000000000000000001277270135500141735ustar00rootroot00000000000000read-pkg-2.0.0/test/pkg.json000066400000000000000000000000541277270135500156460ustar00rootroot00000000000000{ "name": "unicorn", "version": "1.0.0" } read-pkg-2.0.0/test/test.js000066400000000000000000000016111277270135500155070ustar00rootroot00000000000000'use strict'; import path from 'path'; import test from 'ava'; import m from '../'; const pkg = path.join(__dirname, '..'); const otherName = path.join(__dirname, 'pkg.json'); test('async', async t => { const x = await m(otherName); t.is(x.name, 'unicorn'); t.truthy(x._id); }); test('async - directory', async t => { const x = await m(pkg); t.is(x.name, 'read-pkg'); t.truthy(x._id); }); test.serial('async - default filepath', async t => { process.chdir('..'); const x = await m(); t.is(x.name, 'read-pkg'); process.chdir('test'); }); test('sync', t => { const x = m.sync(otherName); t.is(x.name, 'unicorn'); t.truthy(x._id); }); test('sync - directory', t => { const x = m.sync(pkg); t.is(x.name, 'read-pkg'); t.truthy(x._id); }); test.serial('sync - default filepath', t => { process.chdir('..'); const x = m.sync(); t.is(x.name, 'read-pkg'); process.chdir('test'); });