express-hbs 2.5.0 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-hbs",
-  "version": "2.5.0",
+  "version": "4.0.0",
   "description": "Express handlebars template engine complete with multiple layouts, partials and blocks.",
   "keywords": [
     "express4",
@@ -10,17 +10,16 @@
     "partials"
   ],
   "main": "index.js",
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
   "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 +28,33 @@
   "author": "Mario Gutierrez <mario@barc.com>",
   "license": "MIT",
   "devDependencies": {
-    "cookie-parser": "1.4.6",
-    "eslint": "8.54.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"
+    "@tryghost/pro-ship": "2.0.1",
+    "cookie-parser": "1.4.7",
+    "express": "5.3.0",
+    "i18n": "0.15.4",
+    "mocha": "12.0.3",
+    "nyc": "18.0.0",
+    "oxfmt": "0.76.0",
+    "oxlint": "1.91.0",
+    "rewire": "9.0.1",
+    "supertest": "7.3.2"
   },
   "dependencies": {
-    "handlebars": "^4.7.7",
-    "lodash": "^4.17.21",
+    "handlebars": "^4.7.10",
+    "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/.editorconfig

@@ -1,8 +0,0 @@
-; indicate this is the root of the project
-
-[*]
-indent_style = space
-end_of_line = lf
-
-[*.js]
-indent_size = 2

package/.eslintrc

@@ -1,42 +0,0 @@
-{
-  "env": {
-    "node": true
-  },
-
-  "globals": {
-    "describe": true,
-    "beforeEach": true,
-    "it": true
-  },
-
-  "rules": {
-    "brace-style": [1, "1tbs"],
-    "curly": [0, "multi"],
-    "eqeqeq": [1, "smart"],
-    "max-depth": [1, 4],
-    "max-params": [1, 5],
-    "new-cap": 2,
-    "new-parens": 0,
-    "no-constant-condition": 0,
-    "no-div-regex": 1,
-    "no-else-return": 1,
-    "no-extra-parens": 1,
-    "no-floating-decimal": 2,
-    "no-inner-declarations": 2,
-    "no-lonely-if": 1,
-    "no-multi-str": 0,
-    "no-nested-ternary": 2,
-    "no-new-object": 0,
-    "no-new-func": 0,
-    "no-shadow": 0,
-    "no-underscore-dangle": 0,
-    "no-unused-vars": 2,
-    "quotes": [2, "single", "avoid-escape"],
-    "radix": 2,
-    "keyword-spacing": "error",
-    "object-curly-spacing": ["error", "never"],
-    "array-bracket-spacing": ["error", "never"],
-    "strict": 2,
-    "wrap-iife": 2
-  }
-}

package/.github/workflows/test.yml

@@ -1,24 +0,0 @@
-name: Test
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-      - 'renovate/*'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    if: github.event_name == 'push' || (github.event_name == 'pull_request' && !startsWith(github.head_ref, 'renovate/'))
-    strategy:
-      matrix:
-        node: [ 14, 16, 18 ]
-    name: Node ${{ matrix.node }}
-    steps:
-      - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node }}
-      - run: yarn
-      - run: yarn lint
-      - run: yarn test

package/.jsbeautifyrc

@@ -1,17 +0,0 @@
-{
-    "indent_size": 2,
-    "indent_char": " ",
-    "indent_level": 0,
-    "indent_with_tabs": false,
-    "preserve_newlines": true,
-    "max_preserve_newlines": 10,
-    "jslint_happy": false,
-    "brace_style": "collapse",
-    "keep_array_indentation": false,
-    "keep_function_indentation": false,
-    "space_before_conditional": true,
-    "break_chained_methods": false,
-    "eval_code": false,
-    "unescape_strings": false,
-    "wrap_line_length": 0
-}

package/SECURITY.md

@@ -1,9 +0,0 @@
-# Reporting Security Vulnerabilities
-
-Potential security vulnerabilities can be reported directly us at `security@ghost.org`. The Ghost Security Team communicates privately and works in a secured, isolated repository for tracking, testing, and resolving security-related issues.
-
-The full, up-to-date details of our security policy and procedure can always be found in our documentation:
-
-https://ghost.org/docs/security/
-
-Please refer to this before emailing us. Thanks for helping make Ghost safe for everyone 🙏.

package/example/app-layoutsDir.js

@@ -1,106 +0,0 @@
-// npm install express express-hbs
-
-'use strict';
-
-var express = require('express');
-var app = express();
-var hbs = require('..'); // should be `require('express-hbs')` outside of this example
-var fs = require('fs');
-var fp = require('path');
-
-function relative(path) {
-  return fp.join(__dirname, path);
-}
-var viewsDir = relative('views');
-
-app.use(express.static(relative('public')));
-
-// Hook in express-hbs and tell it where known directories reside
-app.engine('hbs', hbs.express4({
-  partialsDir: [relative('views/partials'), relative('views/partials-other')],
-  layoutsDir: relative('views/layout'),
-  defaultLayout: relative('views/layout/default.hbs'),
-  restrictLayoutsTo: relative('views/layout')
-}));
-app.set('view engine', 'hbs');
-app.set('views', relative('views'));
-
-
-// Register sync helper
-hbs.registerHelper('link', function(text, options) {
-  var attrs = [];
-  for (var prop in options.hash) {
-    attrs.push(prop + '="' + options.hash[prop] + '"');
-  }
-  return new hbs.SafeString('<a ' + attrs.join(' ') + '>' + text + '</a>');
-});
-
-// Register Async helpers
-hbs.registerAsyncHelper('readFile', function(filename, cb) {
-  fs.readFile(fp.join(viewsDir, filename), 'utf8', function(err, content) {
-    if (err) console.error(err);
-    cb(new hbs.SafeString(content));
-  });
-});
-
-var fruits = [
-  {name: 'apple'},
-  {name: 'orange'},
-  {name: 'pear'}
-];
-
-
-var veggies = [
-  {name: 'asparagus'},
-  {name: 'carrot'},
-  {name: 'spinach'}
-];
-
-app.get('/', function(req, res) {
-  res.render('index', {
-    title: 'express-hbs example'
-  });
-});
-
-app.get('/fruits', function(req, res) {
-  res.render('fruits/index-layoutsDir', {
-    title: 'My favorite fruits',
-    fruits: fruits
-  });
-});
-
-app.get('/fruits/:name', function(req, res) {
-    res.render('fruits/details-layoutsDir', {
-        fruit: req.params.name
-    });
-});
-
-app.get('/veggies', function(req, res) {
-  res.render('veggies', {
-    title: 'My favorite veggies',
-    veggies: veggies,
-    layout: 'veggie'
-  });
-});
-
-app.get('/veggies/explicit-dir', function(req, res) {
-  res.render('veggies', {
-    title: 'My favorite veggies',
-    veggies: veggies,
-    layout: relative('views/layout/veggie')
-  });
-});
-
-app.get('/veggies/:name', function(req, res) {
-    res.render('veggies/details', {
-        veggie: req.params.name,
-        layout: 'veggie-details'
-    });
-});
-
-if (require.main === module) {
-  app.listen(3000);
-  console.log('Express server listening on port 3000');
-} else {
-  module.exports = app;
-}

package/example/app.js

@@ -1,110 +0,0 @@
-'use strict';
-// npm install express express-hbs
-
-function create(hbs, env) {
-  if (env) process.env.NODE_ENV = env;
-
-  var express = require('express');
-  var app = express();
-  var fs = require('fs');
-  var fp = require('path');
-
-  function relative(path) {
-    return fp.join(__dirname, path);
-  }
-
-  var viewsDir = relative('views');
-
-  app.use(express.static(relative('public')));
-
-  // Hook in express-hbs and tell it where known directories reside
-  app.engine('hbs', hbs.express4({
-    partialsDir: [relative('views/partials'), relative('views/partials-other')],
-    defaultLayout: relative('views/layout/default.hbs'),
-    restrictLayoutsTo: viewsDir
-  }));
-  app.set('view engine', 'hbs');
-  app.set('views', viewsDir);
-
-  // Register sync helper
-  hbs.registerHelper('link', function(text, options) {
-    var attrs = [];
-    for (var prop in options.hash) {
-      attrs.push(prop + '="' + options.hash[prop] + '"');
-    }
-    return new hbs.SafeString(
-      '<a ' + attrs.join(' ') + '>' + text + '</a>'
-    );
-  });
-
-  // Register Async helpers
-  hbs.registerAsyncHelper('readFile', function(filename, cb) {
-    fs.readFile(fp.join(viewsDir, filename), 'utf8', function(err, content) {
-      if (err) console.error(err);
-      cb(new hbs.SafeString(content));
-    });
-  });
-
-  var fruits = [
-    {name: 'apple'},
-    {name: 'orange'},
-    {name: 'pear'}
-  ];
-
-  var veggies = [
-    {name: 'asparagus'},
-    {name: 'carrot'},
-    {name: 'spinach'}
-  ];
-
-  app.get('/', function(req, res) {
-    res.render('index', {
-      title: 'express-hbs example'
-    });
-  });
-
-  app.get('/replace', function(req, res) {
-    res.render('replace', {
-      title: 'express-hbs example'
-    });
-  });
-
-  app.get('/fruits', function(req, res) {
-    res.render('fruits/index', {
-      title: 'My favorite fruits',
-      fruits: fruits
-    });
-  });
-
-  app.get('/fruits/:name', function(req, res) {
-    res.render('fruits/details', {
-      fruit: req.params.name
-    });
-  });
-
-  app.get('/veggies', function(req, res) {
-    res.render('veggies', {
-      title: 'My favorite veggies',
-      veggies: veggies,
-      layout: 'layout/veggie'
-    });
-  });
-
-  app.get('/veggies/:name', function(req, res) {
-    res.render('veggies/details', {
-      veggie: req.params.name,
-      layout: 'layout/veggie-details'
-    });
-  });
-
-  return app;
-}
-
-if (require.main === module) {
-  var hbs = require('..');
-  var app = create(hbs);
-  app.listen(3000);
-  console.log('Express server listening on port 3000');
-} else {
-  exports.create = create;
-}

package/example/public/css/style.css

@@ -1,17 +0,0 @@
-* {
-  font-family: Georgia, serif;
-}
-
-h1, h2 {
-  font-family: Helvetica, Arial, sans;
-}
-
-.veggie-details {
-    border: 5px solid green;
-    padding: 10px;
-}
-
-.fruit-details {
-    border: 5px solid red;
-    padding: 10px;
-}

package/example/views/fruits/details-layoutsDir.hbs

@@ -1,3 +0,0 @@
-{{!< fruit-details}}
-
-{{fruit}}

package/example/views/fruits/details.hbs

@@ -1,4 +0,0 @@
-{{!< ../layout/fruit-details}}
-
-{{fruit}}
-

package/example/views/fruits/index-layoutsDir.hbs

@@ -1,20 +0,0 @@
-<!-- name of layout -->
-{{!< fruits}}
-
-{{#contentFor 'pageStyles'}}
-<style>
-  li a {
-    color: #800;
-  }
-</style>
-{{/contentFor}}
-
-
-<h1>{{title}}</h1>
-<ul>
-    {{#each fruits}}
-      <li>
-        <a href="/fruits/{{this.name}}">{{this.name}}</a>
-      </li>
-    {{/each}}
-</ul>

package/example/views/fruits/index.hbs

@@ -1,20 +0,0 @@
-<!-- name of layout -->
-{{!< ../layout/fruits}}
-
-{{#contentFor 'pageStyles'}}
-<style>
-  li a {
-    color: #800;
-  }
-</style>
-{{/contentFor}}
-
-
-<h1>{{title}}</h1>
-<ul>
-    {{#each fruits}}
-    <li>
-      <a href="/fruits/{{this.name}}">{{this.name}}</a>
-    </li>
-    {{/each}}
-</ul>

package/example/views/index.hbs

@@ -1,34 +0,0 @@
-{{#contentFor 'pageStyles'}}
-<style>
-  .clicker {
-    color: blue;
-  };
-</style>
-{{/contentFor}}
-
-
-{{#contentFor 'pageScripts'}}
-<script>
-  $(function() {
-    $('.clicker').click(function() {
-      $(this).text('Hello express-hbs!');
-    });
-  });
-</script>
-{{/contentFor}}
-
-
-<h1>{{title}}</h1>
-<p class='clicker'>Click me!</p>
-<p>
-  <a href='/fruits'>Favorite fruits</a>
-</p>
-<p>
-  <!-- sync helper -->
-  {{{link 'Vegetables' href='/veggies'}}}
-</p>
-
-<!-- async helper -->
-<div>
-{{{readFile 'tos.txt'}}}
-</div>

package/example/views/layout/default.hbs

@@ -1,13 +0,0 @@
-{{!< html-struct}}
-
-<h2>DEFAULT LAYOUT</h2>
-
-{{#block 'default-block'}}
-  Default block content
-{{/block}}
-
-{{#block 'replaced-default-block'}}
-  Default block content
-{{/block}}
-
-{{{body}}}

package/example/views/layout/fruit-details.hbs

@@ -1,9 +0,0 @@
-{{!< fruits}}
-
-<h3>NESTED LAYOUT</h3>
-
-<p>This is one of my favorite fruits!</p>
-
-<span class="fruit-details">
-  {{{body}}}
-</span>

package/example/views/layout/fruits.hbs

@@ -1,6 +0,0 @@
-{{!< html-struct}}
-
-<h2>DECLARATIVE LAYOUT</h2>
-
-<!-- Placeholder for page content. -->
-{{{body}}}

package/example/views/layout/html-struct.hbs

@@ -1,21 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>{{title}}</title>
-    <link type="text/css" rel="stylesheet" href="/css/style.css"/>
-    {{{block "pageStyles"}}}
-  </head>
-
-  <body>
-
-    <!-- Placeholder for page content. -->
-    {{{body}}}
-
-    <!-- Partials are common snippets to be used 1 or more pages. -->
-    {{> scripts}}
-    {{> other}}
-
-    <!-- A block is placeholder for pieces of content defined in a page. -->
-    {{{block 'pageScripts'}}}
-  </body>
-</html>

package/example/views/layout/veggie-details.hbs

@@ -1,9 +0,0 @@
-{{!< veggie}}
-
-<h3>NESTED LAYOUT</h3>
-
-<p>This is one of my favorite veggies!</p>
-
-<span class="veggie-details">
-  {{{body}}}
-</span>

package/example/views/layout/veggie.hbs

@@ -1,6 +0,0 @@
-{{!< html-struct}}
-
-<h2>PROGRAMMATIC LAYOUT</h2>
-
-<!-- Placeholder for page content. -->
-{{{body}}}

package/example/views/partials/scripts.hbs

@@ -1,5 +0,0 @@
-{{#if production}}
-   <script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>
-{{else}}
-   <script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.js"></script>
-{{/if}}

package/example/views/partials/sub/comment.hbs

@@ -1 +0,0 @@
-<!-- just a comment -->

package/example/views/partials-other/other.hbs

@@ -1 +0,0 @@
-<!-- Other partial -->

package/example/views/replace.hbs

@@ -1,6 +0,0 @@
-{{#contentFor 'replaced-default-block'}}
-    Non-default block content
-{{/contentFor}}
-
-
-<h1>{{title}}</h1>

package/example/views/tos.txt

@@ -1,3 +0,0 @@
-<h4>Terms of Service</h4>
-
-<div>Async result!</div>

package/example/views/veggies/details.hbs

@@ -1 +0,0 @@
-{{veggie}}

package/example/views/veggies.hbs

@@ -1,17 +0,0 @@
-{{#contentFor 'pageStyles'}}
-<style>
-  li a {
-    color: #800;
-  }
-</style>
-{{/contentFor}}
-
-{{> sub/comment}}
-<h1>{{title}}</h1>
-<ul>
-    {{#each veggies}}
-      <li>
-        <a href="/veggies/{{this.name}}">{{this.name}}</a>
-      </li>
-    {{/each}}
-</ul>

package/renovate.json

@@ -1,6 +0,0 @@
-{
-  "extends": [
-    "@tryghost:quietJS",
-    "@tryghost:automergeDevDependencies"
-  ]
-}