www.aleph1.co.uk Git - yaffs-website/blob - node_modules/sass-graph/node_modules/lodash/template.js

   1 var assignInWith = require('./assignInWith'),
   2     attempt = require('./attempt'),
   3     baseValues = require('./_baseValues'),
   4     customDefaultsAssignIn = require('./_customDefaultsAssignIn'),
   5     escapeStringChar = require('./_escapeStringChar'),
   6     isError = require('./isError'),
   7     isIterateeCall = require('./_isIterateeCall'),
   8     keys = require('./keys'),
   9     reInterpolate = require('./_reInterpolate'),
  10     templateSettings = require('./templateSettings'),
  11     toString = require('./toString');
  12
  13 /** Used to match empty string literals in compiled template source. */
  14 var reEmptyStringLeading = /\b__p \+= '';/g,
  15     reEmptyStringMiddle = /\b(__p \+=) '' \+/g,
  16     reEmptyStringTrailing = /(__e\(.*?\)|\b__t\)) \+\n'';/g;
  17
  18 /**
  19  * Used to match
  20  * [ES template delimiters](http://ecma-international.org/ecma-262/7.0/#sec-template-literal-lexical-components).
  21  */
  22 var reEsTemplate = /\$\{([^\\}]*(?:\\.[^\\}]*)*)\}/g;
  23
  24 /** Used to ensure capturing order of template delimiters. */
  25 var reNoMatch = /($^)/;
  26
  27 /** Used to match unescaped characters in compiled string literals. */
  28 var reUnescapedString = /['\n\r\u2028\u2029\\]/g;
  29
  30 /**
  31  * Creates a compiled template function that can interpolate data properties
  32  * in "interpolate" delimiters, HTML-escape interpolated data properties in
  33  * "escape" delimiters, and execute JavaScript in "evaluate" delimiters. Data
  34  * properties may be accessed as free variables in the template. If a setting
  35  * object is given, it takes precedence over `_.templateSettings` values.
  36  *
  37  * **Note:** In the development build `_.template` utilizes
  38  * [sourceURLs](http://www.html5rocks.com/en/tutorials/developertools/sourcemaps/#toc-sourceurl)
  39  * for easier debugging.
  40  *
  41  * For more information on precompiling templates see
  42  * [lodash's custom builds documentation](https://lodash.com/custom-builds).
  43  *
  44  * For more information on Chrome extension sandboxes see
  45  * [Chrome's extensions documentation](https://developer.chrome.com/extensions/sandboxingEval).
  46  *
  47  * @static
  48  * @since 0.1.0
  49  * @memberOf _
  50  * @category String
  51  * @param {string} [string=''] The template string.
  52  * @param {Object} [options={}] The options object.
  53  * @param {RegExp} [options.escape=_.templateSettings.escape]
  54  *  The HTML "escape" delimiter.
  55  * @param {RegExp} [options.evaluate=_.templateSettings.evaluate]
  56  *  The "evaluate" delimiter.
  57  * @param {Object} [options.imports=_.templateSettings.imports]
  58  *  An object to import into the template as free variables.
  59  * @param {RegExp} [options.interpolate=_.templateSettings.interpolate]
  60  *  The "interpolate" delimiter.
  61  * @param {string} [options.sourceURL='templateSources[n]']
  62  *  The sourceURL of the compiled template.
  63  * @param {string} [options.variable='obj']
  64  *  The data object variable name.
  65  * @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`.
  66  * @returns {Function} Returns the compiled template function.
  67  * @example
  68  *
  69  * // Use the "interpolate" delimiter to create a compiled template.
  70  * var compiled = _.template('hello <%= user %>!');
  71  * compiled({ 'user': 'fred' });
  72  * // => 'hello fred!'
  73  *
  74  * // Use the HTML "escape" delimiter to escape data property values.
  75  * var compiled = _.template('<b><%- value %></b>');
  76  * compiled({ 'value': '<script>' });
  77  * // => '<b>&lt;script&gt;</b>'
  78  *
  79  * // Use the "evaluate" delimiter to execute JavaScript and generate HTML.
  80  * var compiled = _.template('<% _.forEach(users, function(user) { %><li><%- user %></li><% }); %>');
  81  * compiled({ 'users': ['fred', 'barney'] });
  82  * // => '<li>fred</li><li>barney</li>'
  83  *
  84  * // Use the internal `print` function in "evaluate" delimiters.
  85  * var compiled = _.template('<% print("hello " + user); %>!');
  86  * compiled({ 'user': 'barney' });
  87  * // => 'hello barney!'
  88  *
  89  * // Use the ES template literal delimiter as an "interpolate" delimiter.
  90  * // Disable support by replacing the "interpolate" delimiter.
  91  * var compiled = _.template('hello ${ user }!');
  92  * compiled({ 'user': 'pebbles' });
  93  * // => 'hello pebbles!'
  94  *
  95  * // Use backslashes to treat delimiters as plain text.
  96  * var compiled = _.template('<%= "\\<%- value %\\>" %>');
  97  * compiled({ 'value': 'ignored' });
  98  * // => '<%- value %>'
  99  *
 100  * // Use the `imports` option to import `jQuery` as `jq`.
 101  * var text = '<% jq.each(users, function(user) { %><li><%- user %></li><% }); %>';
 102  * var compiled = _.template(text, { 'imports': { 'jq': jQuery } });
 103  * compiled({ 'users': ['fred', 'barney'] });
 104  * // => '<li>fred</li><li>barney</li>'
 105  *
 106  * // Use the `sourceURL` option to specify a custom sourceURL for the template.
 107  * var compiled = _.template('hello <%= user %>!', { 'sourceURL': '/basic/greeting.jst' });
 108  * compiled(data);
 109  * // => Find the source of "greeting.jst" under the Sources tab or Resources panel of the web inspector.
 110  *
 111  * // Use the `variable` option to ensure a with-statement isn't used in the compiled template.
 112  * var compiled = _.template('hi <%= data.user %>!', { 'variable': 'data' });
 113  * compiled.source;
 114  * // => function(data) {
 115  * //   var __t, __p = '';
 116  * //   __p += 'hi ' + ((__t = ( data.user )) == null ? '' : __t) + '!';
 117  * //   return __p;
 118  * // }
 119  *
 120  * // Use custom template delimiters.
 121  * _.templateSettings.interpolate = /{{([\s\S]+?)}}/g;
 122  * var compiled = _.template('hello {{ user }}!');
 123  * compiled({ 'user': 'mustache' });
 124  * // => 'hello mustache!'
 125  *
 126  * // Use the `source` property to inline compiled templates for meaningful
 127  * // line numbers in error messages and stack traces.
 128  * fs.writeFileSync(path.join(process.cwd(), 'jst.js'), '\
 129  *   var JST = {\
 130  *     "main": ' + _.template(mainText).source + '\
 131  *   };\
 132  * ');
 133  */
 134 function template(string, options, guard) {
 135   // Based on John Resig's `tmpl` implementation
 136   // (http://ejohn.org/blog/javascript-micro-templating/)
 137   // and Laura Doktorova's doT.js (https://github.com/olado/doT).
 138   var settings = templateSettings.imports._.templateSettings || templateSettings;
 139
 140   if (guard && isIterateeCall(string, options, guard)) {
 141     options = undefined;
 142   }
 143   string = toString(string);
 144   options = assignInWith({}, options, settings, customDefaultsAssignIn);
 145
 146   var imports = assignInWith({}, options.imports, settings.imports, customDefaultsAssignIn),
 147       importsKeys = keys(imports),
 148       importsValues = baseValues(imports, importsKeys);
 149
 150   var isEscaping,
 151       isEvaluating,
 152       index = 0,
 153       interpolate = options.interpolate || reNoMatch,
 154       source = "__p += '";
 155
 156   // Compile the regexp to match each delimiter.
 157   var reDelimiters = RegExp(
 158     (options.escape || reNoMatch).source + '|' +
 159     interpolate.source + '|' +
 160     (interpolate === reInterpolate ? reEsTemplate : reNoMatch).source + '|' +
 161     (options.evaluate || reNoMatch).source + '|$'
 162   , 'g');
 163
 164   // Use a sourceURL for easier debugging.
 165   var sourceURL = 'sourceURL' in options ? '//# sourceURL=' + options.sourceURL + '\n' : '';
 166
 167   string.replace(reDelimiters, function(match, escapeValue, interpolateValue, esTemplateValue, evaluateValue, offset) {
 168     interpolateValue || (interpolateValue = esTemplateValue);
 169
 170     // Escape characters that can't be included in string literals.
 171     source += string.slice(index, offset).replace(reUnescapedString, escapeStringChar);
 172
 173     // Replace delimiters with snippets.
 174     if (escapeValue) {
 175       isEscaping = true;
 176       source += "' +\n__e(" + escapeValue + ") +\n'";
 177     }
 178     if (evaluateValue) {
 179       isEvaluating = true;
 180       source += "';\n" + evaluateValue + ";\n__p += '";
 181     }
 182     if (interpolateValue) {
 183       source += "' +\n((__t = (" + interpolateValue + ")) == null ? '' : __t) +\n'";
 184     }
 185     index = offset + match.length;
 186
 187     // The JS engine embedded in Adobe products needs `match` returned in
 188     // order to produce the correct `offset` value.
 189     return match;
 190   });
 191
 192   source += "';\n";
 193
 194   // If `variable` is not specified wrap a with-statement around the generated
 195   // code to add the data object to the top of the scope chain.
 196   var variable = options.variable;
 197   if (!variable) {
 198     source = 'with (obj) {\n' + source + '\n}\n';
 199   }
 200   // Cleanup code by stripping empty strings.
 201   source = (isEvaluating ? source.replace(reEmptyStringLeading, '') : source)
 202     .replace(reEmptyStringMiddle, '$1')
 203     .replace(reEmptyStringTrailing, '$1;');
 204
 205   // Frame code as the function body.
 206   source = 'function(' + (variable || 'obj') + ') {\n' +
 207     (variable
 208       ? ''
 209       : 'obj || (obj = {});\n'
 210     ) +
 211     "var __t, __p = ''" +
 212     (isEscaping
 213        ? ', __e = _.escape'
 214        : ''
 215     ) +
 216     (isEvaluating
 217       ? ', __j = Array.prototype.join;\n' +
 218         "function print() { __p += __j.call(arguments, '') }\n"
 219       : ';\n'
 220     ) +
 221     source +
 222     'return __p\n}';
 223
 224   var result = attempt(function() {
 225     return Function(importsKeys, sourceURL + 'return ' + source)
 226       .apply(undefined, importsValues);
 227   });
 228
 229   // Provide the compiled function's source by its `toString` method or
 230   // the `source` property as a convenience for inlining compiled templates.
 231   result.source = source;
 232   if (isError(result)) {
 233     throw result;
 234   }
 235   return result;
 236 }
 237
 238 module.exports = template;