get-package-json-from-github

Get package.json from github

Installation

Download node at nodejs.org and install it, if you haven't already.

npm install get-package-json-from-github --save

Usage

import getPackageJsonFromGithub from 'get-package-json-from-github';

getPackageJsonFromGithub('git+https://github.com/kesla/get-package-json-from-github.git')
  .then(packageJson => {
    console.log('packageJson', packageJson);
  });

// can also load a caching version

const cached = getPackageJsonFromGithub.cached();

cached('git+https://github.com/kesla/get-package-json-from-github.git')
  .then(packageJson => {
    console.log('packageJson', packageJson);
  });

Tests

npm install
npm test

Dependencies

• fast-cache: Caches a method that returns a promise and does so really fast.
• gh-got: Convenience wrapper for got to interact with the GitHub API
• immutable-object-methods: Update normal plain javascript object, immutable style. Simlar to how immutable.js, seamless-immutable etc does it but a lot smaller and simpler.
• npm-package-arg: Parse the things that can be arguments to npm install

Dev Dependencies

• babel-cli: Babel command line.
• babel-core: Babel compiler core.
• babel-preset-es2015: Babel preset for all es2015 plugins.
• babel-preset-es2015-node4: Babel preset to make node@4 ES2015 compatible.
• babel-tape-runner: Babel + Tape for running your ES Next tests
• package-json-to-readme: Generate a README.md from package.json contents
• semistandard: All the goodness of feross/standard with semicolons sprinkled on top.
• snazzy: Format JavaScript Standard Style as Stylish (i.e. snazzy) output
• tapava: the syntax of ava, run through tape

License

MIT

Generated by package-json-to-readme