kist 0.1.32 → 0.1.34

package/js/actions/TemplateRenderAction/TemplateRenderAction.d.ts

@@ -1,25 +1,8 @@
 import { Action } from "../../core/pipeline/Action";
 import { ActionOptionsType } from "../../types/ActionOptionsType";
-/**
- * TemplateRenderAction is responsible for rendering and writing multiple files
- * from Nunjucks templates in a single action. It allows batch generation of
- * output files based on a shared template context.
- */
 export declare class TemplateRenderAction extends Action {
-    /**
-     * Executes the template rendering process for multiple templates.
-     *
-     * @param options - The options specifying the template directory,
-     * template-output mapping, and rendering context.
-     * @returns A Promise that resolves when all templates have been rendered.
-     * @throws {Error} Throws an error if template processing fails.
-     */
     execute(options: ActionOptionsType): Promise<void>;
-    /**
-     * Provides a description of the action.
-     *
-     * @returns A string description of the action.
-     */
+    private renderTemplate;
     describe(): string;
 }
 export default TemplateRenderAction;

package/js/actions/TemplateRenderAction/TemplateRenderAction.js

@@ -17,6 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TemplateRenderAction = void 0;
 const promises_1 = require("fs/promises");
+const glob_1 = require("glob");
 const nunjucks_1 = __importDefault(require("nunjucks"));
 const path_1 = __importDefault(require("path"));
 const Action_1 = require("../../core/pipeline/Action");
@@ -24,50 +25,32 @@ const nunjucks_config_js_1 = __importDefault(require("./nunjucks.config.js"));
 // ============================================================================
 // Classes
 // ============================================================================
-/**
- * TemplateRenderAction is responsible for rendering and writing multiple files
- * from Nunjucks templates in a single action. It allows batch generation of
- * output files based on a shared template context.
- */
 class TemplateRenderAction extends Action_1.Action {
-    /**
-     * Executes the template rendering process for multiple templates.
-     *
-     * @param options - The options specifying the template directory,
-     * template-output mapping, and rendering context.
-     * @returns A Promise that resolves when all templates have been rendered.
-     * @throws {Error} Throws an error if template processing fails.
-     */
     execute(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { templatesDir = "./templates", templates = [], context = {}, customConfig = {}, } = options;
-            if (!Array.isArray(templates) || templates.length === 0) {
-                throw new Error("Invalid options: 'templates' must be an array containing template-output pairs.");
-            }
-            this.logInfo(`Rendering ${templates.length} templates...`);
+            const { templatesDir = "./templates", outputDir = "./dist", templates = [], context = {}, renderAllFromDir = false, customConfig = {}, } = options;
+            const config = Object.assign(Object.assign({}, nunjucks_config_js_1.default), customConfig);
+            nunjucks_1.default.configure(templatesDir, config);
             try {
-                // Merge Nunjucks configurations
-                const config = Object.assign(Object.assign({}, nunjucks_config_js_1.default), customConfig);
-                nunjucks_1.default.configure(templatesDir, config);
-                // Render each template and save to its corresponding output path
-                for (const { template, outputFile } of templates) {
-                    if (!template || !outputFile) {
-                        throw new Error(`Invalid template entry: ${JSON.stringify({
-                            template,
-                            outputFile,
-                        })}`);
+                if (renderAllFromDir) {
+                    this.logInfo(`Auto-rendering all templates from ${templatesDir}...`);
+                    const templateFiles = yield (0, glob_1.glob)("**/*.jinja", {
+                        cwd: templatesDir,
+                    });
+                    for (const templateRelPath of templateFiles) {
+                        const outputFile = path_1.default.join(outputDir, templateRelPath.replace(/\.jinja$/, ""));
+                        yield this.renderTemplate(templateRelPath, outputFile, context, templatesDir);
+                    }
+                }
+                else {
+                    if (!Array.isArray(templates) || templates.length === 0) {
+                        throw new Error("Option 'templates' must be provided if 'renderAllFromDir' is false.");
+                    }
+                    for (const { template, outputFile } of templates) {
+                        yield this.renderTemplate(template, outputFile, context, templatesDir);
                     }
-                    this.logInfo(`Rendering: ${template} → ${outputFile}`);
-                    // Render template content
-                    const content = nunjucks_1.default.render(template, context);
-                    // Ensure the output directory exists
-                    const dir = path_1.default.dirname(outputFile);
-                    yield (0, promises_1.mkdir)(dir, { recursive: true });
-                    // Write the rendered template to file
-                    yield (0, promises_1.writeFile)(outputFile, content, "utf-8");
-                    this.logInfo(`✓ Successfully rendered: ${outputFile}`);
                 }
-                this.logInfo("All templates rendered successfully.");
+                this.logInfo("✓ All templates rendered successfully.");
             }
             catch (error) {
                 this.logError("Error rendering templates.", error);
@@ -75,13 +58,18 @@ class TemplateRenderAction extends Action_1.Action {
             }
         });
     }
-    /**
-     * Provides a description of the action.
-     *
-     * @returns A string description of the action.
-     */
+    renderTemplate(template, outputFile, context, templatesDir) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.logInfo(`Rendering: ${template} → ${outputFile}`);
+            const content = nunjucks_1.default.render(template, context);
+            const dir = path_1.default.dirname(outputFile);
+            yield (0, promises_1.mkdir)(dir, { recursive: true });
+            yield (0, promises_1.writeFile)(outputFile, content, "utf-8");
+            this.logInfo(`✓ Rendered: ${outputFile}`);
+        });
+    }
     describe() {
-        return "Renders multiple Nunjucks templates into files using a shared context.";
+        return "Renders one or many Nunjucks templates using a shared context. Supports folder-wide auto-rendering.";
     }
 }
 exports.TemplateRenderAction = TemplateRenderAction;

package/js/actions/TemplateRenderAction/nunjucks.config.d.ts

@@ -1,7 +1,8 @@
 /**
- * Configuration options for Nunjucks to ensure safe and efficient template rendering.
- * This setup is ideal for both development and production environments, providing a balance
- * between performance optimizations and security best practices.
+ * Configuration options for Nunjucks to ensure safe and efficient template
+ * rendering. This setup is ideal for both development and production
+ * environments, providing a balance between performance optimizations and
+ * security best practices.
  */
 declare const nunjucksConfig: {
     autoescape: boolean;

package/js/actions/TemplateRenderAction/nunjucks.config.js

@@ -3,18 +3,28 @@
 // according to your caching strategy for production environments to optimize performance.
 Object.defineProperty(exports, "__esModule", { value: true });
 // ============================================================================
+// Import
+// ============================================================================
+// Importing path for potential future use in specifying template directories
+// or other file paths
+// ============================================================================
 // Constants
 // ============================================================================
 /**
- * Configuration options for Nunjucks to ensure safe and efficient template rendering.
- * This setup is ideal for both development and production environments, providing a balance
- * between performance optimizations and security best practices.
+ * Configuration options for Nunjucks to ensure safe and efficient template
+ * rendering. This setup is ideal for both development and production
+ * environments, providing a balance between performance optimizations and
+ * security best practices.
  */
 const nunjucksConfig = {
-    autoescape: true, // Controls if output with dangerous characters are escaped automatically
-    throwOnUndefined: false, // Throw errors when outputting a null/undefined value
-    trimBlocks: true, // Automatically remove trailing newlines from a block/tag
-    lstripBlocks: true, // Automatically remove leading whitespace from a block/tag
+    // Controls if output with dangerous characters are escaped automatically
+    autoescape: true,
+    // Throw errors when outputting a null/undefined value
+    throwOnUndefined: false,
+    // Automatically remove trailing newlines from a block/tag
+    trimBlocks: true,
+    // Automatically remove leading whitespace from a block/tag
+    lstripBlocks: true,
     noCache: true,
 };
 // ============================================================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kist",
-  "version": "0.1.32",
+  "version": "0.1.34",
   "description": "Package Pipeline Processor",
   "keywords": [
     "kist",
@@ -67,13 +67,13 @@
     "@types/node": "^22.13.0",
     "@types/nunjucks": "^3.2.6",
     "@types/svg-sprite": "^0.0.39",
-    "autoprefixer": "^10.4.16",
+    "autoprefixer": "^10.4.21",
     "chokidar": "^4.0.0",
     "cssnano": "^7.0.4",
     "del": "^8.0.0",
     "eslint": "^9.9.0",
     "eslint-config-prettier": "^10.0.1",
-    "express": "^4.21.0",
+    "express": "^5.1.0",
     "express-rate-limit": "^7.5.0",
     "fantasticon": "^3.0.0",
     "fs-extra": "^11.2.0",
@@ -88,7 +88,7 @@
     "sass": "^1.69.7",
     "sassdoc": "^2.7.4",
     "semver": "^7.5.4",
-    "sharp": "^0.33.1",
+    "sharp": "^0.34.1",
     "svg-sprite": "^2.0.2",
     "svgo": "^3.1.0",
     "terser": "^5.26.0",

package/ts/actions/TemplateRenderAction/TemplateRenderAction.ts

@@ -3,6 +3,7 @@
 // ============================================================================
 
 import { mkdir, writeFile } from "fs/promises";
+import { glob } from "glob";
 import nunjucks from "nunjucks";
 import path from "path";
 import { Action } from "../../core/pipeline/Action";
@@ -13,81 +14,83 @@ import nunjucksConfig from "./nunjucks.config.js";
 // Classes
 // ============================================================================
 
-/**
- * TemplateRenderAction is responsible for rendering and writing multiple files
- * from Nunjucks templates in a single action. It allows batch generation of
- * output files based on a shared template context.
- */
 export class TemplateRenderAction extends Action {
-    /**
-     * Executes the template rendering process for multiple templates.
-     *
-     * @param options - The options specifying the template directory,
-     * template-output mapping, and rendering context.
-     * @returns A Promise that resolves when all templates have been rendered.
-     * @throws {Error} Throws an error if template processing fails.
-     */
     async execute(options: ActionOptionsType): Promise<void> {
         const {
             templatesDir = "./templates",
+            outputDir = "./dist",
             templates = [],
             context = {},
+            renderAllFromDir = false,
             customConfig = {},
         } = options;
 
-        if (!Array.isArray(templates) || templates.length === 0) {
-            throw new Error(
-                "Invalid options: 'templates' must be an array containing template-output pairs."
-            );
-        }
-
-        this.logInfo(`Rendering ${templates.length} templates...`);
+        const config = { ...nunjucksConfig, ...customConfig };
+        nunjucks.configure(templatesDir, config);
 
         try {
-            // Merge Nunjucks configurations
-            const config = { ...nunjucksConfig, ...customConfig };
-            nunjucks.configure(templatesDir, config);
-
-            // Render each template and save to its corresponding output path
-            for (const { template, outputFile } of templates) {
-                if (!template || !outputFile) {
+            if (renderAllFromDir) {
+                this.logInfo(
+                    `Auto-rendering all templates from ${templatesDir}...`,
+                );
+                const templateFiles = await glob("**/*.jinja", {
+                    cwd: templatesDir,
+                });
+
+                for (const templateRelPath of templateFiles) {
+                    const outputFile = path.join(
+                        outputDir,
+                        templateRelPath.replace(/\.jinja$/, ""),
+                    );
+                    await this.renderTemplate(
+                        templateRelPath,
+                        outputFile,
+                        context,
+                        templatesDir,
+                    );
+                }
+            } else {
+                if (!Array.isArray(templates) || templates.length === 0) {
                     throw new Error(
-                        `Invalid template entry: ${JSON.stringify({
-                            template,
-                            outputFile,
-                        })}`
+                        "Option 'templates' must be provided if 'renderAllFromDir' is false.",
                     );
                 }
 
-                this.logInfo(`Rendering: ${template} → ${outputFile}`);
-
-                // Render template content
-                const content = nunjucks.render(template, context);
-
-                // Ensure the output directory exists
-                const dir = path.dirname(outputFile);
-                await mkdir(dir, { recursive: true });
-
-                // Write the rendered template to file
-                await writeFile(outputFile, content, "utf-8");
-
-                this.logInfo(`✓ Successfully rendered: ${outputFile}`);
+                for (const { template, outputFile } of templates) {
+                    await this.renderTemplate(
+                        template,
+                        outputFile,
+                        context,
+                        templatesDir,
+                    );
+                }
             }
 
-            this.logInfo("All templates rendered successfully.");
+            this.logInfo("✓ All templates rendered successfully.");
         } catch (error) {
             this.logError("Error rendering templates.", error);
             throw error;
         }
     }
 
-    /**
-     * Provides a description of the action.
-     *
-     * @returns A string description of the action.
-     */
+    private async renderTemplate(
+        template: string,
+        outputFile: string,
+        context: Record<string, any>,
+        templatesDir: string,
+    ): Promise<void> {
+        this.logInfo(`Rendering: ${template} → ${outputFile}`);
+
+        const content = nunjucks.render(template, context);
+        const dir = path.dirname(outputFile);
+        await mkdir(dir, { recursive: true });
+        await writeFile(outputFile, content, "utf-8");
+
+        this.logInfo(`✓ Rendered: ${outputFile}`);
+    }
+
     describe(): string {
-        return "Renders multiple Nunjucks templates into files using a shared context.";
+        return "Renders one or many Nunjucks templates using a shared context. Supports folder-wide auto-rendering.";
     }
 }
 

package/ts/actions/TemplateRenderAction/nunjucks.config.ts

@@ -5,23 +5,28 @@
 // Import
 // ============================================================================
 
-// Importing path for potential future use in specifying template directories or other file paths
-import path from "node:path";
+// Importing path for potential future use in specifying template directories
+// or other file paths
 
 // ============================================================================
 // Constants
 // ============================================================================
 
 /**
- * Configuration options for Nunjucks to ensure safe and efficient template rendering.
- * This setup is ideal for both development and production environments, providing a balance
- * between performance optimizations and security best practices.
+ * Configuration options for Nunjucks to ensure safe and efficient template
+ * rendering. This setup is ideal for both development and production
+ * environments, providing a balance between performance optimizations and
+ * security best practices.
  */
 const nunjucksConfig = {
-    autoescape: true, // Controls if output with dangerous characters are escaped automatically
-    throwOnUndefined: false, // Throw errors when outputting a null/undefined value
-    trimBlocks: true, // Automatically remove trailing newlines from a block/tag
-    lstripBlocks: true, // Automatically remove leading whitespace from a block/tag
+    // Controls if output with dangerous characters are escaped automatically
+    autoescape: true,
+    // Throw errors when outputting a null/undefined value
+    throwOnUndefined: false,
+    // Automatically remove trailing newlines from a block/tag
+    trimBlocks: true,
+    // Automatically remove leading whitespace from a block/tag
+    lstripBlocks: true,
     noCache: true,
 };