npm - vite-file-include - Versions diffs - 1.0.0 - Mend

vite-file-include 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,206 @@
+# vite-plugin-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.
+## Features
+- File inclusion with support for nested includes
+- Looping through data arrays or JSON files
+- Conditional rendering
+- Caching mechanism for improved performance
+- Custom function support for advanced templating
+- Asynchronous file processing
+- Enhanced error handling and debugging
+## Installation
+Install the plugin via npm:
+```bash
+npm install vite-plugin-file-include
+```
+## Configuration
+To use the plugin, import and configure it in your `vite.config.js`:
+```javascript
+import fileIncludePlugin from 'vite-plugin-file-include';
+export default {
+  plugins: [
+    fileIncludePlugin({
+      includePattern: "@@include",
+      loopPattern: "@@loop",
+      ifPattern: "@@if",
+      baseDir: process.cwd(),
+      context: {},
+      customFunctions: {},
+      cacheTimeout: 5000
+    }),
+  ],
+};
+```
+### Plugin Options
+- `includePattern` (default: `@@include`): The pattern used to include external HTML files.
+- `loopPattern` (default: `@@loop`): The pattern used to loop through data arrays.
+- `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.
+- `customFunctions` (default: `{}`): An object containing custom functions that can be used in expressions.
+- `cacheTimeout` (default: `5000`): The time (in milliseconds) after which cached content is invalidated.
+## Directives
+### `@@include`
+The `@@include` directive allows you to include the content of another HTML file within your main file.
+**Syntax:**
+```html
+@@include('path/to/file.html');
+```
+**With Data:**
+```html
+@@include('path/to/file.html', { "key": "value" });
+```
+**Example** (`file.html`):
+```html
+<div>{{ key }}</div>
+```
+### `@@loop`
+The `@@loop` directive enables you to repeat a block of HTML for each item in a data array or JSON file.
+**Syntax:**
+```html
+@@loop('path/to/template.html', 'data.json');
+```
+**With Inline Data:**
+```html
+@@loop('path/to/template.html', [{ "key": "value" }, { "key": "another value" }]);
+```
+**Example Template** (`template.html`):
+```html
+<article>
+  <h2>{{ key }}</h2>
+</article>
+```
+### `@@if`
+The `@@if` directive allows conditional rendering based on an expression.
+**Syntax:**
+```html
+@@if(condition) {
+  <!-- HTML content -->
+}
+```
+**Example:**
+```html
+@@if(name === 'John') {
+  <p>Welcome, John!</p>
+}
+```
+## 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>
+```
+## Example Usage
+Below is an example of how you might structure your HTML files using the plugin's directives:
+```html
+<!-- main.html -->
+<html>
+<body>
+  @@include('header.html', { "title": "My Website" });
+  @@loop('partials/article.html', 'data/articles.json');
+  @@if(showFooter) {
+    @@include('footer.html');
+  }
+</body>
+</html>
+```
+### Example Files
+- `header.html`:
+```html
+<header>
+  <h1>{{ uppercase(title) }}</h1>
+</header>
+```
+- `partials/article.html`:
+```html
+<article>
+  <h2>{{ title }}</h2>
+  <p>{{ content }}</p>
+</article>
+```
+- `data/articles.json`:
+```json
+[
+  {
+    "title": "Article 1",
+    "content": "Content of the first article."
+  },
+  {
+    "title": "Article 2",
+    "content": "Content of the second article."
+  }
+]
+```
+## Error Handling
+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 ADDED Viewed

@@ -0,0 +1,25 @@
+{
+  "name": "vite-file-include",
+  "version": "1.0.0",
+  "description": "A Vite plugin for file inclusion, loops, and conditionals in HTML files",
+  "main": "src/index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "vite",
+    "plugin",
+    "file-include",
+    "html"
+  ],
+  "author": "Ahmed Abdulgid",
+  "license": "MIT",
+  "peerDependencies": {
+    "vite": "^4.0.0"
+  },
+  "dependencies": {
+    "fs": "0.0.1-security",
+    "path": "^0.12.7"
+  }
+}

package/src/index.js ADDED Viewed

@@ -0,0 +1,227 @@
+import fs from "fs";
+import path from "path";
+function fileInclude(options = {}) {
+  const {
+    includePattern = "@@include",
+    loopPattern = "@@loop",
+    ifPattern = "@@if",
+    baseDir = process.cwd(),
+    context = {},
+  } = options;
+  return {
+    name: "vite-plugin-file-include",
+    transformIndexHtml(html) {
+      return processIncludes(
+        html,
+        baseDir,
+        includePattern,
+        loopPattern,
+        ifPattern,
+        context
+      );
+    },
+    transform(code, id) {
+      if (id.endsWith(".html")) {
+        return processIncludes(
+          code,
+          path.dirname(id),
+          includePattern,
+          loopPattern,
+          ifPattern,
+          context
+        );
+      }
+      return code;
+    },
+    handleHotUpdate({ file, server }) {
+      if (file.endsWith(".html")) {
+        server.ws.send({
+          type: "full-reload",
+        });
+      }
+    },
+  };
+}
+function processIncludes(
+  content,
+  dir,
+  includePattern,
+  loopPattern,
+  ifPattern,
+  context
+) {
+  content = processIncludesWithPattern(
+    content,
+    dir,
+    includePattern,
+    loopPattern,
+    ifPattern,
+    context
+  );
+  content = processLoops(content, dir, loopPattern, context);
+  content = processConditionals(
+    content,
+    dir,
+    ifPattern,
+    includePattern,
+    loopPattern,
+    context
+  );
+  return content;
+}
+function processIncludesWithPattern(
+  content,
+  dir,
+  includePattern,
+  loopPattern,
+  ifPattern,
+  context
+) {
+  const regex = new RegExp(
+    `${includePattern}\\(\\s*['"](.+?)['"]\\s*,?\\s*({[\\s\\S]*?})?\\s*\\);`,
+    "g"
+  );
+  return content.replace(regex, (match, filePath, jsonData) => {
+    const includePath = path.resolve(dir, filePath);
+    let data = {};
+    if (jsonData) {
+      try {
+        data = JSON.parse(jsonData);
+      } catch (error) {
+        console.error(`Failed to parse JSON data: ${jsonData}`);
+      }
+    }
+    try {
+      let includedContent = fs.readFileSync(includePath, "utf-8");
+      includedContent = injectData(includedContent, { ...context, ...data });
+      return processIncludes(
+        includedContent,
+        path.dirname(includePath),
+        includePattern,
+        loopPattern,
+        ifPattern,
+        context
+      );
+    } catch (error) {
+      console.error(`Failed to include file: ${includePath}`);
+      return "";
+    }
+  });
+}
+function processLoops(content, dir, loopPattern, context) {
+  const regex = new RegExp(
+    `${loopPattern}\\(\\s*['"](.+?)['"]\\s*,\\s*(\\[[\\s\\S]*?\\]|['"](.+?)['"])\\s*\\);`,
+    "g"
+  );
+  return content.replace(regex, (match, filePath, jsonArrayOrFilePath) => {
+    const loopPath = path.resolve(dir, filePath);
+    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, "")
+        );
+        const jsonData = fs.readFileSync(jsonFilePath, "utf-8");
+        dataArray = JSON.parse(jsonData);
+      }
+    } catch (error) {
+      console.error(`Failed to parse JSON: ${jsonArrayOrFilePath}`);
+      console.error(error);
+    }
+    try {
+      let loopTemplate = fs.readFileSync(loopPath, "utf-8");
+      return dataArray.map((data) => injectData(loopTemplate, data)).join("");
+    } catch (error) {
+      console.error(`Failed to include file: ${loopPath}`);
+      return "";
+    }
+  });
+}
+function processConditionals(
+  content,
+  dir,
+  ifPattern,
+  includePattern,
+  loopPattern,
+  context
+) {
+  const regex = new RegExp(
+    `${ifPattern}\\s*\\(([^)]+)\\)\\s*{([\\s\\S]*?)};\\s*`,
+    "g"
+  );
+  return content.replace(regex, (match, condition, body) => {
+    try {
+      const func = new Function(
+        "data",
+        "with (data) { return " + condition + "; }"
+      );
+      const result = func(context);
+      if (result) {
+        return processIncludesWithPattern(
+          body.trim(),
+          dir,
+          includePattern,
+          loopPattern,
+          ifPattern,
+          context
+        );
+      }
+      return "";
+    } catch (error) {
+      console.error(`Failed to evaluate condition: ${condition}`);
+      console.error(error);
+      return "";
+    }
+  });
+}
+function injectData(content, data) {
+  return content.replace(/\{\{\s*(.*?)\s*\}\}/g, (match, expression) => {
+    try {
+      const result = evalExpression(expression, data);
+      return result !== undefined ? result : match;
+    } catch (error) {
+      console.error(`Failed to evaluate expression: ${expression}`);
+      console.error(error);
+      return match;
+    }
+  });
+}
+function evalExpression(expression, data) {
+  const func = new Function(
+    "data",
+    "with (data) { return " + expression + "; }"
+  );
+  return func(data);
+}
+export default fileInclude;