Edit File - File Manager

Edit File: pkginfo.html

<!DOCTYPE html> <html> <head> <title>pkginfo.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> pkginfo.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">&#182;</a> </div> </td> <td class="code"> <div class="highlight"><pre>/*
 * pkginfo.js: Top-level include for the pkginfo module
 *
 * (C) 2011, Charlie Robbins
 *
 */
 
var fs = require(&#39;fs&#39;),
 path = require(&#39;path&#39;);</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">&#182;</a> </div> <h3>function pkginfo ([options, 'property', 'property' ..])</h3>

<h4>@pmodule {Module} Parent module to read from.</h4>

<h4>@options {Object|Array|string} Optional Options used when exposing properties.</h4>

<h4>@arguments {string...} Optional Specified properties to expose.</h4>

Exposes properties from the package.json file for the parent module on 
it's exports. Valid usage:

<code>require('pkginfo')()</code>

<code>require('pkginfo')('version', 'author');</code>

<code>require('pkginfo')(['version', 'author']);</code>

<code>require('pkginfo')({ include: ['version', 'author'] });</code> </td> <td class="code"> <div class="highlight"><pre>var pkginfo = module.exports = function (pmodule, options) {
 var args = [].slice.call(arguments, 2).filter(function (arg) {
 return typeof arg === &#39;string&#39;;
 });
 </pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">&#182;</a> </div> Parse variable arguments </td> <td class="code"> <div class="highlight"><pre> if (Array.isArray(options)) {</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">&#182;</a> </div> If the options passed in is an Array assume that
it is the Array of properties to expose from the
on the package.json file on the parent module. </td> <td class="code"> <div class="highlight"><pre> options = { include: options };
 }
 else if (typeof options === &#39;string&#39;) {</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">&#182;</a> </div> Otherwise if the first argument is a string, then
assume that it is the first property to expose from
the package.json file on the parent module. </td> <td class="code"> <div class="highlight"><pre> options = { include: [options] };
 }
 </pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">&#182;</a> </div> Setup default options </td> <td class="code"> <div class="highlight"><pre> options = options || { include: [] };
 
 if (args.length &gt; 0) {</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">&#182;</a> </div> If additional string arguments have been passed in
then add them to the properties to expose on the 
parent module. </td> <td class="code"> <div class="highlight"><pre> options.include = options.include.concat(args);
 }
 
 var pkg = pkginfo.read(pmodule, options.dir).package;
 Object.keys(pkg).forEach(function (key) {
 if (options.include.length &gt; 0 &amp;&amp; !~options.include.indexOf(key)) {
 return;
 }
 
 if (!pmodule.exports[key]) {
 pmodule.exports[key] = pkg[key];
 }
 });
 
 return pkginfo;
};</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">&#182;</a> </div> <h3>function find (dir)</h3>

<h4>@pmodule {Module} Parent module to read from.</h4>

<h4>@dir {string} Optional Directory to start search from.</h4>

Searches up the directory tree from <code>dir</code> until it finds a directory
which contains a <code>package.json</code> file. </td> <td class="code"> <div class="highlight"><pre>pkginfo.find = function (pmodule, dir) {
 dir = dir || pmodule.filename;
 dir = path.dirname(dir); 
 
 var files = fs.readdirSync(dir);
 
 if (~files.indexOf(&#39;package.json&#39;)) {
 return path.join(dir, &#39;package.json&#39;);
 }
 
 if (dir === &#39;/&#39;) {
 throw new Error(&#39;Could not find package.json up from: &#39; + dir);
 }
 
 return pkginfo.find(dir);
};</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">&#182;</a> </div> <h3>function read (pmodule, dir)</h3>

<h4>@pmodule {Module} Parent module to read from.</h4>

<h4>@dir {string} Optional Directory to start search from.</h4>

Searches up the directory tree from <code>dir</code> until it finds a directory
which contains a <code>package.json</code> file and returns the package information. </td> <td class="code"> <div class="highlight"><pre>pkginfo.read = function (pmodule, dir) { 
 dir = pkginfo.find(pmodule, dir);
 
 var data = fs.readFileSync(dir).toString();
 
 return {
 dir: dir, 
 package: JSON.parse(data)
 };
};</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">&#182;</a> </div> Call <code>pkginfo</code> on this module and expose version. </td> <td class="code"> <div class="highlight"><pre>pkginfo(module, {
 dir: __dirname,
 include: [&#39;version&#39;],
 target: pkginfo
});

</pre></div> </td> </tr> </tbody> </table> </div> </body> </html>

Back to File Manager