replace-all-mustaches 0.0.1 → 0.0.2

package/README.md

@@ -1,2 +1,6 @@
 # replace-all-mustaches
-Replace all mustache templates in a string, including recursive mustache values
+Replace all mustache templates in a string, including recursive mustache values
+
+# install
+``npm i replace-all-mustaches``
+

package/dist/index.cjs

@@ -0,0 +1,135 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Variable: () => Variable,
+  VariableView: () => VariableView,
+  hasDuplicates: () => hasDuplicates,
+  hasMustacheTags: () => hasMustacheTags,
+  renderUntilStable: () => renderUntilStable
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/nodes/helperFunctions.ts
+function hasMustacheTags(template) {
+  return template.includes("{{") || template.includes("}}");
+}
+function hasDuplicates(arr) {
+  return new Set(arr).size !== arr.length;
+}
+
+// src/nodes/replaceAllMustaches.ts
+var import_mustache = __toESM(require("mustache"), 1);
+
+// src/nodes/Variable.ts
+var Variable = class {
+  key;
+  value;
+  constructor(key, value) {
+    this.key = key;
+    this.value = value;
+  }
+};
+
+// src/nodes/VariableView.ts
+var VariableView = class _VariableView {
+  static _collection = [];
+  static get all() {
+    return Object.fromEntries(
+      _VariableView._collection.flatMap((view) => Object.entries(view))
+    );
+  }
+  static get allNames() {
+    return _VariableView._collection.map((variable) => Object.keys(variable)).flat();
+  }
+  // [key:string] gives permission for arbitrary string keys
+  constructor(...variableValuePairs) {
+    variableValuePairs.forEach((pair) => {
+      this[pair.key] = pair.value;
+      if (_VariableView.allNames.includes(pair.key)) {
+        console.warn(`Master variable list already contains the variable ${pair.key} being added by ${this.constructor.name}.`);
+        console.trace();
+      }
+    });
+    _VariableView._collection.push(this);
+    if (hasDuplicates(variableValuePairs.map((pair) => pair.key))) {
+      console.warn(`Duplicated values in ${this.constructor.name}. (And yes, I should and will add where those occur.)`);
+    }
+    ;
+  }
+  add(...variableValuePair) {
+    variableValuePair.forEach((pair) => {
+      this[pair.key] = pair.value;
+    });
+  }
+  replace(variableKey, value) {
+    this[variableKey] = value;
+  }
+};
+
+// src/nodes/replaceAllMustaches.ts
+function renderUntilStable(template, view, { maxPasses = 20, detectCycles = true } = {}) {
+  let current = template;
+  const seen = /* @__PURE__ */ new Set();
+  let pass = 0;
+  for (pass; pass < maxPasses; pass += 1) {
+    if (hasMustacheTags(current)) {
+      if (detectCycles) {
+        if (seen.has(current)) {
+          throw new Error(`Render cycle detected at pass ${pass}: "${current}"`);
+        }
+        ;
+        seen.add(current);
+      }
+      ;
+      const next = import_mustache.default.render(current, VariableView.all);
+      if (next === current) {
+        return next;
+      }
+      ;
+      current = next;
+    } else {
+      console.log("passes:", pass);
+      return current;
+    }
+  }
+  ;
+  console.log("passes:", pass);
+  return current;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Variable,
+  VariableView,
+  hasDuplicates,
+  hasMustacheTags,
+  renderUntilStable
+});

package/dist/index.d.cts

@@ -0,0 +1,39 @@
+/**
+ * Confirm whether there are valid mustache tags remaining in the template string.
+ * @param template
+ * @returns
+ */
+declare function hasMustacheTags(template: string): boolean;
+declare function hasDuplicates(arr: any[]): boolean;
+
+type MustacheValue = string | string[] | Function;
+/**
+ * A key-value pair for a variable name and its value.
+ */
+declare class Variable {
+    key: string;
+    value: MustacheValue;
+    constructor(key: string, value: MustacheValue);
+}
+
+/**
+ * A generic class to create a view (the context for a Mustache.render() call). This class's _collection property holds all the names in any subsequently created variable registry via the allKeys getter.
+ * @todo Prevent duplicates
+ */
+declare class VariableView {
+    private static _collection;
+    static get all(): Record<string, MustacheValue>;
+    static get allNames(): string[];
+    [key: string]: MustacheValue;
+    constructor(...variableValuePairs: Variable[]);
+    add(...variableValuePair: Variable[]): void;
+    replace(variableKey: string, value: string | Function): void;
+}
+
+type replaceAllMustaches = {
+    maxPasses?: number;
+    detectCycles?: boolean;
+};
+declare function renderUntilStable(template: string, view: VariableView, { maxPasses, detectCycles }?: replaceAllMustaches): string;
+
+export { type MustacheValue, Variable, VariableView, hasDuplicates, hasMustacheTags, renderUntilStable };

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Confirm whether there are valid mustache tags remaining in the template string.
+ * @param template
+ * @returns
+ */
+declare function hasMustacheTags(template: string): boolean;
+declare function hasDuplicates(arr: any[]): boolean;
+
+type MustacheValue = string | string[] | Function;
+/**
+ * A key-value pair for a variable name and its value.
+ */
+declare class Variable {
+    key: string;
+    value: MustacheValue;
+    constructor(key: string, value: MustacheValue);
+}
+
+/**
+ * A generic class to create a view (the context for a Mustache.render() call). This class's _collection property holds all the names in any subsequently created variable registry via the allKeys getter.
+ * @todo Prevent duplicates
+ */
+declare class VariableView {
+    private static _collection;
+    static get all(): Record<string, MustacheValue>;
+    static get allNames(): string[];
+    [key: string]: MustacheValue;
+    constructor(...variableValuePairs: Variable[]);
+    add(...variableValuePair: Variable[]): void;
+    replace(variableKey: string, value: string | Function): void;
+}
+
+type replaceAllMustaches = {
+    maxPasses?: number;
+    detectCycles?: boolean;
+};
+declare function renderUntilStable(template: string, view: VariableView, { maxPasses, detectCycles }?: replaceAllMustaches): string;
+
+export { type MustacheValue, Variable, VariableView, hasDuplicates, hasMustacheTags, renderUntilStable };

package/dist/index.js

@@ -0,0 +1,94 @@
+// src/nodes/helperFunctions.ts
+function hasMustacheTags(template) {
+  return template.includes("{{") || template.includes("}}");
+}
+function hasDuplicates(arr) {
+  return new Set(arr).size !== arr.length;
+}
+
+// src/nodes/replaceAllMustaches.ts
+import Mustache from "mustache";
+
+// src/nodes/Variable.ts
+var Variable = class {
+  key;
+  value;
+  constructor(key, value) {
+    this.key = key;
+    this.value = value;
+  }
+};
+
+// src/nodes/VariableView.ts
+var VariableView = class _VariableView {
+  static _collection = [];
+  static get all() {
+    return Object.fromEntries(
+      _VariableView._collection.flatMap((view) => Object.entries(view))
+    );
+  }
+  static get allNames() {
+    return _VariableView._collection.map((variable) => Object.keys(variable)).flat();
+  }
+  // [key:string] gives permission for arbitrary string keys
+  constructor(...variableValuePairs) {
+    variableValuePairs.forEach((pair) => {
+      this[pair.key] = pair.value;
+      if (_VariableView.allNames.includes(pair.key)) {
+        console.warn(`Master variable list already contains the variable ${pair.key} being added by ${this.constructor.name}.`);
+        console.trace();
+      }
+    });
+    _VariableView._collection.push(this);
+    if (hasDuplicates(variableValuePairs.map((pair) => pair.key))) {
+      console.warn(`Duplicated values in ${this.constructor.name}. (And yes, I should and will add where those occur.)`);
+    }
+    ;
+  }
+  add(...variableValuePair) {
+    variableValuePair.forEach((pair) => {
+      this[pair.key] = pair.value;
+    });
+  }
+  replace(variableKey, value) {
+    this[variableKey] = value;
+  }
+};
+
+// src/nodes/replaceAllMustaches.ts
+function renderUntilStable(template, view, { maxPasses = 20, detectCycles = true } = {}) {
+  let current = template;
+  const seen = /* @__PURE__ */ new Set();
+  let pass = 0;
+  for (pass; pass < maxPasses; pass += 1) {
+    if (hasMustacheTags(current)) {
+      if (detectCycles) {
+        if (seen.has(current)) {
+          throw new Error(`Render cycle detected at pass ${pass}: "${current}"`);
+        }
+        ;
+        seen.add(current);
+      }
+      ;
+      const next = Mustache.render(current, VariableView.all);
+      if (next === current) {
+        return next;
+      }
+      ;
+      current = next;
+    } else {
+      console.log("passes:", pass);
+      return current;
+    }
+  }
+  ;
+  console.log("passes:", pass);
+  return current;
+}
+export {
+  Variable,
+  VariableView,
+  hasDuplicates,
+  hasMustacheTags,
+  renderUntilStable
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "replace-all-mustaches",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Replace all mustache templates in a string, including recursive mustache values",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/src/index.ts

@@ -1,4 +1,4 @@
 export * from "./nodes/helperFunctions"
-export * from "./nodes/renderUntilStable"
+export * from "./nodes/replaceAllMustaches"
 export * from "./nodes/Variable"
 export * from "./nodes/VariableView"

package/src/nodes/{renderUntilStable.ts → replaceAllMustaches.ts}

@@ -2,7 +2,7 @@ import Mustache from "mustache";
 import { VariableView } from "./VariableView";
 import { hasMustacheTags } from "./helperFunctions";
 
-type RenderLoopOptions = {
+type replaceAllMustaches = {
   maxPasses?: number;
   detectCycles?: boolean;
 };
@@ -10,7 +10,7 @@ type RenderLoopOptions = {
 export function renderUntilStable(
     template: string,
     view: VariableView,
-    { maxPasses = 20, detectCycles = true }: RenderLoopOptions = {},
+    { maxPasses = 20, detectCycles = true }: replaceAllMustaches = {},
     ): string {
         let current = template;
         const seen = new Set<string>();

package/tsconfig.json

@@ -1,46 +0,0 @@
-{
-  // Visit https://aka.ms/tsconfig to read more about this file
-  "compilerOptions": {
-    // File Layout
-    // "rootDir": "./src",
-    // "outDir": "./dist",
-
-    // Environment Settings
-    // See also https://aka.ms/tsconfig/module
-    "module": "es2022",
-    "target": "es2022",
-    "types": [],
-    // For nodejs:
-    // "lib": ["esnext"],
-    // "types": ["node"],
-    // and npm install -D @types/node
-
-    // Other Outputs
-    "sourceMap": true,
-    "declaration": true,
-    "declarationMap": true,
-
-    // Stricter Typechecking Options
-    "noUncheckedIndexedAccess": true,
-    "exactOptionalPropertyTypes": true,
-
-    // Style Options
-    // "noImplicitReturns": true,
-    // "noImplicitOverride": true,
-    // "noUnusedLocals": true,
-    // "noUnusedParameters": true,
-    // "noFallthroughCasesInSwitch": true,
-    // "noPropertyAccessFromIndexSignature": true,
-
-    // Recommended Options
-    "strict": true,
-    "jsx": "react-jsx",
-    "verbatimModuleSyntax": true,
-    "isolatedModules": true,
-    "noUncheckedSideEffectImports": true,
-    "moduleDetection": "force",
-    "skipLibCheck": true,
-  },
-  "include": ["src"],
-  "exclude": ["node_modules"]
-}

package/tsup.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from 'tsup';
- 
-export default defineConfig({
-    format: ['cjs', 'esm'],
-    entry: ['./src/index.ts'],
-    dts: true,
-    shims: true,
-    skipNodeModulesBundle: true,
-    clean: true,
-});