comments

Author: tetsuo

lib/builders/lookup.js

@@ -6,8 +6,7 @@ var path = require('path');
 var debug = require('debug')('component-builder:scripts:lookup');
 var createManifest = require('component-manifest');
 
-// default extensions to look up
-var EXTENSIONS = [
+var EXTENSIONS = [ // default extensions to look up
   '',
   '.js',
   '.json',
@@ -16,13 +15,25 @@ var EXTENSIONS = [
 
 var RELATIVE_PATH = /^\.{1,2}\/.*/;
 
+/**
+ * From a file, lookup another file within that dep.
+ * For use within `require()`s.
+ * 
+ * @param {Object} file
+ * @param {Object} opts for manifest generator
+ */
 function Lookup (file, opts) {
   if (!(this instanceof Lookup)) return new Lookup(file, opts);
   this.file = file;
   this.opts = opts;
   this.manifestGenerator = createManifest(opts);
 }
 
+/**
+ * Executes a lookup.
+ * 
+ * @type {String} target
+ */
 Lookup.prototype.exec = function* (target) {
   var ret;
   target = target.toLowerCase();
@@ -37,6 +48,13 @@ Lookup.prototype.exec = function* (target) {
   }
 };
 
+/**
+ * Lookup a relative file.
+ * 
+ * @param  {String} target
+ * @param  {Object} file
+ * @return {String}
+ */
 Lookup.prototype.relatives = function (target, file) {
   file || (file = this.file);
 
@@ -62,19 +80,28 @@ Lookup.prototype.relatives = function (target, file) {
   return null;
 };
 
+/**
+ * Lookup a nonrelative file.
+ * 
+ * @param  {String} target
+ * @return {String}
+ */
 Lookup.prototype.nonrelatives = function* (target) {
   var frags = tofrags(target);
   var head = frags[0], tail = frags[1];
   var ret;
 
+  // aliases
   ret = this.aliases.apply(this, frags)
   if (ret != null)
     return ret;
 
+  // locals
   ret = yield* this.locals(target);
   if (ret != null)
     return ret;
 
+  // dependencies
   ret = yield* this.dependencies(target);
   if (ret != null)
     return ret;
@@ -97,6 +124,16 @@ Lookup.prototype.nonrelatives = function* (target) {
   return target;
 };
 
+/**
+ * Lookup an alias.
+ *
+ * <user>-<repo>
+ * <user>~<repo>
+ * 
+ * @param  {String} head
+ * @param  {String} tail
+ * @return {String}
+ */
 Lookup.prototype.aliases = function (head, tail) {
   var deps = this.file.branch.dependencies;
   var name;
@@ -145,6 +182,15 @@ Lookup.prototype.foreignRelative = function* (branch, relativeFile) {
   return relative;
 };
 
+/**
+ * Lookup a local dependency.
+ *
+ * <local-name>
+ * <local-name>/<filename>
+ * 
+ * @param  {String} target
+ * @return {String}
+ */
 Lookup.prototype.locals = function* (target) {
   var deps = this.file.branch.locals;
   var keys = Object.keys(deps);
@@ -172,6 +218,15 @@ Lookup.prototype.locals = function* (target) {
   }
 };
 
+/**
+ * Lookup a remote dependency.
+ *
+ * <repo>
+ * <reference>/<filename>
+ * 
+ * @param  {String} target
+ * @return {String}
+ */
 Lookup.prototype.dependencies = function* (target) {
   var deps = this.file.branch.dependencies;
   var keys = Object.keys(deps);
@@ -200,6 +255,12 @@ Lookup.prototype.dependencies = function* (target) {
   }
 };
 
+/**
+ * Split reference name.
+ * 
+ * @param  {String} target
+ * @return {Array}
+ */
 function tofrags (target) {
   var frags = target.split('/');
   var head = frags[0];