Merge branch 'master' of github.com:mde/ejs

mde · Jun 2, 2019 · cea58ff · cea58ff
2 parents 8a6abe4 + f2c77d7
commit cea58ff
Show file tree

Hide file tree

Showing 9 changed files with 109 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -244,6 +244,8 @@ Most of EJS will work as expected; however, there are a few things to note:
   }); // returns rendered string
   ```
 
+See the [examples folder](https://github.com/mde/ejs/tree/master/examples) for more details.
+
 ### IDE Integration with Syntax Highlighting
 
 VSCode:Javascript EJS by *DigitalBrainstem*

diff --git a/examples/express/README.md b/examples/express/README.md
@@ -0,0 +1,5 @@
+```
+npm install
+npm start
+open http://localhost:3000
+```
diff --git a/examples/express/app.js b/examples/express/app.js
@@ -0,0 +1,27 @@
+var express = require('express');
+var path = require('path');
+var ejs = require('ejs');
+
+var app = express();
+app.set('views', path.join(__dirname, 'views'));
+app.set('view engine', 'ejs');
+
+function compileEjsTemplate(name, template) {
+  const compiledTemplate = ejs.compile(template, {
+    client: true,
+    outputFunctionName: name
+  });
+  return function compileEjsTemplate(req, res, next) {
+    res.locals.compiledEjsTemplates = res.locals.compiledEjsTemplates || {};
+    res.locals.compiledEjsTemplates[name] = compiledTemplate.toString();
+    return next();
+  };
+}
+
+app.use(compileEjsTemplate('helloTemplate', 'Hello <%= include(\'messageTemplate\', { person: \'John\' }); %>'));
+app.use(compileEjsTemplate('messageTemplate', '<%= person %> now you know <%= fact %>.'));
+app.use('/', function(req, res) {
+  return res.render('index', {});
+});
+
+app.listen(process.env.PORT || 3000);
diff --git a/examples/express/package.json b/examples/express/package.json
@@ -0,0 +1,11 @@
+{
+  "description": "client side ejs compiled with express middleware",
+  "main": "app.js",
+  "scripts": {
+    "start": "node ./app.js"
+  },
+  "dependencies": {
+    "ejs": "^2.6.1",
+    "express": "~4.16.0"
+  }
+}
diff --git a/examples/express/views/index.ejs b/examples/express/views/index.ejs
@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>client side ejs compiled with express middleware</title>
+  </head>
+  <body>
+    <div id="greeting"></div>
+    <script>
+      const helloTemplateFn = <%- compiledEjsTemplates.helloTemplate %>;
+      const messageTemplateFn = <%- compiledEjsTemplates.messageTemplate %>;
+
+      (function() {
+        const includeFn = function(path, data) {
+          if (path === 'messageTemplate') {
+            return messageTemplateFn({
+              fact: 'how to render a page with compiled ejs templates',
+              person: data.person
+            });
+          }
+        };
+
+        const html = helloTemplateFn({}, null, includeFn, null);
+        const $greeting = document.getElementById('greeting');
+        $greeting.innerHTML = html;
+      })();
+    </script>
+  </body>
+</html>
diff --git a/lib/ejs.js b/lib/ejs.js
@@ -490,6 +490,12 @@ exports.renderFile = function () {
  * @public
  */
 
+/**
+ * EJS template class
+ * @public
+ */
+exports.Template = Template;
+
 exports.clearCache = function () {
   exports.cache.reset();
 };
@@ -670,9 +676,9 @@ Template.prototype = {
 
     if (opts.rmWhitespace) {
       // Have to use two separate replace here as `^` and `$` operators don't
-      // work well with `\r`.
+      // work well with `\r` and empty lines don't work well with the `m` flag.
       this.templateText =
-        this.templateText.replace(/\r/g, '').replace(/^\s+|\s+$/gm, '');
+        this.templateText.replace(/[\r\n]+/g, '\n').replace(/^\s+|\s+$/gm, '');
     }
 
     // Slurp spaces and tabs before <%_ and after _%>
@@ -776,11 +782,6 @@ Template.prototype = {
       line = line.replace(/^(?:\r\n|\r|\n)/, '');
       this.truncate = false;
     }
-    else if (this.opts.rmWhitespace) {
-      // rmWhitespace has already removed trailing spaces, just need
-      // to remove linebreaks
-      line = line.replace(/^\n/, '');
-    }
     if (!line) {
       return line;
     }

diff --git a/lib/utils.js b/lib/utils.js
@@ -158,6 +158,9 @@ exports.cache = {
   get: function (key) {
     return this._data[key];
   },
+  remove: function (key) {
+    delete this._data[key];
+  },
   reset: function () {
     this._data = {};
   }

diff --git a/test/fixtures/rmWhitespace.ejs b/test/fixtures/rmWhitespace.ejs
@@ -8,7 +8,16 @@ adsffadsfadsfad<%= f %>
 piece of text.
 <% var a = 'a' %>  
 Text again.
+<% var aa = a + 'a' %>
+Raw output:
+<%- aa %>
+Blank
+
+Line
 <% var b = 'b' %>
 <% var c = 'c'
 var d = 'd' %>
-Another text. <%= c %>  
+Another text. <%= c %>
+After escaped
+<% /* newline slurp */ -%>
+Last line

diff --git a/test/fixtures/rmWhitespace.html b/test/fixtures/rmWhitespace.html
@@ -2,7 +2,19 @@
 <tag2>
 A very long piece of text very long piece of text very long piece of
 text very long piece of text very long piece of
-text very long piece oftext very long
-adsffadsfadsfadfpiece of text.
+tex
+t very long piece oftext very long
+adsffadsfadsfadf
+piece of text.
+
 Text again.
-Another text. c
+
+Raw output:
+aa
+Blank
+Line
+
+
+Another text. c
+After escaped
+Last line