express-hbs 2.4.2 → 3.0.0

package/lib/hbs.js

@@ -10,12 +10,12 @@ var _ = require('lodash');
 /**
  * Regex pattern for layout directive. {{!< layout }}
  */
-var layoutPattern = /{{!<\s+([A-Za-z0-9\._\-\/]+)\s*}}/;
+var layoutPattern = /{{!<\s+([A-Za-z0-9._\-/]+)\s*}}/;
 
 /**
  * Constructor
  */
-var ExpressHbs = function() {
+var ExpressHbs = function () {
   this.handlebars = handlebars.create();
   this.SafeString = this.handlebars.SafeString;
   this.Utils = this.handlebars.Utils;
@@ -33,7 +33,7 @@ var ExpressHbs = function() {
  * <link rel="stylesheet" href='{{{URL "css/style.css"}}}' />
  * {{/contentFor}}
  */
-ExpressHbs.prototype.content = function(name, options, context) {
+ExpressHbs.prototype.content = function (name, options, context) {
   var block = options.data.root.blockCache[name] || (options.data.root.blockCache[name] = []);
   block.push(options.fn(context));
 };
@@ -46,9 +46,8 @@ ExpressHbs.prototype.content = function(name, options, context) {
  * @param {String} filename Path to template file.
  * @param {String} layout Layout path.
  */
-ExpressHbs.prototype.layoutPath = function(filename, layout) {
-  var dirs,
-    layoutPath;
+ExpressHbs.prototype.layoutPath = function (filename, layout) {
+  var dirs, layoutPath;
   if (layout[0] === '.') {
     dirs = path.dirname(filename);
   } else if (this.layoutsDir) {
@@ -71,7 +70,7 @@ ExpressHbs.prototype.layoutPath = function(filename, layout) {
  * @param {String} filename Path to template
  * @returns {String|undefined} Returns the path to layout.
  */
-ExpressHbs.prototype.declaredLayoutFile = function(str, filename) {
+ExpressHbs.prototype.declaredLayoutFile = function (str, filename) {
   var matches = str.match(layoutPattern);
   if (matches) {
     var layout = matches[1];
@@ -96,9 +95,18 @@ ExpressHbs.prototype.declaredLayoutFile = function(str, filename) {
  * @param {Boolean}     useCache    Cache the compiled layout?
  * @param {Function}    cb          Callback called with layouts stack
  */
-ExpressHbs.prototype.cacheLayout = function(layoutFile, useCache, cb) {
+ExpressHbs.prototype.cacheLayout = function (layoutFile, useCache, cb) {
   var self = this;
 
+  if (this.restrictLayoutsTo) {
+    if (!layoutFile.startsWith(this.restrictLayoutsTo)) {
+      var err = new Error(
+        'Cannot read ' + layoutFile + ' it does not reside in ' + this.restrictLayoutsTo,
+      );
+      return cb(err, null);
+    }
+  }
+
   // assume hbs extension
   if (path.extname(layoutFile) === '') layoutFile += this._options.extname;
 
@@ -106,14 +114,14 @@ ExpressHbs.prototype.cacheLayout = function(layoutFile, useCache, cb) {
   var layoutTemplates = this.cache[layoutFile];
   if (layoutTemplates) return cb(null, layoutTemplates);
 
-  fs.readFile(layoutFile, 'utf8', function(err, str) {
+  fs.readFile(layoutFile, 'utf8', function (err, str) {
     if (err) return cb(err);
 
     //  File path of eventual declared parent layout
     var parentLayoutFile = self.declaredLayoutFile(str, layoutFile);
 
     // This function returns the current layout stack to the caller
-    var _returnLayouts = function(layouts) {
+    var _returnLayouts = function (layouts) {
       var currentLayout;
       layouts = layouts.slice(0);
       currentLayout = self.compile(str, layoutFile);
@@ -126,7 +134,7 @@ ExpressHbs.prototype.cacheLayout = function(layoutFile, useCache, cb) {
 
     if (parentLayoutFile) {
       // Recursively compile/cache parent layouts
-      self.cacheLayout(parentLayoutFile, useCache, function(err, parentLayouts) {
+      self.cacheLayout(parentLayoutFile, useCache, function (err, parentLayouts) {
         if (err) return cb(err);
         _returnLayouts(parentLayouts);
       });
@@ -140,7 +148,7 @@ ExpressHbs.prototype.cacheLayout = function(layoutFile, useCache, cb) {
 /**
  * Cache partial templates found under directories configure in partialsDir.
  */
-ExpressHbs.prototype.cachePartials = function(cb) {
+ExpressHbs.prototype.cachePartials = function (cb) {
   var self = this;
 
   if (!(this.partialsDir instanceof Array)) {
@@ -151,36 +159,36 @@ ExpressHbs.prototype.cachePartials = function(cb) {
   var count = 0;
 
   function readNext() {
-    readdirp(self.partialsDir[count], {fileFilter: '*' + self._options.extname})
-    .on('warn', function(err) {
-      console.warn('Non-fatal error in express-hbs cachePartials.', err);
-    })
-    .on('error', function(err) {
-      console.error('Fatal error in express-hbs cachePartials', err);
-      return cb(err);
-    })
-    .on('data', function(entry) {
-      if (!entry) return;
-      var source = fs.readFileSync(entry.fullPath, 'utf8');
-      var dirname = path.dirname(entry.path);
-      dirname = dirname === '.' ? '' : dirname + '/';
-
-      var name = dirname + path.basename(entry.basename, self._options.extname);
-      // fix the path in windows
-      name = name.split('\\').join('/');
-      self.registerPartial(name, source, entry.fullPath);
-    })
-    .on('end', function() {
-      count += 1;
-
-      // If all directories aren't read, read the next directory
-      if (count < self.partialsDir.length) {
-        readNext();
-      } else {
-        self.isPartialCachingComplete = true;
-        if (cb) cb(null, true);
-      }
-    });
+    readdirp(self.partialsDir[count], { fileFilter: '*' + self._options.extname })
+      .on('warn', function (err) {
+        console.warn('Non-fatal error in express-hbs cachePartials.', err);
+      })
+      .on('error', function (err) {
+        console.error('Fatal error in express-hbs cachePartials', err);
+        return cb(err);
+      })
+      .on('data', function (entry) {
+        if (!entry) return;
+        var source = fs.readFileSync(entry.fullPath, 'utf8');
+        var dirname = path.dirname(entry.path);
+        dirname = dirname === '.' ? '' : dirname + '/';
+
+        var name = dirname + path.basename(entry.basename, self._options.extname);
+        // fix the path in windows
+        name = name.split('\\').join('/');
+        self.registerPartial(name, source, entry.fullPath);
+      })
+      .on('end', function () {
+        count += 1;
+
+        // If all directories aren't read, read the next directory
+        if (count < self.partialsDir.length) {
+          readNext();
+        } else {
+          self.isPartialCachingComplete = true;
+          if (cb) cb(null, true);
+        }
+      });
   }
 
   readNext();
@@ -203,7 +211,7 @@ ExpressHbs.prototype.cachePartials = function(cb) {
  *   }
  * }
  */
-ExpressHbs.prototype.express3 = function(options) {
+ExpressHbs.prototype.express3 = function (options) {
   var self = this;
 
   // Set defaults
@@ -220,31 +228,31 @@ ExpressHbs.prototype.express3 = function(options) {
 
   if (options.i18n) {
     var i18n = options.i18n;
-    this.handlebars.registerHelper('__', function() {
+    this.handlebars.registerHelper('__', function () {
       var args = Array.prototype.slice.call(arguments);
       var options = args.pop();
       return i18n.__.apply(options.data.root, args);
     });
-    this.handlebars.registerHelper('__n', function() {
+    this.handlebars.registerHelper('__n', function () {
       var args = Array.prototype.slice.call(arguments);
       var options = args.pop();
       return i18n.__n.apply(options.data.root, args);
     });
   }
 
-  this.handlebars.registerHelper(this._options.blockHelperName, function(name, options) {
+  this.handlebars.registerHelper(this._options.blockHelperName, function (name, options) {
     var val = options.data.root.blockCache[name];
     if (val === undefined && typeof options.fn === 'function') {
       val = options.fn(this);
     }
     if (Array.isArray(val)) {
-      val = val.join('\n'); 
+      val = val.join('\n');
     }
     return val;
   });
 
   // Pass 'this' as context of helper function to don't lose context call of helpers.
-  this.handlebars.registerHelper(this._options.contentHelperName, function(name, options) {
+  this.handlebars.registerHelper(this._options.contentHelperName, function (name, options) {
     return self.content(name, options, this);
   });
 
@@ -254,6 +262,8 @@ ExpressHbs.prototype.express3 = function(options) {
   // Absolute path to the layouts directory
   this.layoutsDir = this._options.layoutsDir;
 
+  this.restrictLayoutsTo = this._options.restrictLayoutsTo;
+
   // express passes this through ___express func, gulp pass in an option
   this.viewsDir = null;
   this.viewsDirOpt = this._options.viewsDir;
@@ -291,12 +301,12 @@ ExpressHbs.prototype.express4 = ExpressHbs.prototype.express3;
  *
  * @param {Boolean} useCache Whether to cache.
  */
-ExpressHbs.prototype.loadDefaultLayout = function(useCache, cb) {
+ExpressHbs.prototype.loadDefaultLayout = function (useCache, cb) {
   var self = this;
   if (!this._options.defaultLayout) return cb();
   if (useCache && this.defaultLayoutTemplates) return cb(null, this.defaultLayoutTemplates);
 
-  this.cacheLayout(this._options.defaultLayout, useCache, function(err, templates) {
+  this.cacheLayout(this._options.defaultLayout, useCache, function (err, templates) {
     if (err) return cb(err);
     self.defaultLayoutTemplates = templates.slice(0);
     return cb(null, templates);
@@ -306,7 +316,7 @@ ExpressHbs.prototype.loadDefaultLayout = function(useCache, cb) {
 /**
  * Expose useful methods.
  */
-ExpressHbs.prototype.registerHelper = function(name, fn) {
+ExpressHbs.prototype.registerHelper = function (name, fn) {
   this.handlebars.registerHelper(name, fn);
 };
 
@@ -316,7 +326,7 @@ ExpressHbs.prototype.registerHelper = function(name, fn) {
  * @param {String} name The name of the partial as used in a template.
  * @param {String} source String source of the partial.
  */
-ExpressHbs.prototype.registerPartial = function(name, source, filename) {
+ExpressHbs.prototype.registerPartial = function (name, source, filename) {
   this.handlebars.registerPartial(name, this.compile(source, filename));
 };
 
@@ -326,7 +336,7 @@ ExpressHbs.prototype.registerPartial = function(name, source, filename) {
  * @param {String} source The source to compile.
  * @param {String} filename The path used to embed into __filename for errors.
  */
-ExpressHbs.prototype.compile = function(source, filename) {
+ExpressHbs.prototype.compile = function (source, filename) {
   // Handlebars has a bug with comment only partial causes errors. This must
   // be a string so the block below can add a space.
   if (typeof source !== 'string') {
@@ -359,53 +369,46 @@ ExpressHbs.prototype.compile = function(source, filename) {
  * @param {String} name The name of the partial as used in a template.
  * @param {String} fn The `function(options, cb)`
  */
-ExpressHbs.prototype.registerAsyncHelper = function(name, fn) {
-  this.handlebars.registerHelper(name, function(context, options) {
-    var resolverCache = this.resolverCache ||
+ExpressHbs.prototype.registerAsyncHelper = function (name, fn) {
+  this.handlebars.registerHelper(name, function (context, options) {
+    var resolverCache =
+      this.resolverCache ||
       _.get(context, 'data.root.resolverCache') ||
       _.get(options, 'data.root.resolverCache');
     if (!resolverCache) {
       throw new Error('Could not find resolver cache in async helper ' + name + '.');
     }
     if (options && fn.length > 2) {
-      var resolveFunc = function(arr, cb) {
+      var resolveFunc = function (arr, cb) {
         return fn.call(this, arr[0], arr[1], cb);
       };
 
-      return resolver.resolve(
-        resolverCache,
-        resolveFunc.bind(this),
-        [context, options]
-      );
+      return resolver.resolve(resolverCache, resolveFunc.bind(this), [context, options]);
     }
-    return resolver.resolve(
-      resolverCache,
-      fn.bind(this),
-      context
-    );
+    return resolver.resolve(resolverCache, fn.bind(this), context);
   });
 };
 
-ExpressHbs.prototype.getTemplateOptions = function() {
+ExpressHbs.prototype.getTemplateOptions = function () {
   return this._options.templateOptions;
 };
 
-ExpressHbs.prototype.updateTemplateOptions = function(templateOptions) {
+ExpressHbs.prototype.updateTemplateOptions = function (templateOptions) {
   this._options.templateOptions = templateOptions;
 };
 
-ExpressHbs.prototype.getLocalTemplateOptions = function(locals) {
+ExpressHbs.prototype.getLocalTemplateOptions = function (locals) {
   return locals._templateOptions || {};
 };
 
-ExpressHbs.prototype.updateLocalTemplateOptions = function(locals, localTemplateOptions) {
-  return locals._templateOptions = localTemplateOptions;
+ExpressHbs.prototype.updateLocalTemplateOptions = function (locals, localTemplateOptions) {
+  return (locals._templateOptions = localTemplateOptions);
 };
 
 /**
  * Creates a new instance of ExpressHbs.
  */
-ExpressHbs.prototype.create = function() {
+ExpressHbs.prototype.create = function () {
   return new ExpressHbs();
 };
 
@@ -499,7 +502,6 @@ ExpressHbs.prototype.___express = function ___express(filename, source, options,
     cb(null, res);
   }
 
-
   /**
    * Renders `template` with an optional set of nested `layoutTemplates` using
    * data in `locals`.
@@ -511,7 +513,7 @@ ExpressHbs.prototype.___express = function ___express(filename, source, options,
     // being passed the rendered string of the previous ones as `body`
     var i = layoutTemplates.length - 1;
 
-    var _stackRenderer = function(err, htmlStr) {
+    var _stackRenderer = function (err, htmlStr) {
       if (err) return cb(err);
 
       if (i >= 0) {
@@ -526,7 +528,6 @@ ExpressHbs.prototype.___express = function ___express(filename, source, options,
     renderTemplate(template, locals, _stackRenderer);
   }
 
-
   /**
    * Lazy loads js-beautify, which should not be used in production env.
    */
@@ -552,14 +553,14 @@ ExpressHbs.prototype.___express = function ___express(filename, source, options,
       }
     }
 
-    fs.readFile(filename, 'utf8', function(err, source) {
+    fs.readFile(filename, 'utf8', function (err, source) {
       if (err) return cb(err);
 
       var template = self.compile(source, filename);
       if (options.cache) {
         self.cache[filename] = {
           source: source,
-          template: template
+          template: template,
         };
       }
       return cb(null, source, template);
@@ -570,16 +571,16 @@ ExpressHbs.prototype.___express = function ___express(filename, source, options,
    * Compiles a file into a template and a layoutTemplate, then renders it above.
    */
   function compileFile(locals, cb) {
-    getSourceTemplate(function(err, source, template) {
+    getSourceTemplate(function (err, source, template) {
       if (err) return cb(err);
 
       // Try to get the layout
-      parseLayout(source, filename, function(err, layoutTemplates) {
+      parseLayout(source, filename, function (err, layoutTemplates) {
         if (err) return cb(err);
 
         function renderIt(layoutTemplates) {
           if (self._options.beautify) {
-            return render(template, locals, layoutTemplates, function(err, html) {
+            return render(template, locals, layoutTemplates, function (err, html) {
               if (err) return cb(err);
               loadBeautify();
               return cb(null, self.beautify(html, self.beautifyrc));
@@ -599,7 +600,7 @@ ExpressHbs.prototype.___express = function ___express(filename, source, options,
         } else if (typeof options.layout !== 'undefined' && options.layout) {
           // 2. Layout specified by options from render
           var layoutFile = self.layoutPath(filename, options.layout);
-          self.cacheLayout(layoutFile, options.cache, function(err, layoutTemplates) {
+          self.cacheLayout(layoutFile, options.cache, function (err, layoutTemplates) {
             if (err) return cb(err);
             renderIt(layoutTemplates);
           });
@@ -616,11 +617,11 @@ ExpressHbs.prototype.___express = function ___express(filename, source, options,
 
   function replaceValue(values, text) {
     if (typeof text === 'string') {
-      Object.keys(values).forEach(function(id) {
-        text = text.replace(id, function() {
+      Object.keys(values).forEach(function (id) {
+        text = text.replace(id, function () {
           return values[id];
         });
-        text = text.replace(self.Utils.escapeExpression(id), function() {
+        text = text.replace(self.Utils.escapeExpression(id), function () {
           return self.Utils.escapeExpression(values[id]);
         });
       });
@@ -631,9 +632,9 @@ ExpressHbs.prototype.___express = function ___express(filename, source, options,
   // Handles waiting for async helpers
   function handleAsync(err, res) {
     if (err) return cb(err);
-    resolver.done(options.resolverCache, function(err, values) {
+    resolver.done(options.resolverCache, function (err, values) {
       if (err) return cb(err);
-      Object.keys(values).forEach(function(key) {
+      Object.keys(values).forEach(function (key) {
         values[key] = replaceValue(values, values[key]);
       });
       res = replaceValue(values, res);
@@ -645,13 +646,13 @@ ExpressHbs.prototype.___express = function ___express(filename, source, options,
   }
 
   // kick it off by loading default template (if any)
-  this.loadDefaultLayout(options.cache, function(err) {
+  this.loadDefaultLayout(options.cache, function (err) {
     if (err) return cb(err);
 
     // Force reloading of all partials if caching is not used. Inefficient but there
     // is no loading partial event.
     if (self.partialsDir && (!options.cache || !self.isPartialCachingComplete)) {
-      return self.cachePartials(function(err) {
+      return self.cachePartials(function (err) {
         if (err) return cb(err);
         return compileFile(options, handleAsync);
       });

package/lib/resolver.js

@@ -14,9 +14,9 @@ var ID_SUFFIX = '__';
 
 function resolve(cache, fn, context) {
   var id = ID_PREFIX + ID_ESCAPED_STRING + generateId(ID_LENGTH) + ID_SUFFIX;
-  cache[id] = new Promise(function(passed, failed) {
+  cache[id] = new Promise(function (passed, failed) {
     try {
-      fn(context, function(res) {
+      fn(context, function (res) {
         passed(res);
       });
     } catch (error) {
@@ -29,23 +29,24 @@ function resolve(cache, fn, context) {
 // cache is an object where the keys are cache keys and values are promises. See above.
 function done(cache, callback) {
   return Promise.all(Object.values(cache))
-    .then(function(values) {
+    .then(function (values) {
       var resolvedCache = {};
       var keys = Object.keys(cache);
-      values.forEach(function(value, index) {
+      values.forEach(function (value, index) {
         resolvedCache[keys[index]] = value;
       });
       callback(null, resolvedCache);
-  }).catch(function(error) {
-    callback(error);
-  });
+    })
+    .catch(function (error) {
+      callback(error);
+    });
 }
 
 function hasResolvers(text) {
   // NOTE: We specifically search the text for the ID_PREFIX **NOT** including the escapable character
   // This is because that character can be escaped in the text, and lead us to not finding unresolved
   // async helper outputs.
-  if (text.search(ID_PREFIX) > 0) {
+  if (text.search(ID_PREFIX) >= 0) {
     return true;
   }
   return false;
@@ -54,5 +55,5 @@ function hasResolvers(text) {
 module.exports = {
   done: done,
   hasResolvers: hasResolvers,
-  resolve: resolve
+  resolve: resolve,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-hbs",
-  "version": "2.4.2",
+  "version": "3.0.0",
   "description": "Express handlebars template engine complete with multiple layouts, partials and blocks.",
   "keywords": [
     "express4",
@@ -10,17 +10,12 @@
     "partials"
   ],
   "main": "index.js",
+  "engines": {
+    "node": ">=20"
+  },
   "directories": {
     "example": "example"
   },
-  "scripts": {
-    "lint": "eslint --ext .js --cache lib/**",
-    "test": "mocha",
-    "posttest": "yarn lint",
-    "coverage": "nyc yarn test",
-    "preship": "yarn test",
-    "ship": "STATUS=$(git status --porcelain); echo $STATUS; if [ -z \"$STATUS\" ]; then yarn publish && git push --follow-tags; fi"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/TryGhost/express-hbs"
@@ -29,21 +24,33 @@
   "author": "Mario Gutierrez <mario@barc.com>",
   "license": "MIT",
   "devDependencies": {
-    "cookie-parser": "1.4.6",
-    "eslint": "8.48.0",
-    "express": "4.18.2",
-    "i18n": "0.15.1",
-    "mocha": "10.2.0",
-    "nyc": "15.1.0",
-    "rewire": "7.0.0",
-    "supertest": "6.3.3"
+    "cookie-parser": "1.4.7",
+    "express": "5.2.1",
+    "i18n": "0.15.3",
+    "mocha": "11.7.6",
+    "nyc": "18.0.0",
+    "oxfmt": "0.57.0",
+    "oxlint": "1.72.0",
+    "rewire": "9.0.1",
+    "supertest": "7.2.2"
   },
   "dependencies": {
-    "handlebars": "^4.7.7",
-    "lodash": "^4.17.21",
-    "readdirp": "^3.6.0"
+    "@tryghost/pro-ship": "1.1.5",
+    "handlebars": "4.7.9",
+    "lodash": "4.18.1",
+    "readdirp": "3.6.0"
   },
   "optionalDependencies": {
-    "js-beautify": "^1.13.11"
+    "js-beautify": "^2.0.0"
+  },
+  "scripts": {
+    "lint": "oxlint --quiet && oxfmt --check .",
+    "lint:fix": "oxlint --fix && oxfmt .",
+    "format": "oxfmt .",
+    "test": "mocha",
+    "posttest": "pnpm lint",
+    "coverage": "nyc --check-coverage mocha",
+    "preship": "pnpm test",
+    "ship": "pro-ship"
   }
-}
+}

package/renovate.json

@@ -1,6 +1,13 @@
 {
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
-    "@tryghost:quietJS",
-    "@tryghost:automergeDevDependencies"
+    "local>TryGhost/renovate-config"
+  ],
+  "packageRules": [
+    {
+      "description": "Keep pnpm on 10.x while this repo supports Node 20; pnpm 11 requires Node 22.13 or newer.",
+      "matchPackageNames": ["pnpm"],
+      "allowedVersions": "<11"
+    }
   ]
 }