bit-docs-process-tags/tags/_default.js

Processes @tags

var tnd = require("bit-docs-type-annotate").typeNameDescription;
var matchTag = /^\s*@(\w+)/;
var distance = require("../lib/distance");
var _ = require('lodash');

/**
 * @hide
 * @parent bit-docs-process-tags/tags
 * @module {bit-docs-process-tags/types/tag} bit-docs-process-tags/tags/_default @_default
 *
 * The default tag behavior when `@TAG` begins a line, but no tag is defined
 * for `TAG`.
 *
 * @signature `@TAG NAME[, ...]`
 *
 * Sets a `TAG` property on the docObject to `"NAME"`.
 *
 * Example:
 * @codestart javascript
 * /**
 *  * @@memberOf _
 *  *|
 *  findById: function( id, success ) {
 *  @codeend
 *
 * This will make the docObject look like:
 *
 * ```
 * {memberof: "_"}
 * ```
 *
 * If `NAME` values are separated by comma-space (`, `), the values will be set
 * as an array. Example:
 *
 * @codestart javascript
 * /**
 *  * @@memberOf _, lodash
 *  *|
 *  findById: function( id, success ) {
 *  @codeend
 *
 * This will make the docObject look like:
 *
 * ```
 * {memberof: ["_", "lodash"]}
 * ```
 *
 * If multiple `@TAG NAME`s are found with the same `TAG`, an array with each
 * `"NAME"` will be created. Example:
 *
 * @codestart javascript
 * /**
 *  * @@memberOf _
 *  * @@memberOf lodash
 *  *|
 *  findById: function( id, success ) {
 *  @codeend
 *
 * This will make the docObject look like:
 *
 * ```
 * {memberof: ["_", "lodash"]}
 * ```
 *
 * @signature `@TAG`
 *
 * Sets a `TAG` property on the docObject to `true`.
 *
 * @body
 *
 */
module.exports = {

	add: function( line, curData, scope, objects, currentWrite, siteConfig ) {

		var tag = line.match(matchTag)[1].toLowerCase(),
			value =  line.replace(matchTag,"").trim();

		if(value.indexOf(", ") >= 0) {
			value = value.split(", ").map(function(val){
				return val.trim();
			});
		}
		if(value && typeof value === "string") {
			value = [value];
		}

		suggestType(siteConfig.tags, tag, this.line, this.src);

		if(value) {
			if( Array.isArray(this[tag]) ){
				this[tag].push.apply(this[tag], value);
			} else if( this[tag] && tag != "name"){
				this[tag] = [this[tag]].concat(value);
			} else {
				this[tag] = value.length > 1 ? value : value[0];
			}
		} else {
			this[tag] = true;
		}

	}
};

function suggestType(tags, incorrect, line, src ) {
	var lowest = 1000,
		suggest = "",
		check = function( things ) {
			for ( var name in things ) {
				var dist = distance(incorrect.toLowerCase(), name.toLowerCase());
				if ( dist < lowest ) {
					lowest = dist;
					suggest = name.toLowerCase();
				}
			}
		};

	check(tags);

	if ( suggest && incorrect != suggest ) {
		console.warn("\WARNING!!\nThere is no @" + incorrect + " tag. did you mean @" + suggest + " ?\n");
	}
};