get-pkg

Get the package.json for a project from npm.

Usage no npm install needed!

<script type="module">
  import getPkg from 'https://cdn.skypack.dev/get-pkg';
</script>

README

get-pkg NPM version NPM monthly downloads NPM total downloads Linux Build Status

Get the package.json for a project from npm.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save get-pkg

Also see get-pkgs, if you need to get more than one package.json.

Usage

const getPkg = require('get-pkg');

// takes a callback
getPkg('generate', function(err, pkg) {
  console.log(pkg);
});

// or returns a promise
getPkg('generate')
  .then(pkg => console.log(pkg))
  .catch(console.error);

About

Contributing

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

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
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

Related projects

You might also be interested in these projects:

  • get-pkgs: Get the package.json for an array of repos from the npm registry, optionally filtering properties‚Ķ more | homepage
  • github-base: Low-level methods for working with the GitHub API in node.js/JavaScript. | homepage

Contributors

Commits Contributor
16 jonschlinkert
3 stefanwalther
2 doowb
1 joakimbeng

Author

Jon Schlinkert

License

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


This file was generated by verb-generate-readme, v0.8.0, on December 08, 2018.