Nostalgic Perogi Monogramming
Miss any of our Open RFC calls?Watch the recordings here! »

load-module-pkg

1.0.0 • Public • Published

load-module-pkg NPM version NPM monthly downloads NPM total downloads Linux Build Status

Load the package.json for a module currently installed in node_modules, or at the given cwd.

Install

Install with npm:

$ npm install --save load-module-pkg

Usage

var load = require('load-module-pkg');

async

load('kind-of', function(err, pkg) {
  if (err) throw err;
  console.log(pkg.name);
  //=> 'kind-of'
});
 
// load package.json from cwd
load('.', function(err, pkg) {
  if (err) throw err;
  console.log(pkg.name);
  //=> 'load-module-pkg'
});

sync

var pkg = load.sync('kind-of');
console.log(pkg.name);
//=> 'kind-of'
 
var pkg = load.sync('./foo', {cwd: 'bar'});
console.log(pkg.name);
//=> 'my-module'

Options

All options are passed to resolve, see the resolve docs for all available options and features.

options.cwd

Type: string

Default: undefined

Alias for the basedir option passed to resolve.

Additionally, process.cwd() is used as basedir if the module name does not begin with . and basedir is undefined.

options.expand

Type: boolean

Default: true

By default, values in the resolved package.json are normalized and expanded. Where applicable, this converts string values (like author and repository) into objects, and adds missing properties when possible (like homepage if the repository.url can be used), making the data easier to use in other applications.

You can disable this by setting this option to false:

var load = require('load-module-pkg');
 
var pkg = load.sync('mocha');
console.log(pkg.repository.url);
//=> git+https://github.com/mochajs/mocha.git
console.log(pkg.href);
//=> https://github.com/mochajs/mocha
 
var pkg = load.sync('mocha', {expand: false});
console.log(pkg.repository.url);
//=> git+https://github.com/mochajs/mocha.git
console.log(pkg.href);
//=> undefined

See expand-pkg to learn more about how values are expanded.

About

Related projects

  • find-file-up: Find a file, starting with the given cwd and recursively searching up one directory until… more | homepage
  • find-pkg: Find the first directory with a package.json, recursing up, starting with the given directory. Similar… more | homepage
  • load-pkg: Loads the package.json from the root of the user's current project. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on May 20, 2017.

Install

npm i load-module-pkg

DownloadsWeekly Downloads

2,012

Version

1.0.0

License

MIT

Last publish

Collaborators

  • avatar
  • avatar