@ideasonpurpose/build-tools-wordpress 2.10.7 → 2.10.9

package/README.md

@@ -1,6 +1,6 @@
 # @ideasonpurpose/build-tools-wordpress
 
-#### Version 2.10.7
+#### Version 2.10.9
 
 [![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/actions/workflows/npm-publish.yml)
@@ -8,7 +8,9 @@
 
 Build scripts and shared dependencies for WordPress development. Used in production at [Ideas On Purpose](https://www.ideasonpurpose.com).
 
-This package centralizes Webpack configuration, asset pipelines, and helper CLIs so host projects stay thin: a small `package.json`, a one-line `webpack.config.js`, and an optional config file.
+This package centralizes Webpack configuration, asset pipelines, and helper CLIs so host projects stay fast and thin: a small `package.json`, a one-line `webpack.config.js`, and an optional config file.
+
+Use with IOP's lightning-fast [Docker-based WordPress development image](https://github.com/ideasonpurpose/docker-wordpress-dev).
 
 ## Requirements
 
@@ -46,14 +48,16 @@ Prettier and Stylelint configs are re-exported from this package’s dependencie
 
 ## Quick start
 
-**1. Point Webpack at this package**
+### 1. Point Webpack at this package
 
 ```js
 // webpack.config.js
 export { webpackConfig as default } from "@ideasonpurpose/build-tools-wordpress";
 ```
 
-**2. Lay out sources** under the default theme paths (package `name` → theme folder):
+### 2. Source files
+
+The project should have these files:
 
 ```text
 wp-content/themes/<package-name>/
@@ -61,18 +65,17 @@ wp-content/themes/<package-name>/
     js/main.js
     js/admin.js
     js/editor.js
-    sass/   # or styles/
-  dist/     # build output
+    styles/      # formerly 'sass'
 ```
 
-**3. Run**
+### 3. Run
 
 ```sh
-npm start          # webpack-dev-server (proxies local WordPress when available)
-NODE_ENV=production npm run build   # production build + zip (if postbuild is set)
+npm run dev
+
 ```
 
-Full IOP projects also use Docker Compose tooling from this package (`tooling/docker-compose.yml`) and scripts like `bootstrap`, `db:dump`, and `project:refresh`. Those are optional if you only need the asset pipeline.
+### 4. Build
 
 ## Configuration
 
@@ -204,6 +207,21 @@ Notes:
 - Custom: remove top-level `fill="none"`
 - `removeUselessStrokeAndFill` with `removeNone: true`
 
+## WP-CLI
+
+The WordPress base image includes [wp-cli](https://wordpress.org/cli/) and all commands can be run on the image using the `wp-cli` npm script. Commands with flags need to include a double-hyphen, but we just include them for everything. These all work as expected:
+
+```sh
+# list users
+npm run wp-cli -- wp user list
+
+# Update to pre-release
+npm run wp-cli -- wp core update --version=7.1-RC4
+
+# Add a user for e2e testing
+wp user create test test@example.com --role=administrator --user_pass=test123
+```
+
 ## CLI tools
 
 | Command                       | Purpose                                                                                                                                                                                 |

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

@@ -27,8 +27,10 @@ import prettier from "prettier";
  *   - wp:gallery
  */
 
-import { readFile, writeFile } from "fs/promises";
-import { resolve, basename } from "path";
+import { realpathSync } from "node:fs";
+import { readFile, writeFile } from "node:fs/promises";
+import { basename, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
 
 /**
  *
@@ -146,7 +148,7 @@ export function trimInsideListElements(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(/<!-- \/wp:list-item -->\s*</g, "<!-- /wp:list-item -->\n\n<")
     .replace(/<li>\s*/g, "<li>")
     .replace(/\s*<\/li>/g, "</li>");
 }
@@ -177,12 +179,10 @@ export function formatWithPrettier(content) {
 }
 
 /**
- * @param {String} filepath
+ * @param {string} content
+ * @returns {Promise<string>}
  */
-export async function formatWPBlockPattern(filepath) {
-  const startTime = process.hrtime.bigint();
-  const rawFile = await readFile(filepath, "utf8");
-
+export async function formatWPBlockPatternContent(content) {
   const formatters = [
     formatWithPrettier,
     normalizeCommentTagSpacing,
@@ -192,10 +192,19 @@ export async function formatWPBlockPattern(filepath) {
     normalizeNewlines,
   ];
 
-  const outputHtml = await formatters.reduce(
+  return formatters.reduce(
     async (acc, fn) => fn(await acc),
-    Promise.resolve(rawFile),
+    Promise.resolve(content),
   );
+}
+
+/**
+ * @param {string} filepath
+ */
+export async function formatWPBlockPattern(filepath) {
+  const startTime = process.hrtime.bigint();
+  const rawFile = await readFile(filepath, "utf8");
+  const outputHtml = await formatWPBlockPatternContent(rawFile);
 
   await writeFile(filepath, outputHtml, "utf8");
   const endTime = process.hrtime.bigint();
@@ -204,11 +213,49 @@ export async function formatWPBlockPattern(filepath) {
   console.log(`${basename(filepath)} ${(duration / 1e6).toFixed(2)}ms`);
 }
 
+/**
+ * @returns {Promise<string>}
+ */
+async function readStdin() {
+  const chunks = [];
+  for await (const chunk of process.stdin) {
+    chunks.push(chunk);
+  }
+  return Buffer.concat(chunks).toString("utf8");
+}
+
 export async function main(filepath = process.argv[2]) {
-  if (!filepath) {
-    console.error("Error: A filepath is required.");
-    return;
+  try {
+    if (filepath) {
+      await formatWPBlockPattern(resolve(filepath));
+      return;
+    }
+
+    if (process.stdin.isTTY) {
+      console.error(
+        "Usage: iop-format-wp-block-pattern <filepath>\n       iop-format-wp-block-pattern < input.php",
+      );
+      process.exitCode = 1;
+      return;
+    }
+
+    const formatted = await formatWPBlockPatternContent(await readStdin());
+    process.stdout.write(formatted);
+  } catch (error) {
+    console.error("Error:", error);
+    process.exitCode = 1;
   }
-  await formatWPBlockPattern(resolve(filepath));
 }
-if (process.argv[2]) main();
+
+const isMain = (() => {
+  if (process.argv[1] == null) return false;
+  try {
+    return (
+      fileURLToPath(import.meta.url) === realpathSync(resolve(process.argv[1]))
+    );
+  } catch {
+    return false;
+  }
+})();
+
+if (isMain) main();

package/bin/format-wp-php.js

@@ -0,0 +1,83 @@
+#!/usr/bin/env node
+
+//@ts-check
+
+import { execFileSync } from "node:child_process";
+import { realpathSync } from "node:fs";
+import { resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const blockPatternPath = /(?:^|\/)wp-content\/themes\/[^/]+\/patterns\/.*\.php$/;
+
+/**
+ * @param {string} filepath
+ * @returns {string}
+ */
+export function getFormatter(filepath) {
+  const normalizedPath = filepath.replaceAll("\\", "/");
+  return blockPatternPath.test(normalizedPath)
+    ? "iop-format-wp-block-pattern"
+    : "format-mixed-php-html";
+}
+
+/**
+ * @param {string[]} args
+ */
+export async function main(args = process.argv.slice(2)) {
+  const fileFlagIndex = args.indexOf("--file");
+  const filepath = args[fileFlagIndex + 1];
+
+  if (fileFlagIndex === -1 || !filepath) {
+    console.error(
+      "Usage: iop-format-wp-php --file <filepath> < input.php",
+    );
+    process.exitCode = 1;
+    return;
+  }
+
+  if (process.stdin.isTTY) {
+    console.error(
+      "Usage: iop-format-wp-php --file <filepath> < input.php",
+    );
+    process.exitCode = 1;
+    return;
+  }
+
+  const formatter = getFormatter(filepath);
+
+  try {
+    const formatted = execFileSync(formatter, [], {
+      input: await readStdin(),
+      encoding: "utf8",
+      stdio: ["pipe", "pipe", "inherit"],
+    });
+    process.stdout.write(formatted);
+  } catch (error) {
+    console.error(`Error running ${formatter}:`, error);
+    process.exitCode = 1;
+  }
+}
+
+/**
+ * @returns {Promise<string>}
+ */
+async function readStdin() {
+  const chunks = [];
+  for await (const chunk of process.stdin) {
+    chunks.push(chunk);
+  }
+  return Buffer.concat(chunks).toString("utf8");
+}
+
+const isMain = (() => {
+  if (process.argv[1] == null) return false;
+  try {
+    return (
+      fileURLToPath(import.meta.url) === realpathSync(resolve(process.argv[1]))
+    );
+  } catch {
+    return false;
+  }
+})();
+
+if (isMain) main();

package/boilerplate/package.json

@@ -55,7 +55,7 @@
     "version": "version-everything && git add -u",
     "postversion": "npm run build",
     "webgrind": "docker compose run --rm --service-ports webgrind",
-    "wp-cli": "docker compose exec -u wp wordpress",
+    "wp-cli": "docker compose exec wordpress",
     "zip": "iop-build-zip-archive"
   },
   "prettier": "@ideasonpurpose/prettier-config",
@@ -63,7 +63,7 @@
     "extends": "@ideasonpurpose/stylelint-config"
   },
   "devDependencies": {
-    "@ideasonpurpose/build-tools-wordpress": "^2.5.1"
+    "@ideasonpurpose/build-tools-wordpress": "^2.10.8"
   },
   "version-everything": {
     "files": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ideasonpurpose/build-tools-wordpress",
-  "version": "2.10.7",
+  "version": "2.10.9",
   "description": "Build scripts and dependencies for IOP's WordPress development environments.",
   "homepage": "https://github.com/ideasonpurpose/build-tools-wordpress#readme",
   "bugs": {
@@ -23,6 +23,7 @@
     "iop-build-zip-archive": "./bin/zip.js",
     "iop-html-php-prettier": "./bin/format-php-prettier.js",
     "iop-format-wp-block-pattern": "./bin/format-wp-block-pattern.js",
+    "iop-format-wp-php": "./bin/format-wp-php.js",
     "iop-project-refresh": "./bin/refresh.js",
     "iop-vscode-svgo": "./bin/vscode-svgo.js"
   },
@@ -42,43 +43,43 @@
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@svgr/webpack": "^8.1.0",
-    "@wordpress/dependency-extraction-webpack-plugin": "^6.51.0",
+    "@wordpress/dependency-extraction-webpack-plugin": "^6.53.0",
     "ansi-html": "^0.0.9",
     "archiver": "^8.0.0",
-    "autoprefixer": "^10.5.3",
+    "autoprefixer": "^10.5.4",
     "babel-loader": "^10.1.1",
-    "caniuse-lite": "^1.0.30001805",
-    "chalk": "^5.6.2",
+    "caniuse-lite": "^1.0.30001809",
+    "chalk": "^6.0.0",
     "chalk-cli": "^6.0.0",
     "classnames": "^2.5.1",
     "cli-truncate": "^6.1.1",
     "copy-webpack-plugin": "^14.0.0",
-    "cosmiconfig": "^9.0.2",
+    "cosmiconfig": "^10.0.0",
     "css-loader": "^7.1.4",
-    "cssnano": "^8.0.2",
+    "cssnano": "^8.0.6",
     "dotenv": "^17.4.2",
     "esbuild-loader": "^4.5.0",
-    "eslint": "^10.7.0",
+    "eslint": "^10.8.1",
     "filesize": "^11.0.22",
-    "fs-extra": "^11.3.6",
-    "globby": "^16.2.1",
-    "html-webpack-plugin": "^5.6.7",
+    "fs-extra": "^11.4.0",
+    "globby": "^16.2.3",
+    "html-webpack-plugin": "^5.6.8",
     "humanize-duration": "^3.34.0",
     "image-minimizer-webpack-plugin": "^5.0.0",
     "is-text-path": "^3.0.0",
     "lodash": "^4.18.1",
     "mini-css-extract-plugin": "^2.10.2",
-    "open": "^11.0.0",
+    "open": "^11.0.1",
     "ora": "^9.4.1",
-    "postcss": "^8.5.19",
+    "postcss": "^8.5.26",
     "postcss-loader": "^8.2.1",
     "postcss-scss": "^4.0.9",
-    "prettier": "^3.9.5",
+    "prettier": "^3.9.6",
     "pretty-hrtime": "^1.0.3",
     "read-package-up": "^12.0.0",
     "replacestream": "^4.0.3",
     "rimraf": "^6.1.3",
-    "sass-embedded": "^1.100.0",
+    "sass-embedded": "^1.102.0",
     "sass-loader": "^17.0.0",
     "semver": "^7.8.5",
     "sharp": "^0.35.3",
@@ -88,9 +89,9 @@
     "svgo": "^4.0.2",
     "svgo-loader": "^5.0.0",
     "version-everything": "^0.12.2",
-    "webpack": "^5.108.4",
+    "webpack": "^5.109.2",
     "webpack-bundle-analyzer": "^5.3.1",
-    "webpack-cli": "^6.0.1",
+    "webpack-cli": "^7.2.2",
     "webpack-dev-server": "^6.0.0",
     "webpack-manifest-plugin": "^6.0.1"
   },
@@ -98,8 +99,8 @@
     "node": ">=22.15.0"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^4.1.10",
-    "vitest": "^4.1.10"
+    "@vitest/coverage-v8": "^4.1.11",
+    "vitest": "^4.1.11"
   },
   "version-everything": {
     "files": [