firedoc

Version:

API Doc generator rewritten from [YUIDoc](https://github.com/yui/yuidoc). We use this tool to document a large JavaScript game engine [Fireball](http://github.com/fireball-x/fireball) at [docs-zh.fireball-x.com/api](http://docs-zh.fireball-x.com/api/) and

github.com/fireball-x/firedoc

fireball-x/firedoc

1,378 lines (1,376 loc) • 46.2 kB

HTML

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/utils.js</title> <meta charset="utf-8"> <link rel="stylesheet" href="../prettify.css"> <link rel="stylesheet" href="../base.css"> <style type='text/css'> div.coverage-summary .sorter { background-image: url(../sort-arrow-sprite.png); } </style> </head> <body> <div class="header low"> <h1>Code coverage report for lib/utils.js</h1> <h2> Statements: 26.67% (40 / 150)      Branches: 0% (0 / 83)      Functions: 0% (0 / 28)      Lines: 27.03% (40 / 148)      Ignored: none      </h2> <div class="path"><a href="../index.html">All files</a> » <a href="index.html">lib/</a> » utils.js</div> </div> <div class="body"> <pre><table class="coverage"> <tr><td class="line-count">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445</td><td class="line-coverage">              1 1 1 1 1                               1     1                     1           1                 1         1                 1             1                       1             1                       1     1                     1                       1                   1       1                     1 1                                                             1                   1       1                       1                                                                                                                                   1                   1                         1                       1         1                   1                                                           1                 1           1                 1                                                     1                     1                                 1    </td><td class="text"><pre class="prettyprint lang-js">/*jshint onevar:false */   /** * Utilities modules * @module utils */   const _ = require('underscore'); const fs = require('graceful-fs'); const path = require('path'); const minimatch = require('minimatch'); const HTML_CHARS = { '&': '&amp;', '<': '&lt;', '>': '&gt;', '"': '&quot;', "'": '&#x27;', '/': '&#x2F;', '`': '&#x60;' };   /** * Format the process string to array * @method fmtProcess * @param {String} process * @return {Array} The process array */ function fmtProcess (process) { return process.split(',').map(safetrim); } exports.fmtProcess = fmtProcess;   /** * Get the namespace string from a target object * @method getNamespace * @param {Object} target * @param {String} target.module * @param {String} target.clazz * @param {String} target.name * @return {String} The namespace string */ function getNamespace (target) { var nssource = [target.module, target.clazz, target.name]; return nssource.filter(function (item) { return !!item; }).join('.'); } exports.getNamespace = getNamespace;   /** * Escapes HTML characters in _html_. * * @method escapeHTML * @param {String} html String to escape. * @return {String} Escaped string. **/ function escapeHTML (html) { return html.replace(/[&<>"'\/`]/g, function (m) { return HTML_CHARS[m]; }); } exports.escapeHTML = escapeHTML;   /** * Trim in safe mode * * @method safetrim * @param {String} str * @return {String} trimed string or other types if invalid */ function safetrim (str) { if (str && _.isFunction(str.trim)) { return str.trim(); } else { return String(str || '').trim(); } } exports.safetrim = safetrim;   /** * Normalizes the initial indentation of the given _content_ so that the first line * is unindented, and all other lines are unindented to the same degree as the * first line. So if the first line has four spaces at the beginning, then all * lines will be unindented four spaces. Ported from [Selleck](https://github.com/rgrove/selleck) * * @method unindent * @param {String} content Text to unindent. * @return {String} Unindented text. **/ function unindent (contents) { var indent = contents.match(/^(\s+)/); if (indent) { contents = contents.replace(new RegExp('^' + indent[1], 'gm'), ''); } return contents; } exports.unindent = unindent;   /** * Normalizes a file path to a writable filename: * * var path = 'lib/file.js'; * returns 'lib_file.js'; * * @method filterFileName * @param {String} f The filename to normalize * @return {String} The filtered file path */ function filterFileName (f) { return (f || '').replace(/[\/\\]/g, '_'); } exports.filterFileName = filterFileName;   /** * Parses file and line number from an item object and build's an HREF * @method getFoundAt * @param {Object} obj - The item to parse * @param {Object} options - The options * @param {Boolean} options.markdown - If in markdown mode * @param {Boolean} options.nocode - If no code * @return {String} The parsed HREF */ function getFoundAt (obj, options) { var ext = options.markdown ? '.md' : '.html'; var ret = ''; if (obj.file && obj.line && !options.nocode) { if (obj.path) { ret = obj.path + '#l' + obj.line; } else { ret = '../files/' + filterFileName(obj.file) + ext + '#l' + obj.line; } } return ret; } exports.getFoundAt = getFoundAt;   /** * Like `getPages()`, but returns only the files under the `layout/` subdirectory * of the specified _dir_. * * @method getLayouts * @param {String} dir Directory path. * @return {Object} Mapping of layout names to layout content. **/ function getLayouts (dir, useMarkdown) { if (!_.isString(dir)) return {}; return getPages(path.join(dir, 'layouts'), useMarkdown); } exports.getLayouts = getLayouts;   /** * Loads pages (files with a `.handlebars` extension) in the specified directory and * returns an object containing a mapping of page names (the part of the filename) * preceding the `.handlebars` extension) to page content. * * @method getPages * @param {String} dir Directory path. * @return {Object} Mapping of page names to page content. **/ var cache = {}; function getPages (dir, useMarkdown) { if (cache[dir]) { return cache[dir]; } var pages = {}; var stat = fs.statSync(dir); if (!stat.isDirectory()) { return pages; }   _.each( fs.readdirSync(dir), function (name) { var p = path.join(dir, name); var ext = useMarkdown ? '.mdt' : '.handlebars'; if (path.extname(name) === ext && fs.statSync(p).isFile()) { var name = path.basename(name, ext); var text = fs.readFileSync(p, 'utf8'); Object.defineProperty(pages, name, { enumerable: true, get: function () { return text }, set: function () {} }); } } ); cache[dir] = pages; return pages; } exports.getPages = getPages;   /** * Like `getPages()`, but returns only the files under the `partial/` subdirectory * of the specified _dir_. * * @method getPartials * @param {String} dir Directory path. * @return {Object} Mapping of partial names to partial content. **/ function getPartials (dir, useMarkdown) { if (!_.isString(dir)) return {}; return getPages(path.join(dir, 'partials'), useMarkdown); } exports.getPartials = getPartials;   /** * Mix/merge/munge data into the template. * * @method prepare * @param {String} inDir The starting directory * @param {Object} options The `options` for the meta data. * @param {callback} callback The callback to excecute when complete * @param {Error} callback.err * @param {Object} callback.options Merged options. **/ function prepare (inDirs, options, callback) { var layouts, partials, type = 'project'; var defaults = { 'meta': { 'project': options.project, 'component': {} }, 'pages': {}, 'layouts': {}, 'partials': {}, 'viewClass': require('./docview').DocView };   if (options && options.skipLoad) { // Skip loading layouts, metadata, pages, and partials and assume that // the caller has provided them if they want them. options = _.extend(defaults, options); } else { // Gather layouts, metadata, pages, and partials from the specified // input directory, then merge them into the provided options (if any). // // Gathered data will override provided data if there are conflicts, in // order to support a use case where global data are provided by the // caller and overridden by more specific component-level data gathered // from the input directory. // // The metadata inheritance chain looks like this: // // - override metadata specified via CLI (highest precedence) // - component metadata (if this is a component) // - project-level component default metadata (if specified and this is a component) // - theme-level component default metadata (if specified and this is a component) // - project metadata // - theme metadata (lowest precedence) if (inDirs[0] === inDirs[1]) { layouts = getLayouts(inDirs[0], options.markdown); partials = getPartials(inDirs[0], options.markdown); } else { layouts = _.extend( getLayouts(inDirs[0], options.markdown), getLayouts(inDirs[1], options.markdown) ); partials = _.extend( getPartials(inDirs[0], options.markdown), getPartials(inDirs[1], options.markdown) ); } options = _.extend(defaults, options); options = _.extend(options, { 'layouts': layouts, 'partials': partials, }); }   // Set a default asset path if one isn't specified in the metadata. if (!options.meta.component.assets && options.component) { options.meta.component.assets = '../assets/' + options.meta.name; } if (_.isUndefined(options.meta.layout)) { options.meta.layout = options.layouts[type] ? type : 'main'; } if (_.isFunction(callback)) { callback(null, options); } return options; } exports.prepare = prepare;   /** * Takes a type string and converts it to a "First letter upper cased" type. * e.g. `(string -> String, object -> Object)` * * @method fixType * @param {String} t The type string to convert * @return {String} The fixed string */ function fixType (t) { t = safetrim(t); if (t && t.indexOf('.') === -1) { t = t.replace(/{/g, '').replace(/}/g, ''); var firstChar = t.charAt(0), upperFirstChar = firstChar.toUpperCase();   if (firstChar !== upperFirstChar) { return upperFirstChar + t.substring(1); } } return t; }; exports.fixType = fixType;   /** * Produces a normalized web path by joining all the parts and normalizing the * filesystem-like path into web compatible url. * Supports relative and absolute paths. * Courtesy of [Mojito's utils](https://github.com/yahoo/mojito/) * * @method webpath * @param {Array|String*} url the list of parts to be joined and normalized * @return {String} The joined and normalized url **/ function webpath (url) { var args = [].concat.apply([], arguments), parts = path.join.apply(path, args).split(/[\\\/]/); return parts.join('/'); } exports.webpath = webpath;   /** * Localize the string via current Y.options * * @method localize * @param str {String} the original string that you want to input * @param lang {String} the language * @return {String} localized string from the param `str` */ function localize (str, lang) { var splitedStrArr = (str || '').split('!#'); var supportedLang = ['en', 'zh']; return splitedStrArr.map(function(block) { var langFlag = block.slice(0, 2); var selectedLang = supportedLang.indexOf(langFlag); if (selectedLang === -1) { // default language is 'en' return { raw: block, all: true }; } else { return { raw: block.slice(2), lang: supportedLang[selectedLang] }; } }).filter(function(block) { if (!block || !block.raw) { return false; } if (block.all) { return true; } return block.lang === (lang || 'en'); }).map(function(block) { return block.raw.trim(); }).join('\n'); } exports.localize = localize;   /** * convert string to markdown link * * @method markdownLink * @param {String} str - The original string that you want to input * @return {String} marked string from the param `str` */ function markdownLink (str) { return str .replace(/[:,]/g, '-') .replace(/[\s\(\)\[\]=]/g, '') .toLowerCase(); } exports.markdownLink = markdownLink;   /** * build file tree object * * @method buildFileTree * @param {Array} files * @return {Object} */ function buildFileTree (files) { var tree = {}; _.each(files, function (v) { var p = v.name.split('/'); var par; p.forEach(function (i, k) { if (!par) { if (!tree[i]) { tree[i] = {}; } par = tree[i]; } else { if (!par[i]) { par[i] = {}; } if (k + 1 === p.length) { par[i] = { path: v.name, name: filterFileName(v.name) }; } par = par[i]; } }); }); return tree; } exports.buildFileTree = buildFileTree;   /** * Parses the JSON data and formats it into a nice log string for * filename and line number: `/file/name.js:123` * @method stringlog * @private * @param {Object} data The data block from the parser * @return {String} The formatted string. * @for DocParser */ function stringlog(data) { var line, file; if (data.file && data.line) { file = data.file; line = data.line; } else { data.forEach(function (d) { if (d.tag === 'file') { file = d.value; } if (d.tag === 'line') { line = d.value; } }); } return ' ' + file + ':' + line; } exports.stringlog = stringlog;    </pre></td></tr> </table></pre> </div> <div class="footer"> <div class="meta">Generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Jul 02 2015 15:00:46 GMT+0800 (CST)</div> </div> <script src="../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../sorter.js"></script> </body> </html>