@thi.ng/transclude 1.0.4 → 1.1.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-01-04T21:07:38Z
+- **Last updated**: 2025-01-21T15:46:52Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,15 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [1.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/transclude@1.1.0) (2025-01-21)
+
+#### 🚀 Features
+
+- support recursive includes (w/ cycle detection) ([923d968](https://github.com/thi-ng/umbrella/commit/923d968))
+  - update `preincludeFile()` transform to support recursive includes
+  - add tests/assets
+  - update deps
+
 ### [0.1.91](https://github.com/thi-ng/umbrella/tree/@thi.ng/transclude@0.1.91) (2024-06-21)
 
 #### ♻️ Refactoring

package/README.md

@@ -66,12 +66,13 @@ For Node.js REPL:
 const tra = await import("@thi.ng/transclude");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 1.86 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 1.96 KB
 
 ## Dependencies
 
 - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
 - [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
+- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
 - [@thi.ng/file-io](https://github.com/thi-ng/umbrella/tree/develop/packages/file-io)
 - [@thi.ng/logger](https://github.com/thi-ng/umbrella/tree/develop/packages/logger)
 - [@thi.ng/strings](https://github.com/thi-ng/umbrella/tree/develop/packages/strings)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/transclude",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "Extensible functional template engine for text document generation, incl. various high-level Markdown features",
   "type": "module",
   "module": "./index.js",
@@ -40,12 +40,13 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.16",
-    "@thi.ng/checks": "^3.6.19",
-    "@thi.ng/file-io": "^2.1.22",
-    "@thi.ng/logger": "^3.0.27",
-    "@thi.ng/strings": "^3.9.1",
-    "@thi.ng/transducers": "^9.2.14"
+    "@thi.ng/api": "^8.11.17",
+    "@thi.ng/checks": "^3.6.20",
+    "@thi.ng/errors": "^2.5.23",
+    "@thi.ng/file-io": "^2.1.23",
+    "@thi.ng/logger": "^3.0.28",
+    "@thi.ng/strings": "^3.9.2",
+    "@thi.ng/transducers": "^9.2.15"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.48.1",
@@ -115,5 +116,5 @@
     ],
     "year": 2022
   },
-  "gitHead": "56e7a1724e7b0cb5c41119f60320b6ff0e8a3c1c\n"
+  "gitHead": "22f6d518aed5951bb37b406c8ae85a6c3e6be517\n"
 }

package/tpl/file.d.ts

@@ -3,18 +3,22 @@ import type { TemplateFn } from "../api.js";
  * Parametric template function. Includes file given as template argument:
  * `{{include header.md}}`
  *
+ * @remarks
+ * Does NOT support recursive inclusion. Use {@link preincludeFile} (given as
+ * {@link TranscludeCtx.pre} transform) as alternative.
+ *
  * @param ctx
  * @param args
  * @param currPath
  */
 export declare const includeFile: TemplateFn;
 /**
- * Pre-processing stage parametric template function. Includes file given as
- * template argument: `<!-- include header.md -->`.
+ * Pre-processing stage parametric template function. Recursively includes file
+ * given as template argument: `<!-- include header.md -->`.
  *
  * @param ctx
  * @param args
- * @param currPath
+ * @param initialPath
  */
 export declare const preincludeFile: TemplateFn;
 //# sourceMappingURL=file.d.ts.map

package/tpl/file.js

@@ -1,10 +1,30 @@
-import { readText } from "@thi.ng/file-io";
-import { resolve } from "node:path";
+import { illegalArgs } from "@thi.ng/errors/illegal-arguments";
+import { readText } from "@thi.ng/file-io/text";
+import { basename, resolve } from "node:path";
 const includeFile = ({ logger }, args, currPath) => readText(resolve(resolve(currPath, ".."), args[2].trim()), logger);
-const preincludeFile = ({ logger }, [src], currPath) => src.replace(
-  new RegExp(`<!-- include (.+) -->`, "g"),
-  (_, path) => readText(resolve(resolve(currPath, ".."), path.trim()), logger)
-);
+const preincludeFile = ({ logger }, [src], initialPath) => {
+  const pattern = /<!-- include (.+) -->/g;
+  const fileCache = {};
+  const replaceImport = (includePath, currPath, route) => {
+    includePath = resolve(resolve(currPath, ".."), includePath.trim());
+    if (fileCache[includePath]) return fileCache[includePath];
+    if (route.includes(includePath))
+      illegalArgs(
+        `include cycle detected: ${basename(currPath)} -> ${basename(
+          includePath
+        )}`
+      );
+    src = readText(includePath, logger).replace(
+      pattern,
+      (_, path) => replaceImport(path, includePath, [...route, path])
+    );
+    return fileCache[includePath] = src;
+  };
+  return src.replace(
+    pattern,
+    (_, path) => replaceImport(path, initialPath, [initialPath])
+  );
+};
 export {
   includeFile,
   preincludeFile