@ololoepepe/template-renderer 0.1.41 → 0.1.43

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@ololoepepe/template-renderer",
-  "version": "0.1.41",
+  "version": "0.1.43",
   "description": "Lodash-based template renderer",
-  "main": "index.js",
+  "main": "src/index.js",
+  "imports": {
+    "#src/*.js": "./src/*.js"
+  },
+  "type": "module",
   "scripts": {
     "lint": "eslint ./src",
     "test": "mocha ./test/*"
@@ -10,6 +14,11 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.com"
   },
+  "files": [
+    "src",
+    "package.json",
+    "README.md"
+  ],
   "repository": {
     "type": "git",
     "url": "git+ssh://git@ssh.gitlab.void-walkers.com:1022/libs/node.js/template-renderer.git"
@@ -21,12 +30,12 @@
   },
   "homepage": "https://gitlab.void-walkers.com/libs/node.js/template-renderer#README",
   "devDependencies": {
-    "eslint": "8.34.0",
+    "@ololoepepe/eslint-config": "^0.0.16",
+    "eslint": "8.55.0",
     "eslint-config-xo": "^0.43.1",
     "mocha": "^10.2.0"
   },
   "dependencies": {
-    "fs-extra": "^11.1.0",
-    "lodash.template": "^4.4.0"
+    "lodash.template": "^4.5.0"
   }
 }

package/src/index.js

@@ -0,0 +1,229 @@
+import fs from 'node:fs';
+import {readFile} from 'node:fs/promises';
+
+import lodashTemplate from 'lodash.template';
+
+const RX_INCLUDE = /^(?<before>\s*)#include\s+'(?<include>[^']+)'(?<after>.*)$/u;
+
+async function exists(path) {
+  return await new Promise(resolve => {
+    fs.exists(path, resolve);
+  });
+}
+
+function _forEach(arr, callback) {
+  arr.forEach(callback);
+}
+
+function _renderTemplate(template, templateName, variables) {
+  if (!template) {
+    console.warn(`Template "${templateName}" not found`);
+
+    return null;
+  }
+
+  const obj = {
+    _: {
+      forEach: _forEach
+    },
+    ...variables
+  };
+
+  return template(obj);
+}
+
+export class TemplateRenderer {
+  #templateCache = new Map();
+  #templatesDir = null;
+  #templateSettings = null;
+  #templateStringCache = new Map();
+
+  constructor(templatesDir, templateSettings = {}) {
+    this.#templatesDir = templatesDir;
+    this.#templateCache = new Map();
+    this.#templateStringCache = new Map();
+    this.#templateSettings = templateSettings;
+  }
+
+  async getTemplate(name) {
+    if (this.#templateCache.has(name)) {
+      return this.#templateCache.get(name);
+    }
+
+    const templateString = await this.#getTemplateStringRecursive(name);
+
+    return this.#getTemplate(name, templateString);
+  }
+
+  getTemplateSync(name) {
+    if (this.#templateCache.has(name)) {
+      return this.#templateCache.get(name);
+    }
+
+    const templateString = this.#getTemplateStringRecursiveSync(name);
+
+    return this.#getTemplate(name, templateString);
+  }
+
+  async loadTemplate(name, text) {
+    if (this.#templateCache.has(name)) {
+      console.warn(`Template renderer: template "${name}" already exists, overriding it`);
+    }
+
+    const templateString = await this.#getTemplateStringRecursiveInternal(text);
+
+    this.#getTemplate(name, templateString);
+  }
+
+  loadTemplateSync(name, text) {
+    if (this.#templateCache.has(name)) {
+      console.warn(`Template renderer: template "${name}" already exists, overriding it`);
+    }
+
+    const templateString = this.#getTemplateStringRecursiveInternalSync(text);
+
+    this.#getTemplate(name, templateString);
+  }
+
+  preloadSync(extension) {
+    this.#templateStringCache.clear();
+    this.#templateCache.clear();
+
+    this.#preloadRecursiveSync(extension);
+  }
+
+  async renderTemplate(templateName, variables) {
+    let template = null;
+
+    if (typeof templateName === 'string') {
+      template = await this.getTemplate(templateName);
+    } else if (typeof templateName === 'function') {
+      template = templateName;
+    }
+
+    return _renderTemplate(template, templateName, variables);
+  }
+
+  renderTemplateSync(templateName, variables) {
+    let template = null;
+
+    if (typeof templateName === 'string') {
+      template = this.getTemplateSync(templateName);
+    } else if (typeof templateName === 'function') {
+      template = templateName;
+    }
+
+    return _renderTemplate(template, templateName, variables);
+  }
+
+  #getTemplate(name, templateString) {
+    if (!templateString) {
+      return null;
+    }
+
+    const template = lodashTemplate(templateString, this.#templateSettings);
+
+    this.#templateCache.set(name, template);
+
+    return template;
+  }
+
+  async #getTemplateStringRecursive(name) {
+    const templatePath = `${this.#templatesDir}/${name}`;
+
+    if (this.#templateStringCache.has(templatePath)) {
+      return this.#templateStringCache.get(templatePath);
+    }
+
+    const templateExists = await exists(templatePath);
+
+    if (!templateExists) {
+      return null;
+    }
+
+    const templateString = await readFile(templatePath, 'utf8');
+
+    const result = await this.#getTemplateStringRecursiveInternal(templateString);
+
+    this.#templateStringCache.set(templatePath, result);
+
+    return result;
+  }
+
+  async #getTemplateStringRecursiveInternal(templateString) {
+    const lines = templateString.split('\n');
+
+    for (let i = 0; i < lines.length; ++i) {
+      const line = lines[i];
+
+      const m = line.match(RX_INCLUDE);
+
+      if (m) {
+        const {after, before, include} = m.groups;
+
+        // eslint-disable-next-line no-await-in-loop
+        const part = await this.#getTemplateStringRecursive(include);
+
+        lines[i] = `${before}${part}${after}`;
+      }
+    }
+
+    return lines.join('\n');
+  }
+
+  #getTemplateStringRecursiveInternalSync(templateString) {
+    const lines = templateString.split('\n');
+
+    for (let i = 0; i < lines.length; ++i) {
+      const line = lines[i];
+
+      const m = line.match(RX_INCLUDE);
+
+      if (m) {
+        const {after, before, include} = m.groups;
+
+        const part = this.#getTemplateStringRecursiveSync(include);
+
+        lines[i] = `${before}${part}${after}`;
+      }
+    }
+
+    return lines.join('\n');
+  }
+
+  #getTemplateStringRecursiveSync(name) {
+    const templatePath = `${this.#templatesDir}/${name}`;
+
+    if (this.#templateStringCache.has(templatePath)) {
+      return this.#templateStringCache.get(templatePath);
+    }
+
+    const templateExists = fs.existsSync(templatePath);
+
+    if (!templateExists) {
+      return null;
+    }
+
+    const templateString = fs.readFileSync(templatePath, 'utf8');
+
+    const result = this.#getTemplateStringRecursiveInternalSync(templateString);
+
+    this.#templateStringCache.set(templatePath, result);
+
+    return result;
+  }
+
+  #preloadRecursiveSync(extension, prefix = '') {
+    const path = `${this.#templatesDir}${prefix ? `/${prefix}` : ''}`;
+
+    const entries = fs.readdirSync(path);
+
+    entries.filter(entryName => entryName.endsWith(extension) && fs.statSync(`${path}/${entryName}`).isFile())
+      .forEach(fileName => this.getTemplateSync(`${prefix ? `${prefix}/` : ''}${fileName}`));
+
+    entries.filter(entryName => fs.statSync(`${path}/${entryName}`).isDirectory())
+      .forEach(dirName => this.#preloadRecursiveSync(extension, `${prefix ? `${prefix}/` : ''}${dirName}`));
+  }
+}
+
+export default TemplateRenderer;

package/index.js

@@ -1 +0,0 @@
-module.exports = require('./src/template-renderer');

package/src/template-renderer.js

@@ -1,217 +0,0 @@
-const fs = require('fs');
-const {exists, readFile} = require('fs-extra');
-const _ = {
-  template: require('lodash.template')
-};
-
-const RX_INCLUDE = /^(\s*)#include\s+'([^']+)'(.*)$/;
-
-function _forEach(arr, callback) {
-  arr.forEach(callback);
-}
-
-function _renderTemplate(template, templateName, variables) {
-  if (!template) {
-    console.warn(`Template "${templateName}" not found`);
-
-    return null;
-  }
-
-  const obj = {
-    _: {
-      forEach: _forEach
-    },
-    ...variables
-  };
-
-  return template(obj);
-}
-
-class TemplateRenderer {
-  constructor(templatesDir, templateSettings = {}) {
-    this.templatesDir = templatesDir;
-    this._templateCache = new Map();
-    this._templateStringCache = new Map();
-    this._templateSettings = templateSettings;
-  }
-
-  async _getTemplateStringRecursiveInternal(templateString) {
-    const lines = templateString.split('\n');
-
-    for (let i = 0; i < lines.length; ++i) {
-      const line = lines[i];
-
-      const m = line.match(RX_INCLUDE);
-
-      if (m) {
-        // eslint-disable-next-line no-await-in-loop
-        const part = await this._getTemplateStringRecursive(m[2]);
-
-        lines[i] = `${m[1]}${part}${m[3]}`;
-      }
-    }
-
-    return lines.join('\n');
-  }
-
-  async _getTemplateStringRecursive(name) {
-    const templatePath = `${this.templatesDir}/${name}`;
-
-    if (this._templateStringCache.has(templatePath)) {
-      return this._templateStringCache.get(templatePath);
-    }
-
-    const templateExists = await exists(templatePath);
-
-    if (!templateExists) {
-      return null;
-    }
-
-    const templateString = await readFile(templatePath, 'utf8');
-
-    const result = await this._getTemplateStringRecursiveInternal(templateString);
-
-    this._templateStringCache.set(templatePath, result);
-
-    return result;
-  }
-
-  _getTemplateStringRecursiveInternalSync(templateString) {
-    const lines = templateString.split('\n');
-
-    for (let i = 0; i < lines.length; ++i) {
-      const line = lines[i];
-
-      const m = line.match(RX_INCLUDE);
-
-      if (m) {
-        const part = this._getTemplateStringRecursiveSync(m[2]);
-
-        lines[i] = `${m[1]}${part}${m[3]}`;
-      }
-    }
-
-    return lines.join('\n');
-  }
-
-  _getTemplateStringRecursiveSync(name) {
-    const templatePath = `${this.templatesDir}/${name}`;
-
-    if (this._templateStringCache.has(templatePath)) {
-      return this._templateStringCache.get(templatePath);
-    }
-
-    const templateExists = fs.existsSync(templatePath);
-
-    if (!templateExists) {
-      return null;
-    }
-
-    const templateString = fs.readFileSync(templatePath, 'utf8');
-
-    const result = this._getTemplateStringRecursiveInternalSync(templateString);
-
-    this._templateStringCache.set(templatePath, result);
-
-    return result;
-  }
-
-  _getTemplate(name, templateString) {
-    if (!templateString) {
-      return null;
-    }
-
-    const template = _.template(templateString, this._templateSettings);
-
-    this._templateCache.set(name, template);
-
-    return template;
-  }
-
-  _preloadRecursiveSync(extension, prefix = '') {
-    const path = `${this.templatesDir}${prefix ? `/${prefix}` : ''}`;
-
-    const entries = fs.readdirSync(path);
-
-    entries.filter(entryName => entryName.endsWith(extension) && fs.statSync(`${path}/${entryName}`).isFile())
-      .forEach(fileName => this.getTemplateSync(`${prefix ? `${prefix}/` : ''}${fileName}`));
-
-    entries.filter(entryName => fs.statSync(`${path}/${entryName}`).isDirectory())
-      .forEach(dirName => this._preloadRecursiveSync(extension, `${prefix ? `${prefix}/` : ''}${dirName}`));
-  }
-
-  async getTemplate(name) {
-    if (this._templateCache.has(name)) {
-      return this._templateCache.get(name);
-    }
-
-    const templateString = await this._getTemplateStringRecursive(name);
-
-    return this._getTemplate(name, templateString);
-  }
-
-  getTemplateSync(name) {
-    if (this._templateCache.has(name)) {
-      return this._templateCache.get(name);
-    }
-
-    const templateString = this._getTemplateStringRecursiveSync(name);
-
-    return this._getTemplate(name, templateString);
-  }
-
-  async loadTemplate(name, text) {
-    if (this._templateCache.has(name)) {
-      console.warn(`Template renderer: template "${name}" already exists, overriding it`);
-    }
-
-    const templateString = await this._getTemplateStringRecursiveInternal(text);
-
-    this._getTemplate(name, templateString);
-  }
-
-  loadTemplateSync(name, text) {
-    if (this._templateCache.has(name)) {
-      console.warn(`Template renderer: template "${name}" already exists, overriding it`);
-    }
-
-    const templateString = this._getTemplateStringRecursiveInternalSync(text);
-
-    this._getTemplate(name, templateString);
-  }
-
-  preloadSync(extension) {
-    this._templateStringCache.clear();
-    this._templateCache.clear();
-
-    this._preloadRecursiveSync(extension);
-  }
-
-  async renderTemplate(templateName, variables) {
-    let template = null;
-
-    if (typeof templateName === 'string') {
-      template = await this.getTemplate(templateName);
-    } else if (typeof templateName === 'function') {
-      template = templateName;
-    }
-
-    return _renderTemplate(template, templateName, variables);
-  }
-
-  renderTemplateSync(templateName, variables) {
-    let template = null;
-
-    if (typeof templateName === 'string') {
-      template = this.getTemplateSync(templateName);
-    } else if (typeof templateName === 'function') {
-      template = templateName;
-    }
-
-    return _renderTemplate(template, templateName, variables);
-  }
-}
-
-module.exports = {
-  TemplateRenderer
-};