bb-drummer / node-patternlibrary

lib/adapters/example.js

var fs          = require('fs');
var path        = require('path');
var format      = require('string-template');
var frontMatter = require('front-matter');
var escapeHTML  = require('escape-html');
var multiline   = require('multiline');
var highlightCode = require('../util/highlight-code');

var HTML_EXAMPLE_TEMPLATE = multiline(function() {/*
<div class="docs-code" data-docs-code>
<pre>
<code class="{0}">
{1}
</code>
</pre>
</div>
*/}).replace(/(^(\s)*)/gm, '');

module.exports = function(value, config, cb, pl) {
    var data = getSourceExample (value, config, pl);
    cb(null, processTree(data));
}

module.exports.config = {
    verbose: false
}

module.exports.search = function(items, link) {

The parameter items is not used and could be removed.

The parameter link is not used and could be removed.

    var results = [];
    // this => collider
    /* results.push({
        name: name,
        type: 'sass ' + type,
        description: description,
        link: link + hash
    }); */

    return results;
}


function getSourceExample(value, config, pl) {
    if (!fs.existsSync(value)) return false;

Curly braces around statements make for more readable code and help prevent bugs when you add further statements.

    var patternFile = fs.readFileSync(value).toString();
    var renderedPattern = pl.renderpattern(patternFile, {});
    var renderedCode = highlightCode('html', renderedPattern);
    var output = format(HTML_EXAMPLE_TEMPLATE, ['html', renderedCode]);

    return {
        highlight : output,
        escaped   : escapeHTML(renderedPattern),
        raw       : renderedPattern
    };
}


function processTree(tree) {
    
    // do tree assignment stuff...

    return tree; //my_stuff;
}