@ideasonpurpose/build-tools-wordpress 2.1.1 → 2.1.2

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### v2.1.1
+
+> 9 April 2025
+
+- Clean up outputs a little
+
 #### v2.1.0
 
 > 1 April 2025

package/README.md

@@ -1,6 +1,6 @@
 # @ideasonpurpose/build-tools-wordpress
 
-#### Version 2.1.1
+#### Version 2.1.2
 
 [![NPM Version](https://img.shields.io/npm/v/%40ideasonpurpose%2Fbuild-tools-wordpress?logo=npm)](https://www.npmjs.com/package/@ideasonpurpose/build-tools-wordpress)
 [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ideasonpurpose/build-tools-wordpress/npm-publish.yml?logo=github&logoColor=white)](https://github.com/ideasonpurpose/build-tools-wordpress#readme)

package/bin/format-php-prettier.js

@@ -0,0 +1,88 @@
+#!/usr/bin/env node
+
+/**
+ * This is an experimental proof-of-concept for formatting mixed HTML & PHP
+ * files from a single function.
+ *
+ * TODO: Testing, naming, modularization, VS Code extension
+ */
+import prettier from "prettier";
+import prettierConfig from "@ideasonpurpose/prettier-config" with { type: "json" };
+
+import { readFile, writeFile } from "fs/promises";
+import { resolve, basename } from "path";
+
+/**
+ * Prettier API doesn't recognize overrides, so we extract them
+ */
+const htmlOptions = prettierConfig.overrides.find(
+  (o) => o.files === "*.html",
+)?.options;
+
+const phpOptions = prettierConfig.overrides.find(
+  (o) => o.files === "*.php",
+)?.options;
+
+function tokenizeHTML(htmlContent) {
+  const phpCodeBlocks = {};
+  let tokenCount = 0;
+
+  // Tokens are end-padded to the length of the span, up to 80 characters
+  const tokenizedHTML = htmlContent.replace(
+    /<\?(?:php|=)[\s\S]*?\?>/gs,
+    (phpCodeBlock) => {
+      const codeLength = Math.min(phpCodeBlock.length, 80);
+      const token = `__php_${tokenCount++}__`.padEnd(codeLength, "_");
+      phpCodeBlocks[token] = phpCodeBlock;
+      return token;
+    },
+  );
+
+  return { tokenizedHTML, phpCodeBlocks };
+}
+
+function unTokenizeHTML(htmlContent, tokens) {
+  let phpContent = htmlContent;
+  for (const token in tokens) {
+    phpContent = phpContent.replace(new RegExp(token, "g"), tokens[token]);
+  }
+  return phpContent;
+}
+
+async function formatHTMLThenPHP(filepath) {
+  try {
+    const startTime = process.hrtime.bigint();
+    const rawFile = await readFile(filepath, "utf8");
+
+    const { tokenizedHTML, phpCodeBlocks } = tokenizeHTML(rawFile);
+
+    const htmlFormatted = await prettier.format(tokenizedHTML, {
+      ...prettierConfig,
+      ...htmlOptions,
+      parser: "html",
+    });
+
+    const phpUnTokenized = unTokenizeHTML(htmlFormatted, phpCodeBlocks);
+
+    const phpFormatted = await prettier.format(phpUnTokenized, {
+      ...prettierConfig,
+      ...phpOptions,
+      parser: "php",
+    });
+
+    await writeFile(filepath, phpFormatted, "utf8");
+    const endTime = process.hrtime.bigint();
+    const duration = Number(endTime - startTime);
+
+    console.log(`${basename(filepath)} ${(duration / 1e6).toFixed(2)}ms`);
+  } catch (error) {
+    console.error("Error:", error);
+  }
+}
+
+if (process.argv[2]) {
+  const fullPath = resolve(process.argv[2]);
+  formatHTMLThenPHP(fullPath);
+} else {
+  console.error("Error: A filepath is required.");
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ideasonpurpose/build-tools-wordpress",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "Build scripts and dependencies for IOP's WordPress development environments.",
   "homepage": "https://github.com/ideasonpurpose/build-tools-wordpress#readme",
   "bugs": {
@@ -21,7 +21,8 @@
   "bin": {
     "iop-build-port-reporter": "./bin/port-reporter.js",
     "iop-build-zip-archive": "./bin/zip.js",
-    "iop-project-init": "./bin/project-init.js"
+    "iop-project-init": "./bin/project-init.js",
+    "iop-html-php-prettier": "./bin/format-php-prettier.js"
   },
   "directories": {
     "lib": "lib"
@@ -32,19 +33,19 @@
   },
   "prettier": "@ideasonpurpose/prettier-config",
   "dependencies": {
-    "@ideasonpurpose/prettier-config": "^1.0.0",
+    "@ideasonpurpose/prettier-config": "^1.0.1",
     "@ideasonpurpose/stylelint-config": "^1.1.1",
     "@rollup/plugin-commonjs": "^28.0.3",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@svgr/webpack": "^8.1.0",
-    "@wordpress/dependency-extraction-webpack-plugin": "^6.20.0",
+    "@wordpress/dependency-extraction-webpack-plugin": "^6.22.0",
     "ansi-html": "^0.0.9",
     "archiver": "^7.0.1",
     "auto-changelog": "^2.5.0",
     "autoprefixer": "^10.4.21",
     "babel-loader": "^10.0.0",
-    "caniuse-lite": "^1.0.30001707",
+    "caniuse-lite": "^1.0.30001713",
     "chalk": "^5.4.1",
     "chalk-cli": "^5.0.1",
     "classnames": "^2.5.1",
@@ -54,9 +55,9 @@
     "cross-env": "^7.0.3",
     "css-loader": "^7.1.2",
     "cssnano": "^7.0.6",
-    "dotenv": "^16.4.7",
+    "dotenv": "^16.5.0",
     "esbuild-loader": "^4.3.0",
-    "eslint": "^9.23.0",
+    "eslint": "^9.24.0",
     "filesize": "^10.1.6",
     "fs-extra": "^11.3.0",
     "globby": "^14.1.0",
@@ -73,17 +74,17 @@
     "pretty-hrtime": "^1.0.3",
     "read-package-up": "^11.0.0",
     "replacestream": "^4.0.3",
-    "sass-embedded": "^1.86.1",
+    "sass-embedded": "^1.86.3",
     "sass-loader": "^16.0.5",
     "semver": "^7.7.1",
-    "sharp": "^0.33.5",
+    "sharp": "^0.34.1",
     "sort-package-json": "^3.0.0",
     "string-length": "^6.0.0",
     "style-loader": "^4.0.0",
     "svgo": "^3.3.2",
     "svgo-loader": "^4.0.0",
     "version-everything": "^0.11.4",
-    "webpack": "^5.98.0",
+    "webpack": "^5.99.5",
     "webpack-bundle-analyzer": "^4.10.2",
     "webpack-dev-middleware": "^7.4.2",
     "webpack-dev-server": "^5.2.1"