mirror of
https://github.com/atlanticbiomedical/biomedjs.git
synced 2025-07-02 00:47:26 -04:00
37 lines
3.0 KiB
JSON
37 lines
3.0 KiB
JSON
{
|
|
"name": "pkginfo",
|
|
"version": "0.2.3",
|
|
"description": "An easy way to expose properties on a module from a package.json",
|
|
"author": {
|
|
"name": "Charlie Robbins",
|
|
"email": "charlie.robbins@gmail.com"
|
|
},
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "http://github.com/indexzero/node-pkginfo.git"
|
|
},
|
|
"keywords": [
|
|
"info",
|
|
"tools",
|
|
"package.json"
|
|
],
|
|
"devDependencies": {
|
|
"vows": "0.6.x"
|
|
},
|
|
"main": "./lib/pkginfo",
|
|
"scripts": {
|
|
"test": "vows test/*-test.js --spec"
|
|
},
|
|
"engines": {
|
|
"node": ">= 0.4.0"
|
|
},
|
|
"readme": "# node-pkginfo\n\nAn easy way to expose properties on a module from a package.json\n\n## Installation\n\n### Installing npm (node package manager)\n```\n curl http://npmjs.org/install.sh | sh\n```\n\n### Installing pkginfo\n```\n [sudo] npm install pkginfo\n```\n\n## Motivation\nHow often when writing node.js modules have you written the following line(s) of code? \n\n* Hard code your version string into your code\n\n``` js\n exports.version = '0.1.0';\n```\n\n* Programmatically expose the version from the package.json\n\n``` js\n exports.version = JSON.parse(fs.readFileSync('/path/to/package.json', 'utf8')).version;\n```\n\nIn other words, how often have you wanted to expose basic information from your package.json onto your module programmatically? **WELL NOW YOU CAN!**\n\n## Usage\n\nUsing `pkginfo` is idiot-proof, just require and invoke it. \n\n``` js\n var pkginfo = require('pkginfo')(module);\n \n console.dir(module.exports);\n```\n\nBy 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`). \n\nHere's a sample of the output:\n\n```\n { name: 'simple-app',\n description: 'A test fixture for pkginfo',\n version: '0.1.0',\n author: 'Charlie Robbins <charlie.robbins@gmail.com>',\n keywords: [ 'test', 'fixture' ],\n main: './index.js',\n scripts: { test: 'vows test/*-test.js --spec' },\n engines: { node: '>= 0.4.0' } }\n```\n\n### Expose specific properties\nIf 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:\n\n``` js\n var pkginfo = require('pkginfo')(module, 'version', 'author');\n \n console.dir(module.exports);\n```\n\n```\n { version: '0.1.0',\n author: 'Charlie Robbins <charlie.robbins@gmail.com>' }\n```\n\nIf you're looking for further usage see the [examples][0] included in this repository. \n\n## Run Tests\nTests are written in [vows][1] and give complete coverage of all APIs.\n\n```\n vows test/*-test.js --spec\n```\n\n[0]: https://github.com/indexzero/node-pkginfo/tree/master/examples\n[1]: http://vowsjs.org\n\n#### Author: [Charlie Robbins](http://nodejitsu.com)",
|
|
"readmeFilename": "README.md",
|
|
"_id": "pkginfo@0.2.3",
|
|
"dist": {
|
|
"shasum": "0457c06646c236f7dab060461d31cb2121f040db"
|
|
},
|
|
"_from": "pkginfo@0.2.x",
|
|
"_resolved": "https://registry.npmjs.org/pkginfo/-/pkginfo-0.2.3.tgz"
|
|
}
|