bashprompt
Version:
A bash prompt framework in node.js
183 lines (142 loc) • 6.47 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: theme/template.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: theme/template.js</h1>
<section>
<article>
<pre class="prettyprint source"><code>//
// BEGIN LICENSE BLOCK
//
// The MIT License (MIT)
//
// Copyright (c) 2014 Raül Pérez
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
// END LICENSE BLOCK
//
var colorize = require('./../colorize');
/**
* @namespace bashprompt.theme.template
*/
var template = {};
/**
* Default template opening tag.
*
* @type {string}
*/
template.DEFAULT_OPEN_TAG = '{{';
/**
* Default template closing tag.
*
* @type {string}
*/
template.DEFAULT_CLOSE_TAG = '}}';
/**
* Compiles a template source string binding context context into it.
*
* @param source {string} - Template source string
* @param context {object} - JSON object with template context context.
* @param open_tag {string} - Token opening tag.
* @param close_tag {string} - Token closing tag.
*/
template.compile = function (source, context) {
'use strict';
var isUndefinedOrNull = (typeof source === 'undefined' ||
typeof source === null);
// Returns blank string if template source is undefined or null.
if (isUndefinedOrNull) { return ''; }
var open = template.DEFAULT_OPEN_TAG.replace(/[-[\]()*\s]/g, '\\$&').replace(/\$/g, '\\$');
var close = template.DEFAULT_CLOSE_TAG.replace(/[-[\]()*\s]/g, '\\$&').replace(/\$/g, '\\$');
var r = new RegExp(open + '(.+?)' + close, 'g');
var matches = source.match(r) || [];
var res = source;
matches.forEach(function (match) {
// get the expression
var expr = match.substring(template.DEFAULT_OPEN_TAG.length, match.length - template.DEFAULT_CLOSE_TAG.length);
// parse expression
var expr_key = expr.split(':')[0];
var expr_args = expr.split(':')[1];
var expr_value = context[expr_key];
// check expression
if (typeof expr_value !== 'undefined') {
// check args
var expr_arg_fg, expr_arg_bg;
if (typeof expr_args !== 'undefined') {
// arguments list
var list = expr_args.split(',');
// foreground
if (typeof list[0] !== 'undefined') {
expr_arg_fg = list[0];
}
// background
if (typeof list[1] !== 'undefined') {
expr_arg_bg = list[1];
}
}
// execute expression
if (expr_arg_fg && expr_arg_bg) {
expr_value = colorize.format(expr_value, expr_arg_fg, expr_arg_bg);
}
// TODO
// Support for change only foreground or only background?
// If so... I can get the 'previous' color?
res = res.replace(match, expr_value);
}
});
return res;
};
/**
* Renders a template binding context values to source.
*
* @param prompt
* @param callback
*/
template.render = function (prompt) {
'use strict';
var res = '\\[' + prompt + '\\]';
return res;
};
/** @module bashprompt/theme/template */
module.exports = template;</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-bashprompt.html">bashprompt</a></li><li><a href="cli.html">bashprompt/cli</a></li><li><a href="colorize.html">bashprompt/colorize</a></li><li><a href="context.html">bashprompt/context</a></li><li><a href="cwd.html">bashprompt/partials/cwd</a></li><li><a href="git.html">bashprompt/partials/git</a></li><li><a href="hostname.html">bashprompt/partials/hostname</a></li><li><a href="shell.html">bashprompt/partials/shell</a></li><li><a href="user.html">bashprompt/partials/user</a></li><li><a href="theme.html">bashprompt/theme</a></li><li><a href="template.html">bashprompt/theme/template</a></li></ul><h3>Namespaces</h3><ul><li><a href="bashprompt.html">bashprompt</a></li><li><a href="bashprompt.cli.html">cli</a></li><li><a href="bashprompt.colorize.html">colorize</a></li><li><a href="bashprompt.context.html">context</a></li><li><a href="bashprompt.partials.html">partials</a></li><li><a href="bashprompt.partials.cwd.html">cwd</a></li><li><a href="bashprompt.partials.git.html">git</a></li><li><a href="bashprompt.partials.hostname.html">hostname</a></li><li><a href="bashprompt.partials.shell.html">shell</a></li><li><a href="bashprompt.partials.user.html">user</a></li><li><a href="bashprompt.theme.html">theme</a></li><li><a href="bashprompt.theme.template.html">template</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Sun Feb 23 2014 18:54:28 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>