@ideasonpurpose/build-tools-wordpress 2.1.4 → 2.1.5

package/CHANGELOG.md

@@ -4,6 +4,13 @@ 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.4
+
+> 16 April 2025
+
+- use look-behind and look-forward to allow overlaps, simplify replacements
+- fix README
+
 #### v2.1.3
 
 > 16 April 2025

package/README.md

@@ -1,6 +1,6 @@
 # @ideasonpurpose/build-tools-wordpress
 
-#### Version 2.1.4
+#### Version 2.1.5
 
 [![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

@@ -73,6 +73,7 @@ export function tokenizeHTML(htmlContent) {
   /**
    * special case followup for open-ended PHP tags at the end of the document
    * TODO: Merge this back up into a single pattern
+   *       Q. Is the 'm' flag breaking the meaning of ^ and $?
    */
   tokenizedHTML = tokenizedHTML.replace(
     /(?<=((?:[^\s]|\s|^)\s*))(<\?(?:php|=).*$)/gms,
@@ -93,10 +94,13 @@ export function tokenizeHTML(htmlContent) {
   return { tokenizedHTML, phpCodeBlocks };
 }
 
-export function unTokenizeHTML(htmlContent, tokens) {
-  let phpContent = htmlContent;
-  for (const token in tokens) {
-    phpContent = phpContent.replace(new RegExp(token, "g"), tokens[token]);
+export function unTokenizeHTML(tokenizedHTML, phpCodeBlocks) {
+  let phpContent = tokenizedHTML;
+  for (const token in phpCodeBlocks) {
+    phpContent = phpContent.replace(
+      new RegExp(token, "g"),
+      phpCodeBlocks[token].replace(/\$/g, "$$$$"),
+    );
   }
   return phpContent;
 }

package/lib/AfterDoneReporterPlugin.js

@@ -54,7 +54,7 @@ export class AfterDoneReporterPlugin {
 
         setTimeout(() =>
           // console.log("\n" + this.config.prefix + " " + messages),
-          console.log( "⚙️ " + messages),
+          console.log( "🚧  " + messages),
         );
 
         setTimeout(() => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ideasonpurpose/build-tools-wordpress",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "description": "Build scripts and dependencies for IOP's WordPress development environments.",
   "homepage": "https://github.com/ideasonpurpose/build-tools-wordpress#readme",
   "bugs": {

package/test/fixtures/format-php-prettier/regex-string-bug.php

@@ -0,0 +1,4 @@
+<?php
+$a = 'a $';
+$b = 'b $&';
+$c = '$0 $1 $2 $3';

package/test/format-php-prettier.test.js

@@ -4,7 +4,7 @@ import { describe, expect, test } from "vitest";
 
 import { readFile } from "node:fs/promises";
 
-import { tokenizeHTML } from "../bin/format-php-prettier.js";
+import { tokenizeHTML, unTokenizeHTML } from "../bin/format-php-prettier.js";
 
 describe("HTML-PHP Prettier", () => {
   test("All tokens exist", async () => {
@@ -48,7 +48,6 @@ describe("HTML-PHP Prettier", () => {
     expect(tokens).toHaveLength(1);
   });
 
-
   test("bare attribute in tag", async () => {
     const input = (
       await readFile(
@@ -68,4 +67,22 @@ describe("HTML-PHP Prettier", () => {
 
     expect(tokens).toHaveLength(5);
   });
+
+  /**
+   * If code blocks contain JS capture-group replacement strings
+   * those strings will vanish from the output.
+   */
+  test("$ capture group references bug", async () => {
+    const input = (
+      await readFile("./test/fixtures/format-php-prettier/regex-string-bug.php")
+    ).toString();
+
+    const { tokenizedHTML, phpCodeBlocks } = tokenizeHTML(input);
+
+    const formattedContent = unTokenizeHTML(tokenizedHTML, phpCodeBlocks);
+
+    expect(formattedContent).toContain("'a $'");
+    expect(formattedContent).toContain("'b $&'");
+    expect(formattedContent).toContain("'$0 $1 $2 $3'");
+  });
 });