@ideasonpurpose/build-tools-wordpress 2.6.3 → 2.6.6

package/.github/workflows/npm-publish.yml

@@ -15,10 +15,10 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       # https://github.com/marketplace/actions/checkout
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       # https://github.com/actions/setup-node
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           node-version: '24'
           registry-url: 'https://registry.npmjs.org'

package/CHANGELOG.md

@@ -4,6 +4,26 @@ 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.6.5
+
+> 5 April 2026
+
+- fix: update setup-node action version to v6 for consistency
+
+#### v2.6.4
+
+> 5 April 2026
+
+- chore: update actions versions in npm-publish workflow and bump version-everything dependency
+- feat: add new formatting functions for handling list elements and normalize newlines
+
+#### v2.6.3
+
+> 4 April 2026
+
+- bump deps
+- feat: add formatter for WordPress block pattern PHP files and corresponding tests
+
 #### v2.6.2
 
 > 23 March 2026

package/README.md

@@ -1,6 +1,6 @@
 # @ideasonpurpose/build-tools-wordpress
 
-#### Version 2.6.3
+#### Version 2.6.6
 
 [![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)
@@ -41,6 +41,20 @@ Webpack handles SVG files differently based on import context:
 
 Data URIs are generated as `data:image/svg+xml,<url-encoded-content>` using more efficient URL-encoding, not base64.
 
+## Experimental formatting helpers
+
+This package includes two experimental formatting scripts:
+
+### `iop-html-php-prettier`
+
+This uses [Prettier](https://prettier.io) to double-format mixed HTML and PHP files (like WordPress templates). PHP blocks are tokenized so Prettier can safely format the file as HTML, then PHP blocks are restored and the file is formatted again as PHP using [@prettier/plugin-php](https://github.com/prettier/plugin-php).
+**Usage:** `npx iop-html-php-prettier path/to/file.php`
+
+### `iop-format-wp-block-pattern`
+
+A specialized formatter for WordPress PHP block patterns. This makes block markup easier to read, expands JSON settings, and adjusts whitespace to work around Block Editor quirks.
+**Usage:** `npx iop-format-wp-block-pattern path/to/pattern.php`
+
 ## Local Development
 
 Because this project makes use of bin scripts, conventional `npm link` workflows won't work correctly. To work on this code in a development project, change the project's package.json to install from a local file path, probably something like this:

package/bin/format-wp-block-pattern.js

@@ -84,6 +84,7 @@ export function normalizeCommentTagSpacing(content) {
     "wp:heading",
     "wp:image",
     "wp:list",
+    "wp:list-item",
     "wp:media-text",
     "wp:paragraph",
     "wp:pattern",
@@ -111,6 +112,60 @@ export function normalizeCommentTagSpacing(content) {
   return newContent;
 }
 
+/**
+ * Remove extra blank lines (more than 2) and trim leading/trailing whitespace
+ * @param {string} content
+ * @returns {string}
+ */
+export function normalizeNewlines(content) {
+  return (
+    content
+      .replace(/^[ \t]+$/gm, "")
+      .replace(/\n{3,}/g, "\n\n")
+      .trim() + "\n"
+  );
+}
+
+/**
+ * Special handling of space inside <li> elements
+ *   @param {string} content
+ *   @returns {string}
+ */
+export function trimInsideListElements(content) {
+  return content
+    .replace(/\s*<!-- wp:list /g, "<!-- wp:list ")
+    .replace(/>\s*<!-- wp:list /g, ">\n\n<!-- wp:list ")
+    .replace(/>\s*<!-- wp:list-item /g, ">\n\n<!-- wp:list-item ")
+    .replace(/<!-- \/wp:list-item -->\s*</g, "<!-- \/wp:list-item -->\n\n<")
+    .replace(/<li>\s*/g, "<li>")
+    .replace(/\s*<\/li>/g, "</li>");
+}
+
+/**
+ * Special whitespace handling inside <h1..h6> elements
+ *   @param {string} content
+ *   @returns {string}
+ */
+export function trimInsideHeadings(content) {
+  return content
+    .replace(/(<h[1-6][^>]*>)\s*/g, "$1")
+    .replace(/\s*(<\/h[1-6]>)/g, "$1");
+}
+
+/**
+ * @param {string} content
+ * @returns {Promise<string>}
+ */
+export function formatWithPrettier(content) {
+  return prettier.format(content, {
+    parser: "html",
+    tabWidth: 2,
+    useTabs: false,
+    printWidth: 80,
+    htmlWhitespaceSensitivity: "css",
+  });
+}
+
 /**
  * @param {String} filepath
  */
@@ -119,20 +174,21 @@ async function formatWPBlockPattern(filepath) {
     const startTime = process.hrtime.bigint();
     const rawFile = await readFile(filepath, "utf8");
 
-    const formattedHTML = await prettier.format(rawFile, {
-      parser: "html",
-      tabWidth: 0,
-      useTabs: false,
-      printWidth: 80,
-      htmlWhitespaceSensitivity: "css",
-    });
-
-    const cleanedWhiteSpace = normalizeCommentTagSpacing(formattedHTML);
-    const formattedCommentsJSON = formatAllWpComments(cleanedWhiteSpace);
-    const finalFormatted =
-      formattedCommentsJSON.replace(/\n{3,}/g, "\n\n").trim() + "\n";
+    const formatters = [
+      formatWithPrettier,
+      normalizeCommentTagSpacing,
+      formatAllWpComments,
+      trimInsideListElements,
+      trimInsideHeadings,
+      normalizeNewlines,
+    ];
+
+    const outputHtml = await formatters.reduce(
+      async (acc, fn) => fn(await acc),
+      Promise.resolve(rawFile),
+    );
 
-    await writeFile(filepath, finalFormatted, "utf8");
+    await writeFile(filepath, outputHtml, "utf8");
     const endTime = process.hrtime.bigint();
     const duration = Number(endTime - startTime);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ideasonpurpose/build-tools-wordpress",
-  "version": "2.6.3",
+  "version": "2.6.6",
   "description": "Build scripts and dependencies for IOP's WordPress development environments.",
   "homepage": "https://github.com/ideasonpurpose/build-tools-wordpress#readme",
   "bugs": {
@@ -41,13 +41,13 @@
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@svgr/webpack": "^8.1.0",
-    "@wordpress/dependency-extraction-webpack-plugin": "^6.43.0",
+    "@wordpress/dependency-extraction-webpack-plugin": "^6.44.0",
     "ansi-html": "^0.0.9",
     "archiver": "^7.0.1",
     "auto-changelog": "^2.5.0",
-    "autoprefixer": "^10.4.27",
+    "autoprefixer": "^10.5.0",
     "babel-loader": "^10.1.1",
-    "caniuse-lite": "^1.0.30001785",
+    "caniuse-lite": "^1.0.30001791",
     "chalk": "^5.6.2",
     "chalk-cli": "^6.0.0",
     "classnames": "^2.5.1",
@@ -56,25 +56,25 @@
     "cosmiconfig": "^9.0.1",
     "cross-env": "^10.1.0",
     "css-loader": "^7.1.4",
-    "cssnano": "^7.1.4",
-    "dotenv": "^17.4.0",
+    "cssnano": "^7.1.7",
+    "dotenv": "^17.4.2",
     "esbuild-loader": "^4.4.3",
-    "eslint": "^10.2.0",
-    "filesize": "^11.0.15",
+    "eslint": "^10.2.1",
+    "filesize": "^11.0.17",
     "fs-extra": "^11.3.4",
     "globby": "^16.2.0",
-    "html-webpack-plugin": "^5.6.6",
+    "html-webpack-plugin": "^5.6.7",
     "http-proxy": "^1.18.1",
     "humanize-duration": "^3.33.2",
     "image-minimizer-webpack-plugin": "^5.0.0",
     "is-text-path": "^3.0.0",
     "lodash": "^4.18.1",
     "mini-css-extract-plugin": "^2.10.2",
-    "ora": "^9.3.0",
-    "postcss": "^8.5.8",
+    "ora": "^9.4.0",
+    "postcss": "^8.5.12",
     "postcss-loader": "^8.2.1",
     "postcss-scss": "^4.0.9",
-    "prettier": "^3.8.1",
+    "prettier": "^3.8.3",
     "pretty-hrtime": "^1.0.3",
     "read-package-up": "^12.0.0",
     "replacestream": "^4.0.3",
@@ -88,10 +88,10 @@
     "style-loader": "^4.0.0",
     "svgo": "^4.0.1",
     "svgo-loader": "^5.0.0",
-    "version-everything": "^0.11.4",
-    "webpack": "^5.105.4",
+    "version-everything": "^0.12.2",
+    "webpack": "^5.106.2",
     "webpack-bundle-analyzer": "^5.3.0",
-    "webpack-dev-middleware": "^8.0.2",
+    "webpack-dev-middleware": "^8.0.3",
     "webpack-dev-server": "^5.2.3",
     "webpack-manifest-plugin": "^6.0.1"
   },
@@ -99,8 +99,8 @@
     "webpack-cli": "^6.0.1"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^4.1.2",
-    "vitest": "^4.1.2"
+    "@vitest/coverage-v8": "^4.1.5",
+    "vitest": "^4.1.5"
   },
   "version-everything": {
     "files": [

package/test/fixtures/format-wp-block-pattern/nested-list.php

@@ -0,0 +1,25 @@
+<!-- wp:list -->
+<ul class="wp-block-list"><!-- wp:list-item -->
+<li>   UL Item 1  </li>
+<!-- /wp:list-item -->
+
+<!-- wp:list-item -->
+<li>UL Item 2<!-- wp:list -->
+<ul class="wp-block-list"><!-- wp:list-item -->
+<li> UL Second level item 3<!-- wp:list -->
+<ul class="wp-block-list">
+
+  <!-- wp:list-item -->
+<li>
+    UL Third level item 4
+</li>
+<!-- /wp:list-item --></ul>
+<!-- /wp:list --></li>
+<!-- /wp:list-item --></ul>
+<!-- /wp:list --></li>
+<!-- /wp:list-item -->
+
+<!-- wp:list-item -->
+<li>UL Item 5</li>
+<!-- /wp:list-item --></ul>
+<!-- /wp:list -->

package/test/fixtures/format-wp-block-pattern/nested-list__formatted.php

@@ -0,0 +1,33 @@
+<!-- wp:list -->
+<ul class="wp-block-list">
+
+<!-- wp:list-item -->
+<li>UL Item 1</li>
+<!-- /wp:list-item -->
+
+<!-- wp:list-item -->
+<li>UL Item 2<!-- wp:list -->
+<ul class="wp-block-list">
+
+<!-- wp:list-item -->
+<li>UL Second level item 3<!-- wp:list -->
+<ul class="wp-block-list">
+
+<!-- wp:list-item -->
+<li>UL Third level item 4</li>
+<!-- /wp:list-item -->
+
+</ul>
+<!-- /wp:list --></li>
+<!-- /wp:list-item -->
+
+</ul>
+<!-- /wp:list --></li>
+<!-- /wp:list-item -->
+
+<!-- wp:list-item -->
+<li>UL Item 5</li>
+<!-- /wp:list-item -->
+
+</ul>
+<!-- /wp:list -->

package/test/format-wp-block-pattern.test.js

@@ -8,6 +8,7 @@ import {
   formatWpCommentJson,
   formatAllWpComments,
   normalizeCommentTagSpacing,
+  trimInsideListElements,
 } from "../bin/format-wp-block-pattern.js";
 
 describe("Format JSON in WP Block comments", () => {
@@ -36,16 +37,20 @@ describe("Format JSON in WP Block comments", () => {
   });
 
   test("Return short JSON for two-key wp:* comments", async () => {
-    const input = '<!-- wp:group {  "align": "full", "className": "group-name"} -->';
-    const expected = '<!-- wp:group {"align":"full","className":"group-name"} -->';
+    const input =
+      '<!-- wp:group {  "align": "full", "className": "group-name"} -->';
+    const expected =
+      '<!-- wp:group {"align":"full","className":"group-name"} -->';
 
     const actual = formatWpCommentJson(input);
     expect(actual).toBe(expected);
   });
 
   test("Prettyprint three-key wp:* comments", async () => {
-    const input = '<!-- wp:group {  "align": "full","isLink":true, "className": "group-name"} -->';
-    const expected = '<!-- wp:group {\n  "align": "full",\n  "isLink": true,\n  "className": "group-name"\n} -->';
+    const input =
+      '<!-- wp:group {  "align": "full","isLink":true, "className": "group-name"} -->';
+    const expected =
+      '<!-- wp:group {\n  "align": "full",\n  "isLink": true,\n  "className": "group-name"\n} -->';
 
     const actual = formatWpCommentJson(input);
     expect(actual).toBe(expected);
@@ -84,7 +89,6 @@ describe("Format WP Block Patterns", () => {
   });
 });
 
-
 describe("Normalize whitespace", () => {
   test("Fix Comment tag spacing", async () => {
     const input = (
@@ -96,7 +100,21 @@ describe("Normalize whitespace", () => {
     const actual = normalizeCommentTagSpacing(input);
     expect(actual).toMatch(/<\/div>\n<!-- \/wp:group -->/);
   });
-});
 
+  test("List handling", async () => {
+    const input = (
+      await readFile("./test/fixtures/format-wp-block-pattern/nested-list.php")
+    ).toString();
+
+        const expected = (
+      await readFile("./test/fixtures/format-wp-block-pattern/nested-list__formatted.php")
+    ).toString();
+
+    const actual = trimInsideListElements(input);
+        expect(actual).toMatch(/<li>UL/);
+
+    expect(actual).toBe(expected);
+  });
+});
 
-// {"align":"full","className":"group-name"}
+// {"align":"full","className":"group-name"}