seeq
Version:
Search or detect name on some resource (GitHub, NPM, Bower, ...)
321 lines (245 loc) • 9.08 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>seeq Source: format/markdown.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.spacelab.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<a class="brand" href="index.html">seeq</a>
<ul class="nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="module-bower.html">bower</a>
</li>
<li>
<a href="module-cdn.html">cdn</a>
</li>
<li>
<a href="module-cdnjs.html">cdnjs</a>
</li>
<li>
<a href="module-cli.html">cli</a>
</li>
<li>
<a href="module-component.html">component</a>
</li>
<li>
<a href="module-customelements.html">customelements</a>
</li>
<li>
<a href="module-format.html">format</a>
</li>
<li>
<a href="util.html">format/util</a>
</li>
<li>
<a href="module-github.html">github</a>
</li>
<li>
<a href="module-grunt.html">grunt</a>
</li>
<li>
<a href="module-gulp.html">gulp</a>
</li>
<li>
<a href="module-jam.html">jam</a>
</li>
<li>
<a href="module-jsdelivr.html">jsdelivr</a>
</li>
<li>
<a href="module-json.html">json</a>
</li>
<li>
<a href="module-jster.html">jster</a>
</li>
<li>
<a href="module-markdown.html">markdown</a>
</li>
<li>
<a href="module-microjs.html">microjs</a>
</li>
<li>
<a href="module-npm.html">npm</a>
</li>
<li>
<a href="module-raw.html">raw</a>
</li>
<li>
<a href="module-resource.html">resource</a>
</li>
<li>
<a href="util_.html">resource/util</a>
</li>
<li>
<a href="module-seeq.html">seeq</a>
</li>
<li>
<a href="module-spm.html">spm</a>
</li>
<li>
<a href="module-text.html">text</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="util-FailedHttpRequestError.html">FailedHttpRequestError</a>
</li>
<li>
<a href="util-IncorrectResponseError.html">IncorrectResponseError</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: format/markdown.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* Module that provides formatter to convert result of {@link module:seeq.search search}
* into {@link http://daringfireball.net/projects/markdown/ Markdown}.
*
* @module markdown
*/
"use strict";
var sEol = require("os").EOL,
util = require("./util");
/**
* Format/convert result of {@link module:seeq.search search} into {@link http://daringfireball.net/projects/markdown/ Markdown}.
*
* @param {Object} data
* Result of {@link module:seeq.search search}.
* @param {Object} settings
* Format settings. See {@link module:format format} for details.
* @return {String}
* Markdown text representing result of search.
* @see {@link module:format format}
*/
module.exports = function(data, settings) {
/*jshint boss:true, expr:true*/
var getLicenseList = util.getLicenseList,
getRepository = util.getRepository,
bVerbose = settings.verbose,
queryList = settings.queryList,
out = [],
sBr = " " + sEol,
sIndent = " ",
sIndentTwice = " ",
nameResult, nI, nK, nN, nQ, sName, sResourceName, resourceResult, resourceResultList, result, value;
for (nI = 0, nK = queryList.length; nI < nK; nI++) {
sName = queryList[nI];
nameResult = data[sName];
if (nameResult && typeof nameResult === "object") {
nI &&
out.push(sEol);
out.push(nI + 1, ". ", sName);
for (sResourceName in nameResult) {
out.push(sEol, sIndent, "* ", sResourceName);
resourceResult = nameResult[sResourceName];
resourceResultList = resourceResult.result;
nQ = resourceResultList.length;
if (nQ) {
out.push(" - ", nQ);
for (nN = 0; nN < nQ; nN++) {
result = resourceResultList[nN];
out.push(sEol, sIndentTwice, "+ ");
if (value = result.url) {
out.push("[", result.name, "](", value, ")");
}
else {
out.push("**", result.name, "**");
}
if (value = result.description) {
out.push(" - ",
value.replace(/\r\n\r\n|\n\n/g, sBr)
.replace(/</g, "<")
.replace(/>/g, ">"));
}
(value = result.keywords) && value.length &&
out.push(sBr, sIndentTwice, " _keywords_: ", value.join(" "));
if (bVerbose) {
result.version &&
out.push(sBr, sIndentTwice, " _version_: ", result.version);
(value = getRepository(result)) &&
out.push(sBr, sIndentTwice, " _repository_: [", value, "](", value, ")");
result.language &&
out.push(sBr, sIndentTwice, " _language_: ", result.language);
(value = getLicenseList(result)) && value.length &&
out.push(sBr, sIndentTwice, " _license_: ", value.join(", "));
result.stars &&
out.push(sBr, sIndentTwice, " _stars_: ", result.stars);
}
}
}
else {
out.push(sBr, sIndentTwice, sName, " is not found.");
resourceResult.error &&
out.push(sBr, sIndentTwice, "Error of checking '", sName, "' at '", sResourceName, "': ", resourceResult.error);
}
}
}
}
return out.join("");
};
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Copyright (c) 2014 Denis Sikuler
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a>
on Thu Aug 21 2014 23:46:51 GMT+0400 (MSK) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>