resolve-app-pkginfo
v1.0.0
Published
Resolves an application's package.json.
Downloads
4
Maintainers
Readme
pkginfo
Resolves an application's
package.json
.
Installation
$ npm install resolve-app-pkginfo
Usage
var pkginfo = require( 'resolve-app-pkginfo' );
pkginfo( clbk )
Resolves an application's package.json
.
pkginfo( done );
function done( error, pkg ) {
if ( error ) {
throw error;
}
console.dir( pkg );
}
pkginfo.sync()
Synchronously resolves an application's package.json
.
var pkg = pkginfo.sync();
if ( pkg instanceof Error ) {
throw pkg;
}
console.dir( pkg );
Notes
- This module relies on resolve-app-path to resolve an application's root directory.
Examples
var pkginfo = require( 'resolve-app-pkginfo' );
var pkg = pkginfo.sync();
console.log( 'Name: %s', pkg.name );
console.log( 'Version: %s', pkg.version );
console.log( 'Description: %s', pkg.description );
console.log( 'Author: %s', pkg.author.name );
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ make view-cov
License
Copyright
Copyright © 2015. Athan Reines.