vite-file-include 1.0.1 → 1.0.3

package/README.md

@@ -1,23 +1,24 @@
-# vite-plugin-file-include
+# vite-file-include
 
-`vite-plugin-file-include` is an advanced Vite plugin designed to facilitate the inclusion of external HTML files, looping through data, and conditional rendering within your HTML files. It is particularly useful for managing repetitive HTML structures in static sites or templating environments.
+`vite-file-include` is an advanced Vite plugin designed to facilitate the inclusion of external HTML files, looping through data, and conditional rendering within your HTML files. It is particularly useful for managing repetitive HTML structures in static sites or templating environments.
 
 ## Features
 
 - File inclusion with support for nested includes
 - Looping through data arrays or JSON files
-- Conditional rendering
-- Caching mechanism for improved performance
+- Conditional rendering 
 - Custom function support for advanced templating
+- Evaluate JavaScript expressions directly in your templates.
 - Asynchronous file processing
 - Enhanced error handling and debugging
 
+
 ## Installation
 
 Install the plugin via npm:
 
 ```bash
-npm install vite-plugin-file-include
+npm install vite-file-include
 ```
 
 ## Configuration
@@ -25,7 +26,7 @@ npm install vite-plugin-file-include
 To use the plugin, import and configure it in your `vite.config.js`:
 
 ```javascript
-import fileIncludePlugin from 'vite-plugin-file-include';
+import fileIncludePlugin from 'vite-file-include';
 
 export default {
   plugins: [
@@ -35,7 +36,7 @@ export default {
       ifPattern: "@@if",
       baseDir: process.cwd(),
       context: {}, 
-      cacheTimeout: 5000
+      customFunctions: {},
     }),
   ],
 };
@@ -48,7 +49,7 @@ export default {
 - `ifPattern` (default: `@@if`): The pattern used to conditionally render content.
 - `baseDir` (default: `process.cwd()`): The base directory for resolving paths.
 - `context` (default: `{}`): An object containing global variables that can be used in includes, loops, and conditionals.
-- `cacheTimeout` (default: `5000`): The time (in milliseconds) after which cached content is invalidated.
+- `customFunctions` (default: {}): An object containing custom functions that can be used in your templates.
 
 ## Directives
 
@@ -118,6 +119,35 @@ The `@@if` directive allows conditional rendering based on an expression.
 }
 ```
 
+## Custom Functions
+
+You can define custom functions to use in your templates. These functions are passed to the plugin through the `customFunctions` option:
+
+```javascript
+fileIncludePlugin({
+  customFunctions: {
+    uppercase: (str) => str.toUpperCase(),
+    currentYear: () => new Date().getFullYear()
+  }
+})
+```
+
+You can then use these functions in your templates:
+
+```html
+<p>{{ uppercase(name) }}</p>
+<footer>&copy; {{ currentYear() }}</footer>
+```
+
+
+## JavaScript Expressions
+
+You can use JavaScript expressions directly in your templates. For example:
+
+```html 
+<p>Current Year: {{ new Date().getFullYear() }}</p>
+<p>Uppercase Text: {{ 'John'.toUpperCase() }}</p>
+```
 
 ## Example Usage
 
@@ -176,10 +206,6 @@ Below is an example of how you might structure your HTML files using the plugin'
 
 If there is an error parsing JSON data or including a file, the plugin will log a detailed error message to the console. This helps in debugging while ensuring that your build process continues without interruption.
 
-## Caching
-
-The plugin implements a caching mechanism to improve performance, especially for larger projects with many includes. Cached content is automatically invalidated after the specified `cacheTimeout`.
-
 ## License
 
 This project is licensed under the MIT License. See the LICENSE file for more details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-file-include",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A Vite plugin for file inclusion, loops, and conditionals in HTML files",
   "main": "src/index.js",
   "type": "module",
@@ -15,11 +15,16 @@
   ],
   "author": "Ahmed Abdulgid",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/abdulgidcoder/vite-file-includ.git"
+  },
   "peerDependencies": {
     "vite": "^4.0.0"
   },
   "dependencies": {
     "fs": "0.0.1-security",
-    "path": "^0.12.7"
+    "path": "^0.12.7",
+    "vite-file-include": "^1.0.2"
   }
-}
+}

package/src/index.js

@@ -1,13 +1,14 @@
 import fs from "fs";
 import path from "path";
 
-function fileInclude(options = {}) {
+function fileIncludePlugin(options = {}) {
   const {
     includePattern = "@@include",
     loopPattern = "@@loop",
     ifPattern = "@@if",
     baseDir = process.cwd(),
     context = {},
+    customFunctions = {},
   } = options;
 
   return {
@@ -20,7 +21,8 @@ function fileInclude(options = {}) {
         includePattern,
         loopPattern,
         ifPattern,
-        context
+        context,
+        customFunctions
       );
     },
 
@@ -32,7 +34,8 @@ function fileInclude(options = {}) {
           includePattern,
           loopPattern,
           ifPattern,
-          context
+          context,
+          customFunctions
         );
       }
       return code;
@@ -54,7 +57,8 @@ function processIncludes(
   includePattern,
   loopPattern,
   ifPattern,
-  context
+  context,
+  customFunctions
 ) {
   content = processIncludesWithPattern(
     content,
@@ -62,16 +66,18 @@ function processIncludes(
     includePattern,
     loopPattern,
     ifPattern,
-    context
+    context,
+    customFunctions
   );
-  content = processLoops(content, dir, loopPattern, context);
+  content = processLoops(content, dir, loopPattern, context, customFunctions);
   content = processConditionals(
     content,
     dir,
     ifPattern,
     includePattern,
     loopPattern,
-    context
+    context,
+    customFunctions
   );
 
   return content;
@@ -83,7 +89,8 @@ function processIncludesWithPattern(
   includePattern,
   loopPattern,
   ifPattern,
-  context
+  context,
+  customFunctions
 ) {
   const regex = new RegExp(
     `${includePattern}\\(\\s*['"](.+?)['"]\\s*,?\\s*({[\\s\\S]*?})?\\s*\\);`,
@@ -104,14 +111,19 @@ function processIncludesWithPattern(
 
     try {
       let includedContent = fs.readFileSync(includePath, "utf-8");
-      includedContent = injectData(includedContent, { ...context, ...data });
+      includedContent = injectData(
+        includedContent,
+        { ...context, ...data },
+        customFunctions
+      );
       return processIncludes(
         includedContent,
         path.dirname(includePath),
         includePattern,
         loopPattern,
         ifPattern,
-        context
+        context,
+        customFunctions
       );
     } catch (error) {
       console.error(`Failed to include file: ${includePath}`);
@@ -120,7 +132,7 @@ function processIncludesWithPattern(
   });
 }
 
-function processLoops(content, dir, loopPattern, context) {
+function processLoops(content, dir, loopPattern, context, customFunctions) {
   const regex = new RegExp(
     `${loopPattern}\\(\\s*['"](.+?)['"]\\s*,\\s*(\\[[\\s\\S]*?\\]|['"](.+?)['"])\\s*\\);`,
     "g"
@@ -131,15 +143,12 @@ function processLoops(content, dir, loopPattern, context) {
     let dataArray = [];
 
     try {
-      // Detect if the second argument is a JSON file path or a JSON array
       if (
         jsonArrayOrFilePath.startsWith("[") ||
         jsonArrayOrFilePath.startsWith("{")
       ) {
-        // Handle JSON array or object directly provided in the directive
         dataArray = JSON.parse(jsonArrayOrFilePath);
       } else {
-        // Handle JSON file path
         const jsonFilePath = path.resolve(
           dir,
           jsonArrayOrFilePath.replace(/['"]/g, "")
@@ -154,7 +163,9 @@ function processLoops(content, dir, loopPattern, context) {
 
     try {
       let loopTemplate = fs.readFileSync(loopPath, "utf-8");
-      return dataArray.map((data) => injectData(loopTemplate, data)).join("");
+      return dataArray
+        .map((data) => injectData(loopTemplate, data, customFunctions))
+        .join("");
     } catch (error) {
       console.error(`Failed to include file: ${loopPath}`);
       return "";
@@ -168,7 +179,8 @@ function processConditionals(
   ifPattern,
   includePattern,
   loopPattern,
-  context
+  context,
+  customFunctions
 ) {
   const regex = new RegExp(
     `${ifPattern}\\s*\\(([^)]+)\\)\\s*{([\\s\\S]*?)};\\s*`,
@@ -177,11 +189,7 @@ function processConditionals(
 
   return content.replace(regex, (match, condition, body) => {
     try {
-      const func = new Function(
-        "data",
-        "with (data) { return " + condition + "; }"
-      );
-      const result = func(context);
+      const result = evaluateCondition(condition, context, customFunctions);
 
       if (result) {
         return processIncludesWithPattern(
@@ -190,7 +198,8 @@ function processConditionals(
           includePattern,
           loopPattern,
           ifPattern,
-          context
+          context,
+          customFunctions
         );
       }
 
@@ -203,10 +212,10 @@ function processConditionals(
   });
 }
 
-function injectData(content, data) {
+function injectData(content, data, customFunctions = {}) {
   return content.replace(/\{\{\s*(.*?)\s*\}\}/g, (match, expression) => {
     try {
-      const result = evalExpression(expression, data);
+      const result = evaluateExpression(expression, data, customFunctions);
       return result !== undefined ? result : match;
     } catch (error) {
       console.error(`Failed to evaluate expression: ${expression}`);
@@ -216,12 +225,22 @@ function injectData(content, data) {
   });
 }
 
-function evalExpression(expression, data) {
-  const func = new Function(
-    "data",
-    "with (data) { return " + expression + "; }"
-  );
-  return func(data);
+function evaluateExpression(expression, data, customFunctions) {
+  // Bind custom functions to the evaluation context
+  const context = { ...data, ...customFunctions };
+  return new Function(
+    "context",
+    "with (context) { return " + expression + "; }"
+  )(context);
+}
+
+function evaluateCondition(condition, context, customFunctions) {
+  // Bind custom functions to the evaluation context
+  const contextWithFunctions = { ...context, ...customFunctions };
+  return new Function(
+    "context",
+    "with (context) { return " + condition + "; }"
+  )(contextWithFunctions);
 }
 
-export default fileInclude;
+export default fileIncludePlugin;