Get the package.json content either from npm or from a git repository.
npm install package.json![PayPal][paypal-donations]    
> Get the package.json content either from npm or from a git repository.
``sh`
$ npm i --save pkg.json
`js
const packageJson = require("pkg.json");
packageJson("git-stats", function (err, data) {
console.log(err || data);
// { _id: 'git-stats',
// _rev: '34-f8a1ea58b78974bb0c530dd9e366cf24',
// name: 'git-stats',
// description: 'Local git statistics including GitHub-like contributions calendars.',
// 'dist-tags': { latest: '2.9.2' },
// versions: {...},
// readme: '\n\n# $ git-stats ![PayPal][paypal-donations]   \n\n> Local git statistics including GitHub-like contributions calendars.\n\nI\'d be curious to see your calendar with all your commits. Ping me on Twitter (@IonicaBizau). :smile: Until then, here\'s my calendar:\n\n\n\n## Contents\n\n - Installation\n - Usage\n \n - Importing and deleting commits\n - Importing all the commits from GitHub and BitBucket\n - What about the GitHub Contributions calendar?\n \n - Documentation\n - How to contribute\n\n## Installation\n\nYou can install the package globally and use it as command line tool:\n\n`sh\n# Install the package globally\nnpm i -g git-stats\n# Initialize git hooks\n# This is for tracking the new commits\ncurl -s https://raw.githubusercontent.com/IonicaBizau/git-stats/master/scripts/init-git-post-commit | bash\n`\n\nThen, run git-stats --help and see what the CLI tool can do.\n\n`sh\n$ git-stats --help\nUsage: git-stats [options]\n\nOptions:\n -s, --since `\n\n## Usage\n### Importing and deleting commits\n\nI know it\'s not nice to start your git commit calendar from scratch. That\'s why I created git-stats-importer–a tool which imports or deletes the commits from selected repositories.\n\nCheck it out here: https://github.com/IonicaBizau/git-stats-importer\n\nThe usage is simple:\n\n`sh\n# Install the importer tool\n$ npm install -g git-stats-importer\n\n# Go to the repository you want to import\n$ cd path/to/my-repository\n\n# Import the commits\n$ git-stats-importer\n\n# ...or delete them if that\'s a dummy repository\n$ git-stats-importer --delete\n`\n### Importing all the commits from GitHub and BitBucket\n\nYes, that\'s also possible. I built a tool which downloads and then imports all the commits you have pushed to GitHub and BitBucket!\n\n`sh\n# Download the repository downloader\n$ git clone https://github.com/IonicaBizau/repository-downloader.git\n\n# Go to repository downloader\n$ cd repository-downloader\n\n# Install the dependencies\n$ npm install\n\n# Start downloading and importing\n$ ./start\n`\n### What about the GitHub Contributions calendar?\n\nIf you want to visualize the calendars that appear on GitHub profiles, you can do that using ghcal.\n\n`sh\n# Install ghcal\n$ npm install -g ghcal\n\n# Check out @alysonla\'s contributions\n$ ghcal -u alysonla\n`\n\nFor more detailed documentation, check out the repository: https://github.com/IonicaBizau/ghcal.\n\nIf want to get even more GitHub stats in your terminal, you may want to try github-stats--this is like git-stats but with data taken from GitHub.\n\n## Using the configuration file\n\nYou can tweak the git-stats behavior using a configuration file in your home directory: ~/.git-stats-config.js.\n\nThis file should export an object, like below (defaults are listed):\n\n`js\nmodule.exports = {\n // "DARK", "LIGHT" or an object interpreted by IonicaBizau/node-git-stats-colors\n "theme": "DARK"\n\n // The file where the commit hashes will be stored\n , "path": "~/.git-stats"\n\n // First day of the week\n , first_day: "Sun"\n\n // This defaults to one year ago\n // It can be any parsable date\n , since: undefined\n\n // This defaults to now\n // It can be any parsable date\n , until: undefined\n\n // Don\'t show authors by default\n // If true, this will enable the authors pie\n , authors: false\n\n // No global activity by default\n // If true, this will enable the global activity calendar in the current project\n , global_activity: false\n};\n`\n\nSince it\'s a js file, you can require any other modules there.\n\n## Cross-platform compatibility\n\ngit-stats is working fine in terminal emulators supporting ANSI styles. It should work fine on Linux and OS X.\n\nIf you run git-stats to display graph on Windows, please use a terminal that can properly display ANSI colors.\n\nCygwin Terminal is known to work, while Windows Command Prompt and Git Bash do not. Improvements are more than welcome! :dizzy:\n\n## Example\n\nHere is an example how to use this package as library. To install it locally, as library, you can do that using npm:\n\n`sh\n$ npm i --save git-stats\n`\n\n`js\n// Dependencies\nvar GitStats = require("git-stats");\n\n// Create the GitStats instance\nvar g1 = new GitStats();\n\n// Display the ansi calendar\ng1.ansiCalendar({\n theme: "DARK"\n}, function (err, data) {\n console.log(err || data);\n});\n`\n\n## Documentation\n\nFor full API reference, see the [DOCUMENTATION.md][docs] file.\n\n## Press Highlights\n\n - A GitHub-like contributions calendar, but locally, with all your git commits, The Changelog\n\n## How to contribute\nHave an idea? Found a bug? See [how to contribute][contributing].\n\n## Where is this library used?\nIf you are using this library in one of your projects, add it in this list. :sparkles:\n\n - git-stats-importer\n\n## License\n\n[MIT][license] © [Ionică Bizău][website]\n\n[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW\n[donate-now]: http://i.imgur.com/6cMbHOC.png\n\n[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(http%3A%2F%2Fionicabizau.net)&year=2015#license-mit\n[website]: http://ionicabizau.net\n[contributing]: /CONTRIBUTING.md\n[docs]: /DOCUMENTATION.md',
// maintainers: [ { name: 'ionicabizau', email: 'bizauionica@yahoo.com' } ],
// time: {...},
// ...
// users: { bret: true, despairblue: true, program247365: true },
// _attachments: {} }
});
packageJson("IonicaBizau/git-stats", function (err, data) {
console.log(err || data);
// { name: 'git-stats',
// version: '2.9.2',
// description: 'Local git statistics including GitHub-like contributions calendars.',
// main: 'lib/index.js',
// bin: { 'git-stats': './bin/git-stats' },
// ...
// _id: 'git-stats@2.9.2' }
});
packageJson("git@github.com:IonicaBizau/git-stats.git", function (err, data) {
console.log(err || data);
// { name: 'git-stats',
// version: '2.9.2',
// description: 'Local git statistics including GitHub-like contributions calendars.',
// ...
// _id: 'git-stats@2.9.2' }
});
packageJson("git@github.com:IonicaBizau/git-stats.git", "2.7.0", function (err, data) {
console.log(err || data.version);
// "2.7.0"
});
`
file contents from npm or a git repository.#### Params
- String
input: The package npm name or git url. The git urls are friendly, being parsed by git-source.
- String version: The npm package version or a git sha/tag/branch/etc.
- Function callback`: The callback function.[MIT][license] © [Ionică Bizău][website]
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
[donate-now]: http://i.imgur.com/6cMbHOC.png
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(http%3A%2F%2Fionicabizau.net)&year=2016#license-mit
[website]: http://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md