necessary 15.0.6 → 15.0.8

package/README.md

@@ -395,7 +395,7 @@ const filePath = "/etc/var/public/name.html",
       args = {
         name,
         age
-      }
+      },
       parsedContent = parseFile(filePath, args);
 ```
 
@@ -404,8 +404,8 @@ const filePath = "/etc/var/public/name.html",
 ```
 const content = `
 
-  name: <strong>${name}</strong><br/>
-  age: <strong>${age}</strong><br/>
+  name: <strong>\${name}</strong><br/>
+  age: <strong>\${age}</strong><br/>
 
       `,
       name = "Joe Bloggs",
@@ -413,10 +413,33 @@ const content = `
       args = {
         name,
         age
-      }
+      },
       parsedContent = parseContent(content, args);
 ```
 
+Note that the dollar signs are escaped here. 
+Alternatively you can dispense with them altogether and pass in a different regular expression:
+
+```
+const content = `
+
+  name: <strong>{name}</strong><br/>
+  age: <strong>{age}</strong><br/>
+
+      `,
+      name = "Joe Bloggs",
+      age = 99,
+      args = {
+        name,
+        age
+      },
+      regularExpression = /{(.+?)}/g,
+      parsedContent = parseContent(content, args, regularExpression);
+```
+
+You can of course choose any token format you like if you provide the requisite regular expression to match it.
+The `parseLine()` and `parseFile()` functions also behave in this way.
+
 * The `parseLine()` function takes a single line of content as the first argument:
 
 ```
@@ -426,7 +449,7 @@ const line = "${name}, aged ${age}.",
       args = {
         name,
         age
-      }
+      },
       parsedLine = parseLine(line, args); // returns 'Joe Bloggs, aged 99.'
 ```
 

package/lib/utilities/template.js

@@ -24,17 +24,21 @@ _export(exports, {
 });
 var _fileSystem = require("../utilities/fileSystem");
 var _constants = require("../constants");
-function parseFile(filePath, args, regex) {
-    var content = (0, _fileSystem.readFile)(filePath), parsedContent = parseContent(content, args, regex);
+var _characters = require("../characters");
+var defaultRegularExpression = /\${(.+?)}/g;
+function parseFile(filePath, args) {
+    var regularExpression = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : defaultRegularExpression;
+    var content = (0, _fileSystem.readFile)(filePath), parsedContent = parseContent(content, args, regularExpression);
     return parsedContent;
 }
-function parseContent(content, args, regex) {
-    var lines = content.split("\n"), parsedLines = parseLines(lines, args, regex), parsedContent = parsedLines.join("\n");
+function parseContent(content, args) {
+    var regularExpression = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : defaultRegularExpression;
+    var lines = content.split(_characters.NEW_LINE_CHARACTER), parsedLines = parseLines(lines, args, regularExpression), parsedContent = parsedLines.join(_characters.NEW_LINE_CHARACTER);
     return parsedContent;
 }
 function parseLine(line, args) {
-    var regex = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : /\${(.+?)}/g;
-    var parsedLine = line.replace(regex, function(match, token) {
+    var regularExpression = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : defaultRegularExpression;
+    var parsedLine = line.replace(regularExpression, function(match, token) {
         var parsedToken = parseToken(token, args);
         return parsedToken;
     });
@@ -45,9 +49,9 @@ var _default = {
     parseContent: parseContent,
     parseLine: parseLine
 };
-function parseLines(lines, args, regex) {
+function parseLines(lines, args, regularExpression) {
     var parsedLines = lines.map(function(line) {
-        var parsedLine = parseLine(line, args, regex);
+        var parsedLine = parseLine(line, args, regularExpression);
         return parsedLine;
     });
     return parsedLines;
@@ -60,4 +64,4 @@ function parseToken(token, args) {
     return parsedToken;
 }
 
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91dGlsaXRpZXMvdGVtcGxhdGUuanMiXSwic291cmNlc0NvbnRlbnQiOlsiXCJ1c2Ugc3RyaWN0XCI7XG5cbmltcG9ydCB7IHJlYWRGaWxlIH0gZnJvbSBcIi4uL3V0aWxpdGllcy9maWxlU3lzdGVtXCI7XG5pbXBvcnQgeyBFTVBUWV9TVFJJTkcgfSBmcm9tIFwiLi4vY29uc3RhbnRzXCI7XG5cbmV4cG9ydCBmdW5jdGlvbiBwYXJzZUZpbGUoZmlsZVBhdGgsIGFyZ3MsIHJlZ2V4KSB7XG4gIGNvbnN0IGNvbnRlbnQgPSByZWFkRmlsZShmaWxlUGF0aCksXG4gICAgICAgIHBhcnNlZENvbnRlbnQgPSBwYXJzZUNvbnRlbnQoY29udGVudCwgYXJncywgcmVnZXgpO1xuXG4gIHJldHVybiBwYXJzZWRDb250ZW50O1xufVxuXG5leHBvcnQgZnVuY3Rpb24gcGFyc2VDb250ZW50KGNvbnRlbnQsIGFyZ3MsIHJlZ2V4KSB7XG4gIGNvbnN0IGxpbmVzID0gY29udGVudC5zcGxpdChcIlxcblwiKSxcbiAgICAgICAgcGFyc2VkTGluZXMgPSBwYXJzZUxpbmVzKGxpbmVzLCBhcmdzLCByZWdleCksXG4gICAgICAgIHBhcnNlZENvbnRlbnQgPSBwYXJzZWRMaW5lcy5qb2luKFwiXFxuXCIpO1xuXG4gIHJldHVybiBwYXJzZWRDb250ZW50O1xufVxuXG5leHBvcnQgZnVuY3Rpb24gcGFyc2VMaW5lKGxpbmUsIGFyZ3MsIHJlZ2V4ID0gL1xcJHsoLis/KX0vZykge1xuICBjb25zdCBwYXJzZWRMaW5lID0gbGluZS5yZXBsYWNlKHJlZ2V4LCAobWF0Y2gsIHRva2VuKSA9PiB7XG4gICAgY29uc3QgcGFyc2VkVG9rZW4gPSBwYXJzZVRva2VuKHRva2VuLCBhcmdzKTtcblxuICAgIHJldHVybiBwYXJzZWRUb2tlbjtcbiAgfSk7XG5cbiAgcmV0dXJuIHBhcnNlZExpbmU7XG59XG5cbmV4cG9ydCBkZWZhdWx0IHtcbiAgcGFyc2VGaWxlLFxuICBwYXJzZUNvbnRlbnQsXG4gIHBhcnNlTGluZVxufTtcblxuZnVuY3Rpb24gcGFyc2VMaW5lcyhsaW5lcywgYXJncywgcmVnZXgpIHtcbiAgY29uc3QgcGFyc2VkTGluZXMgPSBsaW5lcy5tYXAoKGxpbmUpID0+IHtcbiAgICBjb25zdCBwYXJzZWRMaW5lID0gcGFyc2VMaW5lKGxpbmUsIGFyZ3MsIHJlZ2V4KTtcblxuICAgIHJldHVybiBwYXJzZWRMaW5lO1xuICB9KTtcblxuICByZXR1cm4gcGFyc2VkTGluZXM7XG59XG5cbmZ1bmN0aW9uIHBhcnNlVG9rZW4odG9rZW4sIGFyZ3MpIHtcbiAgbGV0IHBhcnNlZFRva2VuID0gRU1QVFlfU1RSSU5HO1xuXG4gIGlmIChhcmdzLmhhc093blByb3BlcnR5KHRva2VuKSkge1xuICAgIHBhcnNlZFRva2VuID0gYXJnc1t0b2tlbl07XG4gIH1cblxuICByZXR1cm4gcGFyc2VkVG9rZW47XG59XG4iXSwibmFtZXMiOlsicGFyc2VDb250ZW50IiwicGFyc2VGaWxlIiwicGFyc2VMaW5lIiwiZmlsZVBhdGgiLCJhcmdzIiwicmVnZXgiLCJjb250ZW50IiwicmVhZEZpbGUiLCJwYXJzZWRDb250ZW50IiwibGluZXMiLCJzcGxpdCIsInBhcnNlZExpbmVzIiwicGFyc2VMaW5lcyIsImpvaW4iLCJsaW5lIiwicGFyc2VkTGluZSIsInJlcGxhY2UiLCJtYXRjaCIsInRva2VuIiwicGFyc2VkVG9rZW4iLCJwYXJzZVRva2VuIiwibWFwIiwiRU1QVFlfU1RSSU5HIiwiaGFzT3duUHJvcGVydHkiXSwibWFwcGluZ3MiOiJBQUFBOzs7Ozs7Ozs7OztRQThCQTtlQUFBOztRQWxCZ0JBO2VBQUFBOztRQVBBQztlQUFBQTs7UUFlQUM7ZUFBQUE7OzswQkFsQlM7eUJBQ0k7QUFFdEIsU0FBU0QsVUFBVUUsUUFBUSxFQUFFQyxJQUFJLEVBQUVDLEtBQUs7SUFDN0MsSUFBTUMsVUFBVUMsSUFBQUEsb0JBQVEsRUFBQ0osV0FDbkJLLGdCQUFnQlIsYUFBYU0sU0FBU0YsTUFBTUM7SUFFbEQsT0FBT0c7QUFDVDtBQUVPLFNBQVNSLGFBQWFNLE9BQU8sRUFBRUYsSUFBSSxFQUFFQyxLQUFLO0lBQy9DLElBQU1JLFFBQVFILFFBQVFJLEtBQUssQ0FBQyxPQUN0QkMsY0FBY0MsV0FBV0gsT0FBT0wsTUFBTUMsUUFDdENHLGdCQUFnQkcsWUFBWUUsSUFBSSxDQUFDO0lBRXZDLE9BQU9MO0FBQ1Q7QUFFTyxTQUFTTixVQUFVWSxJQUFJLEVBQUVWLElBQUk7UUFBRUMsUUFBQUEsaUVBQVE7SUFDNUMsSUFBTVUsYUFBYUQsS0FBS0UsT0FBTyxDQUFDWCxPQUFPLFNBQUNZLE9BQU9DO1FBQzdDLElBQU1DLGNBQWNDLFdBQVdGLE9BQU9kO1FBRXRDLE9BQU9lO0lBQ1Q7SUFFQSxPQUFPSjtBQUNUO0lBRUEsV0FBZTtJQUNiZCxXQUFBQTtJQUNBRCxjQUFBQTtJQUNBRSxXQUFBQTtBQUNGO0FBRUEsU0FBU1UsV0FBV0gsS0FBSyxFQUFFTCxJQUFJLEVBQUVDLEtBQUs7SUFDcEMsSUFBTU0sY0FBY0YsTUFBTVksR0FBRyxDQUFDLFNBQUNQO1FBQzdCLElBQU1DLGFBQWFiLFVBQVVZLE1BQU1WLE1BQU1DO1FBRXpDLE9BQU9VO0lBQ1Q7SUFFQSxPQUFPSjtBQUNUO0FBRUEsU0FBU1MsV0FBV0YsS0FBSyxFQUFFZCxJQUFJO0lBQzdCLElBQUllLGNBQWNHLHVCQUFZO0lBRTlCLElBQUlsQixLQUFLbUIsY0FBYyxDQUFDTCxRQUFRO1FBQzlCQyxjQUFjZixJQUFJLENBQUNjLE1BQU07SUFDM0I7SUFFQSxPQUFPQztBQUNUIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy91dGlsaXRpZXMvdGVtcGxhdGUuanMiXSwic291cmNlc0NvbnRlbnQiOlsiXCJ1c2Ugc3RyaWN0XCI7XG5cbmltcG9ydCB7IHJlYWRGaWxlIH0gZnJvbSBcIi4uL3V0aWxpdGllcy9maWxlU3lzdGVtXCI7XG5pbXBvcnQgeyBFTVBUWV9TVFJJTkcgfSBmcm9tIFwiLi4vY29uc3RhbnRzXCI7XG5pbXBvcnQgeyBORVdfTElORV9DSEFSQUNURVIgfSBmcm9tIFwiLi4vY2hhcmFjdGVyc1wiO1xuXG5jb25zdCBkZWZhdWx0UmVndWxhckV4cHJlc3Npb24gPSAvXFwkeyguKz8pfS9nO1xuXG5leHBvcnQgZnVuY3Rpb24gcGFyc2VGaWxlKGZpbGVQYXRoLCBhcmdzLCByZWd1bGFyRXhwcmVzc2lvbiA9IGRlZmF1bHRSZWd1bGFyRXhwcmVzc2lvbikge1xuICBjb25zdCBjb250ZW50ID0gcmVhZEZpbGUoZmlsZVBhdGgpLFxuICAgICAgICBwYXJzZWRDb250ZW50ID0gcGFyc2VDb250ZW50KGNvbnRlbnQsIGFyZ3MsIHJlZ3VsYXJFeHByZXNzaW9uKTtcblxuICByZXR1cm4gcGFyc2VkQ29udGVudDtcbn1cblxuZXhwb3J0IGZ1bmN0aW9uIHBhcnNlQ29udGVudChjb250ZW50LCBhcmdzLCByZWd1bGFyRXhwcmVzc2lvbiA9IGRlZmF1bHRSZWd1bGFyRXhwcmVzc2lvbikge1xuICBjb25zdCBsaW5lcyA9IGNvbnRlbnQuc3BsaXQoTkVXX0xJTkVfQ0hBUkFDVEVSKSxcbiAgICAgICAgcGFyc2VkTGluZXMgPSBwYXJzZUxpbmVzKGxpbmVzLCBhcmdzLCByZWd1bGFyRXhwcmVzc2lvbiksXG4gICAgICAgIHBhcnNlZENvbnRlbnQgPSBwYXJzZWRMaW5lcy5qb2luKE5FV19MSU5FX0NIQVJBQ1RFUik7XG5cbiAgcmV0dXJuIHBhcnNlZENvbnRlbnQ7XG59XG5cbmV4cG9ydCBmdW5jdGlvbiBwYXJzZUxpbmUobGluZSwgYXJncywgcmVndWxhckV4cHJlc3Npb24gPSBkZWZhdWx0UmVndWxhckV4cHJlc3Npb24pIHtcbiAgY29uc3QgcGFyc2VkTGluZSA9IGxpbmUucmVwbGFjZShyZWd1bGFyRXhwcmVzc2lvbiwgKG1hdGNoLCB0b2tlbikgPT4ge1xuICAgIGNvbnN0IHBhcnNlZFRva2VuID0gcGFyc2VUb2tlbih0b2tlbiwgYXJncyk7XG5cbiAgICByZXR1cm4gcGFyc2VkVG9rZW47XG4gIH0pO1xuXG4gIHJldHVybiBwYXJzZWRMaW5lO1xufVxuXG5leHBvcnQgZGVmYXVsdCB7XG4gIHBhcnNlRmlsZSxcbiAgcGFyc2VDb250ZW50LFxuICBwYXJzZUxpbmVcbn07XG5cbmZ1bmN0aW9uIHBhcnNlTGluZXMobGluZXMsIGFyZ3MsIHJlZ3VsYXJFeHByZXNzaW9uKSB7XG4gIGNvbnN0IHBhcnNlZExpbmVzID0gbGluZXMubWFwKChsaW5lKSA9PiB7XG4gICAgY29uc3QgcGFyc2VkTGluZSA9IHBhcnNlTGluZShsaW5lLCBhcmdzLCByZWd1bGFyRXhwcmVzc2lvbik7XG5cbiAgICByZXR1cm4gcGFyc2VkTGluZTtcbiAgfSk7XG5cbiAgcmV0dXJuIHBhcnNlZExpbmVzO1xufVxuXG5mdW5jdGlvbiBwYXJzZVRva2VuKHRva2VuLCBhcmdzKSB7XG4gIGxldCBwYXJzZWRUb2tlbiA9IEVNUFRZX1NUUklORztcblxuICBpZiAoYXJncy5oYXNPd25Qcm9wZXJ0eSh0b2tlbikpIHtcbiAgICBwYXJzZWRUb2tlbiA9IGFyZ3NbdG9rZW5dO1xuICB9XG5cbiAgcmV0dXJuIHBhcnNlZFRva2VuO1xufVxuIl0sIm5hbWVzIjpbInBhcnNlQ29udGVudCIsInBhcnNlRmlsZSIsInBhcnNlTGluZSIsImRlZmF1bHRSZWd1bGFyRXhwcmVzc2lvbiIsImZpbGVQYXRoIiwiYXJncyIsInJlZ3VsYXJFeHByZXNzaW9uIiwiY29udGVudCIsInJlYWRGaWxlIiwicGFyc2VkQ29udGVudCIsImxpbmVzIiwic3BsaXQiLCJORVdfTElORV9DSEFSQUNURVIiLCJwYXJzZWRMaW5lcyIsInBhcnNlTGluZXMiLCJqb2luIiwibGluZSIsInBhcnNlZExpbmUiLCJyZXBsYWNlIiwibWF0Y2giLCJ0b2tlbiIsInBhcnNlZFRva2VuIiwicGFyc2VUb2tlbiIsIm1hcCIsIkVNUFRZX1NUUklORyIsImhhc093blByb3BlcnR5Il0sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7Ozs7Ozs7UUFpQ0E7ZUFBQTs7UUFsQmdCQTtlQUFBQTs7UUFQQUM7ZUFBQUE7O1FBZUFDO2VBQUFBOzs7MEJBckJTO3lCQUNJOzBCQUNNO0FBRW5DLElBQU1DLDJCQUEyQjtBQUUxQixTQUFTRixVQUFVRyxRQUFRLEVBQUVDLElBQUk7UUFBRUMsb0JBQUFBLGlFQUFvQkg7SUFDNUQsSUFBTUksVUFBVUMsSUFBQUEsb0JBQVEsRUFBQ0osV0FDbkJLLGdCQUFnQlQsYUFBYU8sU0FBU0YsTUFBTUM7SUFFbEQsT0FBT0c7QUFDVDtBQUVPLFNBQVNULGFBQWFPLE9BQU8sRUFBRUYsSUFBSTtRQUFFQyxvQkFBQUEsaUVBQW9CSDtJQUM5RCxJQUFNTyxRQUFRSCxRQUFRSSxLQUFLLENBQUNDLDhCQUFrQixHQUN4Q0MsY0FBY0MsV0FBV0osT0FBT0wsTUFBTUMsb0JBQ3RDRyxnQkFBZ0JJLFlBQVlFLElBQUksQ0FBQ0gsOEJBQWtCO0lBRXpELE9BQU9IO0FBQ1Q7QUFFTyxTQUFTUCxVQUFVYyxJQUFJLEVBQUVYLElBQUk7UUFBRUMsb0JBQUFBLGlFQUFvQkg7SUFDeEQsSUFBTWMsYUFBYUQsS0FBS0UsT0FBTyxDQUFDWixtQkFBbUIsU0FBQ2EsT0FBT0M7UUFDekQsSUFBTUMsY0FBY0MsV0FBV0YsT0FBT2Y7UUFFdEMsT0FBT2dCO0lBQ1Q7SUFFQSxPQUFPSjtBQUNUO0lBRUEsV0FBZTtJQUNiaEIsV0FBQUE7SUFDQUQsY0FBQUE7SUFDQUUsV0FBQUE7QUFDRjtBQUVBLFNBQVNZLFdBQVdKLEtBQUssRUFBRUwsSUFBSSxFQUFFQyxpQkFBaUI7SUFDaEQsSUFBTU8sY0FBY0gsTUFBTWEsR0FBRyxDQUFDLFNBQUNQO1FBQzdCLElBQU1DLGFBQWFmLFVBQVVjLE1BQU1YLE1BQU1DO1FBRXpDLE9BQU9XO0lBQ1Q7SUFFQSxPQUFPSjtBQUNUO0FBRUEsU0FBU1MsV0FBV0YsS0FBSyxFQUFFZixJQUFJO0lBQzdCLElBQUlnQixjQUFjRyx1QkFBWTtJQUU5QixJQUFJbkIsS0FBS29CLGNBQWMsQ0FBQ0wsUUFBUTtRQUM5QkMsY0FBY2hCLElBQUksQ0FBQ2UsTUFBTTtJQUMzQjtJQUVBLE9BQU9DO0FBQ1QifQ==

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "necessary",
   "author": "James Smith",
-  "version": "15.0.6",
+  "version": "15.0.8",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/necessary",
   "description": "A collection of utility functions.",
@@ -12,7 +12,7 @@
   "devDependencies": {
     "@swc/core": "1.13.20",
     "necessary": "14.0",
-    "watchful-cli": "^1.7.61"
+    "watchful-cli": "^1.7.62"
   },
   "scripts": {
     "clean": "rm -rf ./lib",

package/src/utilities/template.js

@@ -2,24 +2,27 @@
 
 import { readFile } from "../utilities/fileSystem";
 import { EMPTY_STRING } from "../constants";
+import { NEW_LINE_CHARACTER } from "../characters";
 
-export function parseFile(filePath, args, regex) {
+const defaultRegularExpression = /\${(.+?)}/g;
+
+export function parseFile(filePath, args, regularExpression = defaultRegularExpression) {
   const content = readFile(filePath),
-        parsedContent = parseContent(content, args, regex);
+        parsedContent = parseContent(content, args, regularExpression);
 
   return parsedContent;
 }
 
-export function parseContent(content, args, regex) {
-  const lines = content.split("\n"),
-        parsedLines = parseLines(lines, args, regex),
-        parsedContent = parsedLines.join("\n");
+export function parseContent(content, args, regularExpression = defaultRegularExpression) {
+  const lines = content.split(NEW_LINE_CHARACTER),
+        parsedLines = parseLines(lines, args, regularExpression),
+        parsedContent = parsedLines.join(NEW_LINE_CHARACTER);
 
   return parsedContent;
 }
 
-export function parseLine(line, args, regex = /\${(.+?)}/g) {
-  const parsedLine = line.replace(regex, (match, token) => {
+export function parseLine(line, args, regularExpression = defaultRegularExpression) {
+  const parsedLine = line.replace(regularExpression, (match, token) => {
     const parsedToken = parseToken(token, args);
 
     return parsedToken;
@@ -34,9 +37,9 @@ export default {
   parseLine
 };
 
-function parseLines(lines, args, regex) {
+function parseLines(lines, args, regularExpression) {
   const parsedLines = lines.map((line) => {
-    const parsedLine = parseLine(line, args, regex);
+    const parsedLine = parseLine(line, args, regularExpression);
 
     return parsedLine;
   });