Render ES6 javascript template literals contained in a variable

using node.js and recursion

Posted by Andrea Falzetti on October 22, 2016

Challenge

In the current project I’m working on, at Activate, I am using node.js and I have variables coming from a yaml file that contain ES6-like template literals, for example:

messages:
- "Hey, ${user.name}, how are you feeling today?"
- "What's the weather like in ${user.profile.city}?"

and I need to render the variables before sending the message to the client. As you might know, template literals, in order to be rendered need to be wrapped by backtick quotes, for example:

let user = { name: "Andrea" };
const greeting = `Hey, ${user.name}, how are you feeling today?`;
console.log(greeting); // Hey, Andrea, how are you feeling today?

Unfortunately, if the text that contains your template literals come from an external source (for example from an API call that returns a JSON, or from a file like in my case): automatic render will NOT happen and you will end up with ${user.name} as actual text of your string.

Solution: Open source

When I found out that my plan of using ES6 template literals poorely failed , as every good developer would do, I googled for an existing solution to my problem, and … I have found es6-template-render which is basically a simple find & replace with the only problem that it was a really simple find and replace so it won’t support objects like ${user.profile.city} but only strings such as Hello ${name} - which clearly was not enough for me .

Last week I have been to OSCON 2016, an open soure convention organised by the publisher O’Reilly so what is the best thing I could eventually do here to solve my problem?

Of course contributing to the open source community with a pull request !

I have implemented a nice recursive function that finds all the variables and if it finds an object it will iterate through its keys and follow each other object again and again until rendering everything at any level.

Here’s the code, now merged into the main repository, so please have a look at it, if you have any suggestion on how to improve it, or make it more readable, it would be great to hear from you .

function _recursive_rendering(string, context, stack) {
  for (var key in context) {
    if (context.hasOwnProperty(key)) {
      if(typeof context[key] === "object") {
        string = _recursive_rendering(string, context[key], (stack?stack+'.':'')+ key);
      } else {
        var find = '\\$\\{\\s*' + (stack?stack +'.':'') + key + '\\s*\\}';
        var re = new RegExp(find, 'g');
        string = string.replace(re, context[key]);
      }
    }
  }
  return string;
}

Special thanks go to @guillaumevincent and @gabrielperales that have respectively created and made ES5-compatible the original code.

Share this:



comments powered by Disqus