npm - vite-plugin-php - Versions diffs - 0.9.0 - Mend

vite-plugin-php 0.9.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 (6) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2022 Nikita Nitichevski
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,72 @@
+# vite-plugin-php
+[![npm](https://img.shields.io/npm/dt/vite-plugin-php?style=for-the-badge)](https://www.npmjs.com/package/vite-plugin-php) [![GitHub Repo stars](https://img.shields.io/github/stars/donnikitos/vite-plugin-php?label=GitHub%20Stars&style=for-the-badge)](https://github.com/donnikitos/vite-plugin-php) [![GitHub](https://img.shields.io/github/license/donnikitos/vite-plugin-php?color=blue&style=for-the-badge)](https://github.com/donnikitos/vite-plugin-php/blob/master/LICENSE)
+![GitHub last commit](https://img.shields.io/github/last-commit/donnikitos/vite-plugin-php?style=for-the-badge) [![Issues](https://img.shields.io/github/issues/donnikitos/vite-plugin-php?style=for-the-badge)](https://github.com/donnikitos/vite-plugin-php/issues)
+Use Vite's speed and tooling to process PHP-files!
+```js
+// vite.config.js
+import { defineConfig } from 'vite';
+import usePHP from 'vite-plugin-php';
+export default defineConfig({
+	plugins: [usePHP()],
+});
+```
+## Write some PHP code in your `index.php`
+```php
+<!-- index.php -->
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<meta http-equiv="X-UA-Compatible" content="IE=edge" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+	</head>
+	<body>
+		<?="Render some text with PHP!";?>
+		<?php if(isset($_GET['dont_load'])) { ?>
+			<script src="./src/some_script.js" type="module"></script>
+		<?php } ?>
+	</body>
+</html>
+```
+The plugin will serve you the processed `index.php` as usual, including all imported and preprocessed files that are supported by Vite and other loaders.
+## Configuration
+By default the plugin is trying to access the system `php`-binary and load the `index.php` file as the main entry point.
+However you have the possibility to use an other binary or even compile multiple entry-points:
+```js
+usePHP({
+	binary: '/opt/lampp/bin/php-8.1.10',
+	entry: ['index.php', 'about.php', 'contact.php'],
+});
+```
+Should you have multiple entry-points, you will be able to access each one according to this chart:
+| Entry file        | Accessible routes                     | Build file          |
+| ----------------- | ------------------------------------- | ------------------- |
+| index.php         | `/` `/index` `/index.php`             | `index.php`         |
+| about.php         | `/about` `/about.php`                 | `about.php`         |
+| about/details.php | `/about/details` `/about/details.php` | `about/details.php` |
+| contact.php       | `/contact` `/contact.php`             | `contact.php`       |
+| shop/index.php    | `/shop/` `/shop/index.php`            | `shop/index.php`    |
+| ...               | ...                                   | ...                 |
+## Known issues
+Vite won't be able to process PHP-computed styles, scripts or images:
+```php
+<script src="./src/<?='dynamic_script_name';?>.js" type="module"></script>
+```
+If you encounter any other bugs or need some other features feel free to open an [issue](https://github.com/donnikitos/vite-plugin-php/issues).

package/dist/index.cjs ADDED Viewed

@@ -0,0 +1,182 @@
+'use strict';
+const child_process = require('child_process');
+const fs = require('fs');
+const path = require('path');
+function runPHP(input, args = {}) {
+  const params = [runPHP.binary];
+  Object.entries(args).forEach(([optionName, value]) => {
+    if (optionName === "define") {
+      Object.entries(value).forEach(([k, v]) => {
+        params.push(`--${optionName} ${k}=${v}`);
+      });
+    } else {
+      const name = optionName.replaceAll("_", "-");
+      params.push(`--${name} ${value}`);
+    }
+  });
+  let i = input;
+  i = i.replaceAll("'", `'"'"'`);
+  i = `echo '${i}' | ` + params.join(" ");
+  return child_process.execSync(i).toString();
+}
+runPHP.binary = "php";
+function makeID() {
+  return Date.now().toString(36) + Math.random() * 100;
+}
+function writeFile(file, data) {
+  fs.mkdirSync(path.dirname(file), { recursive: true });
+  fs.writeFileSync(file, data);
+}
+const codeTokens = /* @__PURE__ */ new Map();
+function escapePHP(inputFile, outputFile) {
+  const fileId = path.resolve(outputFile);
+  const input = fs.readFileSync(inputFile).toString();
+  if (!codeTokens.has(fileId)) {
+    codeTokens.set(fileId, /* @__PURE__ */ new Map());
+  }
+  const fileTokens = codeTokens.get(fileId);
+  const isJS = inputFile.includes(".js") || inputFile.includes(".ts");
+  const isML = inputFile.includes(".php") || inputFile.includes(".htm");
+  const out = input.replaceAll(/<\?(?:php|).+?\?>/gi, (match) => {
+    let token = makeID();
+    if (isJS) {
+      token = `/*${token}*/`;
+    } else if (isML) {
+      token = `<!--${token}-->`;
+    }
+    fileTokens.set(token, match);
+    return token;
+  });
+  writeFile(outputFile, out);
+}
+function unescapePHP(file) {
+  const fileId = path.resolve(file);
+  const input = fs.readFileSync(file).toString();
+  const fileTokens = codeTokens.get(fileId);
+  let out = input;
+  if (fileTokens) {
+    fileTokens.forEach((code, token) => {
+      out = out.replace(token, (match) => {
+        return code;
+      });
+    });
+  }
+  return out;
+}
+function usePHP(cfg = {}) {
+  const {
+    binary = "php",
+    entry = "index.php",
+    args,
+    tempDir = ".php-tmp"
+  } = cfg;
+  runPHP.binary = binary;
+  let config = void 0;
+  const entries = Array.isArray(entry) ? entry : [entry];
+  function escapeFile(file) {
+    const tempFile = `${tempDir}/${file}.html`;
+    escapePHP(file, tempFile);
+    return tempFile;
+  }
+  function cleanUp(dir = "") {
+    const parentDir = dir ? dir + "/" : dir;
+    fs.rmSync(parentDir + tempDir, { recursive: true, force: true });
+  }
+  return [
+    {
+      name: "prepare-php",
+      config: {
+        order: "post",
+        handler(config2, env) {
+          const gitIgnoreFile = `${tempDir}/.gitignore`;
+          if (!fs.existsSync(gitIgnoreFile)) {
+            writeFile(gitIgnoreFile, "*\n**/*.php.html");
+          }
+          const inputs = entries.map(escapeFile);
+          return {
+            build: {
+              rollupOptions: { input: inputs }
+            },
+            optimizeDeps: { entries: inputs }
+          };
+        }
+      },
+      configResolved(_config) {
+        config = _config;
+      }
+    },
+    {
+      name: "serve-php",
+      apply: "serve",
+      enforce: "pre",
+      configureServer(server) {
+        server.middlewares.use(async (req, res, next) => {
+          if (req.url) {
+            let requestUrl = req.url;
+            if (requestUrl.endsWith("/")) {
+              requestUrl += "index.php";
+            }
+            requestUrl = requestUrl.substring(1);
+            const entry2 = entries.find((file) => {
+              return file === requestUrl || file.substring(0, file.lastIndexOf(".")) === requestUrl;
+            });
+            if (entry2) {
+              let tempFile = `${tempDir}/`;
+              tempFile += entry2 + ".html";
+              if (fs.existsSync(path.resolve(tempFile))) {
+                const code = unescapePHP(tempFile);
+                const out = await server.transformIndexHtml(
+                  requestUrl || "/",
+                  runPHP(code, args)
+                );
+                res.end(out);
+                return;
+              }
+            }
+          }
+          next();
+        });
+      },
+      handleHotUpdate({ server, file }) {
+        const entry2 = entries.find(
+          (entryFile) => file.endsWith(entryFile) && path.resolve(entryFile) === file
+        );
+        if (entry2) {
+          escapeFile(entry2);
+          server.ws.send({
+            type: "full-reload",
+            path: "*"
+          });
+        }
+      },
+      buildEnd(error) {
+        cleanUp();
+      }
+    },
+    {
+      name: "build-php",
+      apply: "build",
+      resolveId(source, importer, options) {
+        if (importer?.endsWith(".html") && importer.includes(`/${tempDir}/`)) {
+          return { id: path.resolve(source) };
+        }
+      },
+      closeBundle() {
+        const distDir = config?.build.outDir;
+        entries.forEach((file) => {
+          const code = unescapePHP(`${tempDir}/${file}.html`);
+          writeFile(`${distDir}/${file}`, code);
+        });
+        cleanUp(distDir);
+      }
+    }
+  ];
+}
+module.exports = usePHP;

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,24 @@
+import { Plugin } from 'vite';
+type PHP_CLI_Args = {
+    no_chdir?: boolean;
+    no_header?: boolean;
+    php_ini?: string;
+    no_php_ini?: boolean;
+    define?: Record<string, string>;
+    profile_info?: boolean;
+    process_begin?: string;
+    process_code?: string;
+    process_file?: string;
+    process_end?: string;
+};
+type UsePHPConfig = {
+    binary?: string;
+    entry?: string | string[];
+    args?: PHP_CLI_Args;
+    tempDir?: string;
+};
+declare function usePHP(cfg?: UsePHPConfig): Plugin[];
+export { usePHP as default };

package/dist/index.mjs ADDED Viewed

@@ -0,0 +1,180 @@
+import { execSync } from 'child_process';
+import { mkdirSync, writeFileSync, readFileSync, existsSync, rmSync } from 'fs';
+import { dirname, resolve } from 'path';
+function runPHP(input, args = {}) {
+  const params = [runPHP.binary];
+  Object.entries(args).forEach(([optionName, value]) => {
+    if (optionName === "define") {
+      Object.entries(value).forEach(([k, v]) => {
+        params.push(`--${optionName} ${k}=${v}`);
+      });
+    } else {
+      const name = optionName.replaceAll("_", "-");
+      params.push(`--${name} ${value}`);
+    }
+  });
+  let i = input;
+  i = i.replaceAll("'", `'"'"'`);
+  i = `echo '${i}' | ` + params.join(" ");
+  return execSync(i).toString();
+}
+runPHP.binary = "php";
+function makeID() {
+  return Date.now().toString(36) + Math.random() * 100;
+}
+function writeFile(file, data) {
+  mkdirSync(dirname(file), { recursive: true });
+  writeFileSync(file, data);
+}
+const codeTokens = /* @__PURE__ */ new Map();
+function escapePHP(inputFile, outputFile) {
+  const fileId = resolve(outputFile);
+  const input = readFileSync(inputFile).toString();
+  if (!codeTokens.has(fileId)) {
+    codeTokens.set(fileId, /* @__PURE__ */ new Map());
+  }
+  const fileTokens = codeTokens.get(fileId);
+  const isJS = inputFile.includes(".js") || inputFile.includes(".ts");
+  const isML = inputFile.includes(".php") || inputFile.includes(".htm");
+  const out = input.replaceAll(/<\?(?:php|).+?\?>/gi, (match) => {
+    let token = makeID();
+    if (isJS) {
+      token = `/*${token}*/`;
+    } else if (isML) {
+      token = `<!--${token}-->`;
+    }
+    fileTokens.set(token, match);
+    return token;
+  });
+  writeFile(outputFile, out);
+}
+function unescapePHP(file) {
+  const fileId = resolve(file);
+  const input = readFileSync(file).toString();
+  const fileTokens = codeTokens.get(fileId);
+  let out = input;
+  if (fileTokens) {
+    fileTokens.forEach((code, token) => {
+      out = out.replace(token, (match) => {
+        return code;
+      });
+    });
+  }
+  return out;
+}
+function usePHP(cfg = {}) {
+  const {
+    binary = "php",
+    entry = "index.php",
+    args,
+    tempDir = ".php-tmp"
+  } = cfg;
+  runPHP.binary = binary;
+  let config = void 0;
+  const entries = Array.isArray(entry) ? entry : [entry];
+  function escapeFile(file) {
+    const tempFile = `${tempDir}/${file}.html`;
+    escapePHP(file, tempFile);
+    return tempFile;
+  }
+  function cleanUp(dir = "") {
+    const parentDir = dir ? dir + "/" : dir;
+    rmSync(parentDir + tempDir, { recursive: true, force: true });
+  }
+  return [
+    {
+      name: "prepare-php",
+      config: {
+        order: "post",
+        handler(config2, env) {
+          const gitIgnoreFile = `${tempDir}/.gitignore`;
+          if (!existsSync(gitIgnoreFile)) {
+            writeFile(gitIgnoreFile, "*\n**/*.php.html");
+          }
+          const inputs = entries.map(escapeFile);
+          return {
+            build: {
+              rollupOptions: { input: inputs }
+            },
+            optimizeDeps: { entries: inputs }
+          };
+        }
+      },
+      configResolved(_config) {
+        config = _config;
+      }
+    },
+    {
+      name: "serve-php",
+      apply: "serve",
+      enforce: "pre",
+      configureServer(server) {
+        server.middlewares.use(async (req, res, next) => {
+          if (req.url) {
+            let requestUrl = req.url;
+            if (requestUrl.endsWith("/")) {
+              requestUrl += "index.php";
+            }
+            requestUrl = requestUrl.substring(1);
+            const entry2 = entries.find((file) => {
+              return file === requestUrl || file.substring(0, file.lastIndexOf(".")) === requestUrl;
+            });
+            if (entry2) {
+              let tempFile = `${tempDir}/`;
+              tempFile += entry2 + ".html";
+              if (existsSync(resolve(tempFile))) {
+                const code = unescapePHP(tempFile);
+                const out = await server.transformIndexHtml(
+                  requestUrl || "/",
+                  runPHP(code, args)
+                );
+                res.end(out);
+                return;
+              }
+            }
+          }
+          next();
+        });
+      },
+      handleHotUpdate({ server, file }) {
+        const entry2 = entries.find(
+          (entryFile) => file.endsWith(entryFile) && resolve(entryFile) === file
+        );
+        if (entry2) {
+          escapeFile(entry2);
+          server.ws.send({
+            type: "full-reload",
+            path: "*"
+          });
+        }
+      },
+      buildEnd(error) {
+        cleanUp();
+      }
+    },
+    {
+      name: "build-php",
+      apply: "build",
+      resolveId(source, importer, options) {
+        if (importer?.endsWith(".html") && importer.includes(`/${tempDir}/`)) {
+          return { id: resolve(source) };
+        }
+      },
+      closeBundle() {
+        const distDir = config?.build.outDir;
+        entries.forEach((file) => {
+          const code = unescapePHP(`${tempDir}/${file}.html`);
+          writeFile(`${distDir}/${file}`, code);
+        });
+        cleanUp(distDir);
+      }
+    }
+  ];
+}
+export { usePHP as default };

package/package.json ADDED Viewed

@@ -0,0 +1,51 @@
+{
+	"name": "vite-plugin-php",
+	"version": "0.9.0",
+	"description": "Precompile PHP-files with the speed of Vite",
+	"keywords": [
+		"vite",
+		"vite-plugin",
+		"load php",
+		"use php",
+		"vite php",
+		"compile php",
+		"php",
+		"php-loader",
+		"php-compiler",
+		"loader"
+	],
+	"author": "Nikita 'donnikitos' Nitichevski <me@donnikitos.com> (https://donnikitos.com/)",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/donnikitos/vite-plugin-php/issues"
+	},
+	"homepage": "https://github.com/donnikitos/vite-plugin-php#readme",
+	"repository": {
+		"type": "git",
+		"url": "git+ssh://git@github.com/donnikitos/vite-plugin-php.git"
+	},
+	"files": [
+		"dist"
+	],
+	"main": "./dist/index.mjs",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.mjs",
+			"require": "./dist/index.cjs"
+		}
+	},
+	"scripts": {
+		"build": "npx unbuild",
+		"prepack": "npm run build"
+	},
+	"dependencies": {},
+	"devDependencies": {
+		"@types/node": "^20.5.1",
+		"typescript": "^5.1.6",
+		"unbuild": "^1.2.1",
+		"vite": "^4.4.9"
+	}
+}