html-express-js 1.1.0 → 1.1.1

package/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: monthly

package/.github/workflows/dependabot-automerge.yml

@@ -0,0 +1,17 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run format

package/.prettierignore

@@ -1,2 +1,7 @@
 package*.json
-node_modules
+node_modules
+.husky
+LICENSE
+.gitignore
+.npmrc
+.prettierignore

package/.travis.yml

@@ -0,0 +1,8 @@
+language: node_js
+node_js:
+  - '16'
+branches:
+  only:
+    - master
+script:
+  - npm test

package/README.md

@@ -1,3 +1,7 @@
+![build](https://img.shields.io/travis/markcellus/html-express-js)
+![npm](https://img.shields.io/npm/v/html-express-js)
+![node](https://img.shields.io/node/v/html-express-js)
+
 # html-express-js
 
 ## Features

package/jsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "maxNodeModuleJsDepth": 1,
+    "moduleResolution": "nodenext",
+    "module": "es2022",
+    "target": "es2022"
+  }
+}

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "html-express-js",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "An Express template engine to render HTML views using native JavaScript",
   "main": "src/index.js",
   "type": "module",
+  "engines": {
+    "node": ">=16"
+  },
   "scripts": {
     "format": "prettier --write '**/*'",
     "test": "prettier --check '**/*'",
-    "start": "node ./example/server.js"
+    "start": "node ./example/server.js",
+    "prepare": "husky install"
   },
   "repository": {
     "type": "git",
@@ -32,6 +36,7 @@
   "devDependencies": {
     "chokidar": "^3.5.3",
     "express": "^4.18.1",
+    "husky": "^8.0.1",
     "prettier": "^2.7.1",
     "release-it": "^15.0.0",
     "reload": "^3.2.0"

package/src/index.js

@@ -12,7 +12,7 @@ const glob = promisify(g);
  * @param {string} path - The path to html file
  * @param {object} [data]
  * @param {object} [state] - Page-level attributes
- * @returns {string} HTML
+ * @returns {Promise<string>} HTML
  */
 async function renderHtmlFileTemplate(path, data, state) {
   const { view } = await import(path);
@@ -30,7 +30,7 @@ async function renderHtmlFileTemplate(path, data, state) {
  * @param {string} filePath - The path to html file
  * @param {object} data - Data to be made available in view
  * @param {object} instanceOptions - Options passed to original instantiation
- * @returns {string} HTML with includes available (appended to state)
+ * @returns {Promise<string>} HTML with includes available (appended to state)
  */
 async function renderHtmlFile(filePath, data = {}, instanceOptions = {}) {
   const state = {
@@ -74,9 +74,9 @@ export function html(strings, ...data) {
  * @param {object} options.viewsDir - The directory that houses any potential index files
  * @param {string} [options.notFoundView] - The path of a file relative to the views
  *    directory that should be served as 404 when no matching index page exists. Defaults to `404/index`.
- * @returns {function} - Middleware function
+ * @returns {import('express').RequestHandler} - Middleware function
  */
-export function staticIndexHandler(options = {}) {
+export function staticIndexHandler(options) {
   const notFoundView = options.notFoundView || `404/index`;
 
   return async function (req, res, next) {
@@ -105,7 +105,7 @@ export function staticIndexHandler(options = {}) {
  *
  * @param {object} [opts]
  * @param {object} [opts.includesDir]
- * @returns {Function}
+ * @returns {(path: string, options: object, callback: (e: any, rendered?: string) => void) => void}
  */
 export default function (opts = {}) {
   return async (filePath, data, callback) => {