An easy way to expose properties on a module from a package.json

npm install pkginfo
30 483 downloads in the last day
157 109 downloads in the last week
734 141 downloads in the last month


An easy way to expose properties on a module from a package.json


Installing npm (node package manager)

  curl | sh

Installing pkginfo

  [sudo] npm install pkginfo


How often when writing node.js modules have you written the following line(s) of code?

  • Hard code your version string into your code
  exports.version = '0.1.0';
  • Programmatically expose the version from the package.json
  exports.version = JSON.parse(fs.readFileSync('/path/to/package.json', 'utf8')).version;

In other words, how often have you wanted to expose basic information from your package.json onto your module programmatically? WELL NOW YOU CAN!


Using pkginfo is idiot-proof, just require and invoke it.

  var pkginfo = require('pkginfo')(module);


By invoking the pkginfo module all of the properties in your package.json file will be automatically exposed on the callee module (i.e. the parent module of pkginfo).

Here's a sample of the output:

  { name: 'simple-app',
    description: 'A test fixture for pkginfo',
    version: '0.1.0',
    author: 'Charlie Robbins <>',
    keywords: [ 'test', 'fixture' ],
    main: './index.js',
    scripts: { test: 'vows test/*-test.js --spec' },
    engines: { node: '>= 0.4.0' } }

Expose specific properties

If you don't want to expose all properties on from your package.json on your module then simple pass those properties to the pkginfo function:

  var pkginfo = require('pkginfo')(module, 'version', 'author');

  { version: '0.1.0',
    author: 'Charlie Robbins <>' }

If you're looking for further usage see the examples included in this repository.

Run Tests

Tests are written in vows and give complete coverage of all APIs.

  vows test/*-test.js --spec

Author: Charlie Robbins

License: MIT

npm loves you