styledocco

<!doctype html> <html lang="en"> <head> <title>Code coverage report for src/cli.js</title> <meta charset="utf-8"> <link rel="stylesheet" href="../prettify.css"> <style> body, html { margin:0; padding: 0; } body { font-family: Helvetica Neue, Helvetica,Arial; font-size: 10pt; } div.header, div.footer { background: #eee; padding: 1em; } div.header { z-index: 100; position: fixed; top: 0; border-bottom: 1px solid #666; width: 100%; } div.footer { border-top: 1px solid #666; } div.body { margin-top: 10em; } div.meta { font-size: 90%; text-align: center; } h1, h2, h3 { font-weight: normal; } h1 { font-size: 12pt; } h2 { font-size: 10pt; } pre { font-family: Consolas, Menlo, Monaco, monospace; margin: 0; padding: 0; line-height: 14px; font-size: 14px; -moz-tab-size: 2; -o-tab-size: 2; tab-size: 2; } div.path { font-size: 110%; } div.path a:link, div.path a:visited { color: #000; } table.coverage { border-collapse: collapse; margin:0; padding: 0 } table.coverage td { margin: 0; padding: 0; color: #111; vertical-align: top; } table.coverage td.line-count { width: 50px; text-align: right; padding-right: 5px; } table.coverage td.line-coverage { color: #777 !important; text-align: right; border-left: 1px solid #666; border-right: 1px solid #666; } table.coverage td.text { } table.coverage td span.cline-any { display: inline-block; padding: 0 5px; width: 40px; } table.coverage td span.cline-neutral { background: #eee; } table.coverage td span.cline-yes { background: #b5d592; color: #999; } table.coverage td span.cline-no { background: #fc8c84; } .cstat-yes { color: #111; } .cstat-no { background: #fc8c84; color: #111; } .fstat-no { background: #ffc520; color: #111 !important; } .cbranch-no { background: yellow !important; color: #111; } .cstat-skip { background: #ddd; color: #111; } .fstat-skip { background: #ddd; color: #111 !important; } .cbranch-skip { background: #ddd !important; color: #111; } .missing-if-branch { display: inline-block; margin-right: 10px; position: relative; padding: 0 4px; background: black; color: yellow; } .skip-if-branch { display: none; margin-right: 10px; position: relative; padding: 0 4px; background: #ccc; color: white; } .missing-if-branch .typ, .skip-if-branch .typ { color: inherit !important; } .entity, .metric { font-weight: bold; } .metric { display: inline-block; border: 1px solid #333; padding: 0.3em; background: white; } .metric small { font-size: 80%; font-weight: normal; color: #666; } div.coverage-summary table { border-collapse: collapse; margin: 3em; font-size: 110%; } div.coverage-summary td, div.coverage-summary table th { margin: 0; padding: 0.25em 1em; border-top: 1px solid #666; border-bottom: 1px solid #666; } div.coverage-summary th { text-align: left; border: 1px solid #666; background: #eee; font-weight: normal; } div.coverage-summary th.file { border-right: none !important; } div.coverage-summary th.pic { border-left: none !important; text-align: right; } div.coverage-summary th.pct { border-right: none !important; } div.coverage-summary th.abs { border-left: none !important; text-align: right; } div.coverage-summary td.pct { text-align: right; border-left: 1px solid #666; } div.coverage-summary td.abs { text-align: right; font-size: 90%; color: #444; border-right: 1px solid #666; } div.coverage-summary td.file { text-align: right; border-left: 1px solid #666; white-space: nowrap; } div.coverage-summary td.pic { min-width: 120px !important; } div.coverage-summary a:link { text-decoration: none; color: #000; } div.coverage-summary a:visited { text-decoration: none; color: #333; } div.coverage-summary a:hover { text-decoration: underline; } div.coverage-summary tfoot td { border-top: 1px solid #666; } div.coverage-summary .yui3-datatable-sort-indicator, div.coverage-summary .dummy-sort-indicator { height: 10px; width: 7px; display: inline-block; margin-left: 0.5em; } div.coverage-summary .yui3-datatable-sort-indicator { background: url("http://yui.yahooapis.com/3.6.0/build/datatable-sort/assets/skins/sam/sort-arrow-sprite.png") no-repeat scroll 0 0 transparent; } div.coverage-summary .yui3-datatable-sorted .yui3-datatable-sort-indicator { background-position: 0 -20px; } div.coverage-summary .yui3-datatable-sorted-desc .yui3-datatable-sort-indicator { background-position: 0 -10px; } .high { background: #b5d592 !important; } .medium { background: #ffe87c !important; } .low { background: #fc8c84 !important; } span.cover-fill, span.cover-empty { display:inline-block; border:1px solid #444; background: white; height: 12px; } span.cover-fill { background: #ccc; border-right: 1px solid #444; } span.cover-empty { background: white; border-left: none; } span.cover-full { border-right: none !important; } pre.prettyprint { border: none !important; padding: 0 !important; margin: 0 !important; } .com { color: #999 !important; } .ignore-none { color: #999; font-weight: normal; } </style> </head> <body> <div class="header low"> <h1>Code coverage report for src/cli.js</h1> <h2> Statements: 25% (21 / 84)      Branches: 0% (0 / 22)      Functions: 0% (0 / 21)      Lines: 26.25% (21 / 80)      Ignored: none      </h2> <div class="path"><a href="../index.html">All files</a> » <a href="index.html">src/</a> » cli.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</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  </td><td class="text"><pre class="prettyprint lang-js">// vim: set shiftwidth=2 expandtab: 'use strict';   var async = require('async'); var fs = require('fs'); var marked = require('marked'); var mkdirp = require('mkdirp'); var path = require('path'); var util = require('util');   var helper = require('./helper'); var gather = require('./gather'); var extract = require('./extract'); var styledocco = require('./styledocco'); var version = require('../package').version;   marked.setOptions({ sanitize: false, gfm: true });   // TODO: // Divide code into steps // 1. gather [done] // 2. extract [done] // 3. render   // Helper functions   var dirUp = function(steps) { if ( ! steps) return ''; var str = ''; for (var i = 0; i < steps; ++i) { str += '../'; } return str; }   // Get a filename without the extension var baseFilename = function(str) { return path.basename(str, path.extname(str)).replace(/^_/, ''); };   var basePathname = function(file, basePath) { return path.join( path.dirname(path.relative(basePath, file) || path.basename(basePath)), baseFilename(file) ); };   // Build an HTML file name, named by it's path relative to basePath var htmlFilename = function(file, basePath) { return path.join( path.dirname(path.relative(basePath, file) || path.basename(basePath)), baseFilename(file) + '.html' ).replace(/[\\/]/g, '-'); };   // Make `link` objects for the menu. var menuLinks = function(files, basePath) { return files.map(function(file) { var parts = path.relative(basePath, file).split('/'); parts.pop(); // Remove filename return { name: baseFilename(file), href: htmlFilename(file, basePath), directory: parts[parts.length-1] || './' }; }) .reduce(function(links, link) { if (links[link.directory] != null) { links[link.directory].push(link); } else { links[link.directory] = [ link ]; } return links; }, {}); };   var cli = function(options) {   var errorMessages = { noFiles: 'No css files found' };   var log = options.verbose ? function(str) { console.log(str); } : function() {};   // Custom error also outputing StyleDocco and Node versions. var SDError = function(msg, err) { this.message = msg + '\n' + err.message + '\n' + 'StyleDocco v' + version + ' running on Node ' + process.version + ' ' + process.platform; if (options.verbose) { this.message += '\nOptions: ' + JSON.stringify(options); } }; util.inherits(SDError, Error);   mkdirp(options.out);   // Fetch all static resources. async.parallel(gather(options), function(err, resources) { if (err != null) { if (err.message.indexOf(errorMessages.noFiles) > -1) { console.error(new SDError('Nothing to do.', err).message); return; } else { throw new SDError('Could not process files.', err); } } var menu = menuLinks(resources.files, options.basePath); // Run files through preprocessor and StyleDocco parser. async.map(resources.files, function(file, cb) { async.parallel(extract(options, file), function(err, data) { data.path = file; cb(null, data); }); }, function(err, files) { async.map(files, function(data, cb) { // 2.5 Pre-render if (err != null) return cb(err); styledocco.escapeHtml(data.docs); data.docs = styledocco.makeSections(data.docs); cb(null, data); }, function(err, files) { // 3. Render if (err != null) throw err; // Get the combined CSS from all files. var previewStyles = helper.pluck(files, 'css').join(''); previewStyles += resources.previews.css; // Build a JSON string of all files and their headings, for client side search. var searchIndex = helper.flatten(files.map(function(file) { var arr = [ { title: baseFilename(file.path), filename: basePathname(file.path, options.basePath), url: htmlFilename(file.path, options.basePath) } ]; return arr.concat(file.docs.map(function(section) { return { title: section.title, filename: basePathname(file.path, options.basePath), url: htmlFilename(file.path, options.basePath) + '#' + section.slug }; })); })); searchIndex = 'var searchIndex=' + JSON.stringify(searchIndex) + ';'; var docsScript = '(function(){' + searchIndex + resources.docs.js + '})();'; // Render files var htmlFiles = files.map(function(file) { var relativePath = file.path.split('/'); relativePath.pop(); relativePath = dirUp(options.out.split('/').length) + relativePath.join('/'); return { path: file.path, html: resources.template({ title: baseFilename(file.path), sections: file.docs, project: { name: options.name, menu: menu }, resources: { docs: { js: helper.minjs(docsScript), css: helper.mincss(resources.docs.css) }, previews: { js: helper.minjs(resources.previews.js), css: helper.mincss(helper.urlsRelative(previewStyles, relativePath)) } } }) }; }); // Add readme with "fake" index path. htmlFiles.push({ path: path.join(options.basePath, 'index'), html: resources.template({ title: '', sections: styledocco.makeSections(styledocco.parseDocs([{ docs: resources.readme, code: '' }])), project: { name: options.name, menu: menu }, resources: { docs: { js: helper.minjs(docsScript), css: helper.mincss(resources.docs.css) } } }) }); // Write files to the output dir. htmlFiles.forEach(function(file) { var dest = path.join(options.out, htmlFilename(file.path, options.basePath)); log('styledocco: writing ' + file.path + ' -> ' + dest); fs.writeFileSync(dest, file.html); }); }); }); }); };   module.exports = cli; module.exports.htmlFilename = htmlFilename; module.exports.menuLinks = menuLinks;  </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 Mon Dec 23 2013 20:06:34 GMT+0000 (GMT)</div> </div> <script src="../prettify.js"></script> <script src="http://yui.yahooapis.com/3.6.0/build/yui/yui-min.js"></script> <script> YUI().use('datatable', function (Y) { var formatters = { pct: function (o) { o.className += o.record.get('classes')[o.column.key]; try { return o.value.toFixed(2) + '%'; } catch (ex) { return o.value + '%'; } }, html: function (o) { o.className += o.record.get('classes')[o.column.key]; return o.record.get(o.column.key + '_html'); } }, defaultFormatter = function (o) { o.className += o.record.get('classes')[o.column.key]; return o.value; }; function getColumns(theadNode) { var colNodes = theadNode.all('tr th'), cols = [], col; colNodes.each(function (colNode) { col = { key: colNode.getAttribute('data-col'), label: colNode.get('innerHTML') || ' ', sortable: !colNode.getAttribute('data-nosort'), className: colNode.getAttribute('class'), type: colNode.getAttribute('data-type'), allowHTML: colNode.getAttribute('data-html') === 'true' || colNode.getAttribute('data-fmt') === 'html' }; col.formatter = formatters[colNode.getAttribute('data-fmt')] || defaultFormatter; cols.push(col); }); return cols; } function getRowData(trNode, cols) { var tdNodes = trNode.all('td'), i, row = { classes: {} }, node, name; for (i = 0; i < cols.length; i += 1) { name = cols[i].key; node = tdNodes.item(i); row[name] = node.getAttribute('data-value') || node.get('innerHTML'); row[name + '_html'] = node.get('innerHTML'); row.classes[name] = node.getAttribute('class'); //Y.log('Name: ' + name + '; Value: ' + row[name]); if (cols[i].type === 'number') { row[name] = row[name] * 1; } } //Y.log(row); return row; } function getData(tbodyNode, cols) { var data = []; tbodyNode.all('tr').each(function (trNode) { data.push(getRowData(trNode, cols)); }); return data; } function replaceTable(node) { if (!node) { return; } var cols = getColumns(node.one('thead')), data = getData(node.one('tbody'), cols), table, parent = node.get('parentNode'); table = new Y.DataTable({ columns: cols, data: data, sortBy: 'file' }); parent.set('innerHTML', ''); table.render(parent); } Y.on('domready', function () { replaceTable(Y.one('div.coverage-summary table')); if (typeof prettyPrint === 'function') { prettyPrint(); } }); }); </script> </body> </html>