@10up/wp-vite-plugins 1.0.0-alpha.2 → 1.0.0-alpha.4

package/dist/php/wp-vite-dev-server/HotFile.php

@@ -0,0 +1,95 @@
+<?php
+/**
+ * HotFile class.
+ *
+ * @package TenUp\WpViteDevServer
+ */
+
+declare( strict_types = 1 );
+
+namespace TenUp\WpViteDevServer;
+
+/**
+ * The hot file a running Vite dev server writes next to the bridge
+ * (`.wp-vite-dev.json`): where the server is, and which of its plugins PHP
+ * has to react to.
+ *
+ * Its presence is the whole protocol. The dev server writes it on
+ * 'listening' and deletes it on exit, so reading it is one `file_exists()`
+ * when no server is running.
+ */
+final class HotFile {
+
+	/**
+	 * Create a hot file from its already-normalized values.
+	 *
+	 * @param string   $origin  Dev-server origin, without a trailing slash.
+	 * @param string   $base    Vite's `base`, with a leading and trailing slash.
+	 * @param string[] $plugins Names of the dev-server plugins PHP reacts to.
+	 *
+	 * @phpstan-param non-empty-string $origin
+	 */
+	public function __construct(
+		public readonly string $origin,
+		public readonly string $base,
+		public readonly array $plugins,
+	) {}
+
+	/**
+	 * Read and normalize a hot file.
+	 *
+	 * @param string $path Absolute path of the hot file.
+	 * @return self|null Null when the file is missing or has no usable origin.
+	 */
+	public static function read( string $path ): ?self {
+		if ( ! file_exists( $path ) ) {
+			return null;
+		}
+
+		// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+		$contents = file_get_contents( $path );
+		$decoded  = is_string( $contents ) ? json_decode( $contents, true ) : null;
+
+		$origin = is_array( $decoded ) && isset( $decoded['origin'] ) && is_string( $decoded['origin'] ) ? rtrim( $decoded['origin'], '/' ) : '';
+
+		if ( '' === $origin ) {
+			return null;
+		}
+
+		$base = isset( $decoded['base'] ) && is_string( $decoded['base'] ) ? $decoded['base'] : '/';
+		$base = '/' . ltrim( $base, '/' );
+		if ( ! str_ends_with( $base, '/' ) ) {
+			$base .= '/';
+		}
+
+		$plugins = isset( $decoded['plugins'] ) && is_array( $decoded['plugins'] ) ? $decoded['plugins'] : array();
+
+		return new self(
+			$origin,
+			$base,
+			array_values( array_filter( $plugins, 'is_string' ) )
+		);
+	}
+
+	/**
+	 * The URL the dev server serves a project-relative path at.
+	 *
+	 * @param string $path Project-relative path, e.g. an `.asset.php` 'source'.
+	 * @return string
+	 *
+	 * @phpstan-return non-empty-string
+	 */
+	public function url( string $path ): string {
+		return $this->origin . $this->base . ltrim( $path, '/' );
+	}
+
+	/**
+	 * Whether the dev server reported a plugin by name.
+	 *
+	 * @param string $name Plugin name, e.g. 'vite:react-refresh'.
+	 * @return bool
+	 */
+	public function has_plugin( string $name ): bool {
+		return in_array( $name, $this->plugins, true );
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@10up/wp-vite-plugins",
-	"version": "1.0.0-alpha.2",
+	"version": "1.0.0-alpha.4",
 	"description": "Vite plugins for building modern WordPress projects the 10up way.",
 	"keywords": [
 		"vite",
@@ -18,79 +18,52 @@
 	"license": "GPL-2.0-or-later",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/10up/wp-vite-plugins.git"
+		"url": "git+https://github.com/10up/wp-tooling.git",
+		"directory": "packages/wp-vite-plugins"
 	},
 	"bugs": {
-		"url": "https://github.com/10up/wp-vite-plugins/issues"
+		"url": "https://github.com/10up/wp-tooling/issues"
 	},
-	"homepage": "https://github.com/10up/wp-vite-plugins#readme",
+	"homepage": "https://github.com/10up/wp-tooling/tree/trunk/packages/wp-vite-plugins#readme",
 	"type": "module",
 	"exports": {
 		".": {
 			"types": "./dist/index.d.ts",
 			"default": "./dist/index.js"
 		},
-		"./build": {
-			"types": "./dist/build.d.ts",
-			"default": "./dist/build.js"
-		},
-		"./watch": {
-			"types": "./dist/watch.d.ts",
-			"default": "./dist/watch.js"
-		},
 		"./package.json": "./package.json"
 	},
 	"types": "./dist/index.d.ts",
-	"bin": {
-		"wp-vite": "./dist/cli.js"
-	},
 	"files": [
 		"dist",
 		"README.md",
 		"LICENSE"
 	],
 	"publishConfig": {
-		"access": "public",
-		"tag": "beta"
+		"access": "public"
 	},
 	"engines": {
-		"node": ">=20.11"
+		"node": "^22.18.0 || ^24.11.0 || >=26.0.0"
 	},
 	"scripts": {
-		"build": "tsup",
-		"dev": "tsup --watch",
-		"test": "vitest run",
-		"test:watch": "vitest",
-		"lint": "eslint .",
-		"format": "prettier --write \"src/**/*.{ts,js,json}\"",
-		"typecheck": "tsc --noEmit",
-		"prepublishOnly": "npm run build",
-		"changeset": "changeset",
-		"prepare": "husky"
+		"build": "vp pack",
+		"dev": "vp pack --watch",
+		"test": "vp test run",
+		"test:watch": "vp test",
+		"prepublishOnly": "npm run build"
 	},
 	"dependencies": {
-		"es-module-lexer": "^2.1.0",
+		"browserslist": "^4.29.5",
+		"es-module-lexer": "^3.0.4",
 		"fast-glob": "^3.3.3",
-		"magic-string": "^0.30.21"
+		"lightningcss": "^1.33.0",
+		"magic-string": "^1.4.5"
 	},
 	"peerDependencies": {
-		"vite": "^8.0.0"
+		"vite": "^8.0.0 || ^1.0.0"
 	},
 	"devDependencies": {
-		"@changesets/cli": "^2.27.0",
-		"@eslint/js": "^9.0.0",
-		"@types/node": "^22.0.0",
-		"@typescript-eslint/eslint-plugin": "^8.0.0",
-		"@typescript-eslint/parser": "^8.0.0",
-		"eslint": "^9.0.0",
-		"eslint-config-prettier": "^9.1.0",
-		"globals": "^17.6.0",
-		"husky": "^9.1.0",
-		"lint-staged": "^15.2.0",
-		"prettier": "^3.3.0",
-		"tsup": "^8.3.0",
-		"typescript": "^5.6.0",
-		"vite": "^8.0.0",
-		"vitest": "^4.1.8"
+		"@arethetypeswrong/core": "^0.18.5",
+		"publint": "^0.3.25"
 	}
 }

package/dist/build.d.ts

@@ -1,13 +0,0 @@
-import { R as RunnerOptions } from './runner-WUYCS-nx.js';
-export { B as BIN_CANDIDATES, D as DEFAULT_BUILD_ARGS, a as DEFAULT_WATCH_ARGS, b as DetectModulePassOptions, L as LinePrefixer, M as ModulePassDetection, O as OutputSink, P as ParsedCliArgs, c as PassName, d as ResolvedBin, e as RunnerName, f as RunnerSignal, g as cleanOutDir, h as createLinePrefixer, i as detectModulePass, p as parseCliArgs, r as resolveViteBin } from './runner-WUYCS-nx.js';
-
-/** Options for `build()`. Identical to `watch()`'s — see `RunnerOptions`. */
-type BuildOptions = RunnerOptions;
-/**
- * Run both passes in order. Resolves with the process exit code: `0` when
- * every pass succeeded, the failing pass' code when one didn't, `128 + signo`
- * (`130` for SIGINT) when interrupted.
- */
-declare function build(options?: BuildOptions): Promise<number>;
-
-export { type BuildOptions, RunnerOptions, build };

package/dist/build.js

@@ -1,396 +0,0 @@
-import { spawn } from 'child_process';
-import { existsSync, readFileSync } from 'fs';
-import { rm } from 'fs/promises';
-import { resolve, join, parse, dirname, isAbsolute, sep } from 'path';
-
-// src/runner.ts
-var DEFAULT_BUILD_ARGS = ["build", "--no-emptyOutDir", "--no-clearScreen"];
-var DEFAULT_WATCH_ARGS = ["build", "--watch", "--no-emptyOutDir", "--no-clearScreen"];
-var BIN_CANDIDATES = ["vite", "vp"];
-function spawnPass(options) {
-  const { pass, stdout, stderr } = options;
-  const child = spawn(options.bin, options.argv, {
-    cwd: options.cwd,
-    env: {
-      ...process.env,
-      ...options.env,
-      WP_VITE_RUNNER: options.runner,
-      WP_VITE_PASS: pass,
-      // Kept for the documented watch-only guard:
-      // `emptyOutDir: !isModulePass && !process.env.WP_VITE_UNIFIED_WATCH`.
-      ...options.runner === "watch" ? { WP_VITE_UNIFIED_WATCH: "1" } : {}
-    },
-    stdio: ["ignore", "pipe", "pipe"],
-    // .cmd shims are not directly executable on Windows.
-    shell: process.platform === "win32"
-  });
-  const outPrefixer = createLinePrefixer(`[${pass}] `, (text) => stdout.write(text));
-  const errPrefixer = createLinePrefixer(`[${pass}] `, (text) => stderr.write(text));
-  child.stdout?.setEncoding("utf8");
-  child.stdout?.on("data", (chunk) => outPrefixer.write(chunk));
-  child.stderr?.setEncoding("utf8");
-  child.stderr?.on("data", (chunk) => errPrefixer.write(chunk));
-  const result = new Promise((settle) => {
-    let settled = false;
-    const finish = (passResult) => {
-      if (settled) return;
-      settled = true;
-      outPrefixer.flush();
-      errPrefixer.flush();
-      settle(passResult);
-    };
-    child.on("error", (error) => {
-      stderr.write(`[wp-vite] the ${pass} pass failed to start: ${error.message}
-`);
-      finish({ pass, code: null, signal: null, error });
-    });
-    child.on("close", (code, signal) => finish({ pass, code, signal }));
-  });
-  return { pass, child, result };
-}
-function passArgs(base, pass, modulesMode, extra = []) {
-  return [...base, ...pass === "modules" ? ["--mode", modulesMode] : [], ...extra];
-}
-function forwardSignals(handler) {
-  const bound = ["SIGINT", "SIGTERM"].map(
-    (signal) => [signal, () => handler(signal)]
-  );
-  for (const [signal, listener] of bound) process.on(signal, listener);
-  return () => {
-    for (const [signal, listener] of bound) process.off(signal, listener);
-  };
-}
-function describeExit(code, signal) {
-  if (signal) return `signal ${signal}`;
-  if (code === null) return "unknown cause";
-  return `exit code ${code}`;
-}
-var SIGNAL_EXIT_CODES = {
-  SIGINT: 130,
-  SIGTERM: 143,
-  SIGHUP: 129,
-  SIGQUIT: 131
-};
-function signalExitCode(signal) {
-  if (!signal) return 1;
-  return SIGNAL_EXIT_CODES[signal] ?? 1;
-}
-function passExitCode(result) {
-  if (result.error) return 1;
-  if (result.code !== null) return result.code;
-  return signalExitCode(result.signal);
-}
-var VITE_CONFIG_FILES = [
-  "vite.config.ts",
-  "vite.config.mts",
-  "vite.config.cts",
-  "vite.config.js",
-  "vite.config.mjs",
-  "vite.config.cjs"
-];
-function detectModulePass(options = {}) {
-  if (typeof options.modules === "boolean") {
-    return {
-      modules: options.modules,
-      reason: `explicit --${options.modules ? "modules" : "no-modules"} flag`
-    };
-  }
-  const cwd = resolve(options.cwd ?? process.cwd());
-  const modulesMode = options.modulesMode ?? "modules";
-  const escapedMode = escapeRegExp(modulesMode);
-  const scriptMatch = new RegExp(`(?:--mode[=\\s]+|(?:^|\\s)-m\\s+)${escapedMode}(?![\\w-])`);
-  const packageJson = readJson(join(cwd, "package.json"));
-  const scripts = packageJson?.scripts;
-  if (scripts && typeof scripts === "object") {
-    for (const [name, command] of Object.entries(scripts)) {
-      if (typeof command === "string" && scriptMatch.test(command)) {
-        return {
-          modules: true,
-          reason: `package.json script "${name}" runs --mode ${modulesMode}`
-        };
-      }
-    }
-  }
-  const configMatch = new RegExp(`(['"\`])${escapedMode}\\1`);
-  for (const fileName of VITE_CONFIG_FILES) {
-    const filePath = join(cwd, fileName);
-    const source = readFileIfExists(filePath);
-    if (source === null) continue;
-    if (configMatch.test(source)) {
-      return { modules: true, reason: `${fileName} mentions the "${modulesMode}" mode` };
-    }
-    return {
-      modules: false,
-      reason: `${fileName} never mentions the "${modulesMode}" mode`
-    };
-  }
-  return {
-    modules: false,
-    reason: `no package.json script or Vite config mentions the "${modulesMode}" mode`
-  };
-}
-function resolveViteBin(cwd = process.cwd(), candidates = BIN_CANDIDATES) {
-  const searched = [];
-  for (const binDir of nodeModulesBinDirs(cwd)) {
-    for (const name of candidates) {
-      for (const fileName of binFileNames(name)) {
-        const candidatePath = join(binDir, fileName);
-        searched.push(candidatePath);
-        if (existsSync(candidatePath)) return { name, path: candidatePath };
-      }
-    }
-  }
-  throw new Error(
-    `[wp-vite] could not find a Vite binary (${candidates.join(" or ")}) in any node_modules/.bin above ${cwd}. Install vite in the package, or pass --bin <name|path>. Looked at:
-  ${searched.join("\n  ")}`
-  );
-}
-function resolveBin(bin, cwd) {
-  if (!bin) return resolveViteBin(cwd).path;
-  if (isAbsolute(bin) || bin.includes("/") || bin.includes("\\")) return bin;
-  try {
-    return resolveViteBin(cwd, [bin]).path;
-  } catch {
-    return bin;
-  }
-}
-function nodeModulesBinDirs(from) {
-  const dirs = [];
-  let current = resolve(from);
-  const { root } = parse(current);
-  while (true) {
-    dirs.push(join(current, "node_modules", ".bin"));
-    if (current === root) break;
-    const parent = dirname(current);
-    if (parent === current) break;
-    current = parent;
-  }
-  return dirs;
-}
-function binFileNames(name) {
-  return process.platform === "win32" ? [`${name}.cmd`, name] : [name];
-}
-async function cleanOutDir(outDir = "dist", cwd = process.cwd()) {
-  const base = resolve(cwd);
-  const target = isAbsolute(outDir) ? resolve(outDir) : resolve(base, outDir);
-  if (target === parse(target).root || target === base || !target.startsWith(base + sep)) {
-    throw new Error(
-      `[wp-vite] refusing to clean ${target}: the out dir must be inside ${base}`
-    );
-  }
-  await rm(target, { recursive: true, force: true });
-  return target;
-}
-var ESCAPE = String.fromCharCode(27);
-var ERASE_SEQUENCE = new RegExp(`^(?:${ESCAPE}\\[[0-2]?[KJ])+`);
-function createLinePrefixer(prefix, write) {
-  let buffer = "";
-  const emit = (line) => {
-    const withoutCrlf = line.endsWith("\r") ? line.slice(0, -1) : line;
-    const rendered = withoutCrlf.split("\r").pop() ?? "";
-    const content = rendered.replace(ERASE_SEQUENCE, "");
-    write(content.length === 0 ? "\n" : `${prefix}${content}
-`);
-  };
-  return {
-    write(chunk) {
-      buffer += chunk;
-      const lines = buffer.split("\n");
-      buffer = lines.pop() ?? "";
-      for (const line of lines) emit(line);
-    },
-    flush() {
-      if (buffer.length === 0) return;
-      const pending = buffer;
-      buffer = "";
-      emit(pending);
-    }
-  };
-}
-function parseCliArgs(argv) {
-  const parsed = {
-    command: void 0,
-    options: {},
-    help: false,
-    version: false,
-    unknown: []
-  };
-  const passthrough = [];
-  let index = 0;
-  for (; index < argv.length; index += 1) {
-    const arg = argv[index];
-    if (arg === "--") {
-      passthrough.push(...argv.slice(index + 1));
-      break;
-    }
-    if (!arg.startsWith("-")) {
-      if (parsed.command === void 0) parsed.command = arg;
-      else parsed.unknown.push(arg);
-      continue;
-    }
-    const equalsAt = arg.indexOf("=");
-    const flag = equalsAt === -1 ? arg : arg.slice(0, equalsAt);
-    const inlineValue = equalsAt === -1 ? void 0 : arg.slice(equalsAt + 1);
-    const takeValue = () => {
-      if (inlineValue !== void 0) return inlineValue;
-      const next = argv[index + 1];
-      if (next === void 0 || next.startsWith("-")) return void 0;
-      index += 1;
-      return next;
-    };
-    switch (flag) {
-      case "-h":
-      case "--help":
-        parsed.help = true;
-        break;
-      case "-v":
-      case "--version":
-        parsed.version = true;
-        break;
-      case "--out-dir":
-      case "--outDir": {
-        const value = takeValue();
-        if (value === void 0) parsed.unknown.push(`${flag} (missing value)`);
-        else parsed.options.outDir = value;
-        break;
-      }
-      case "--modules-mode":
-      case "--modulesMode": {
-        const value = takeValue();
-        if (value === void 0) parsed.unknown.push(`${flag} (missing value)`);
-        else parsed.options.modulesMode = value;
-        break;
-      }
-      case "--bin": {
-        const value = takeValue();
-        if (value === void 0) parsed.unknown.push(`${flag} (missing value)`);
-        else parsed.options.bin = value;
-        break;
-      }
-      case "--cwd": {
-        const value = takeValue();
-        if (value === void 0) parsed.unknown.push(`${flag} (missing value)`);
-        else parsed.options.cwd = value;
-        break;
-      }
-      case "--modules":
-        parsed.options.modules = true;
-        break;
-      case "--no-modules":
-        parsed.options.modules = false;
-        break;
-      case "--clean":
-        parsed.options.clean = true;
-        break;
-      case "--no-clean":
-        parsed.options.clean = false;
-        break;
-      default:
-        parsed.unknown.push(flag);
-    }
-  }
-  if (passthrough.length > 0) parsed.options.args = passthrough;
-  return parsed;
-}
-async function prepareRun(options, runner) {
-  const cwd = resolve(options.cwd ?? process.cwd());
-  const outDir = options.outDir ?? "dist";
-  const modulesMode = options.modulesMode ?? "modules";
-  const stdout = options.stdout ?? process.stdout;
-  const stderr = options.stderr ?? process.stderr;
-  const bin = resolveBin(options.bin, cwd);
-  const detection = detectModulePass({ cwd, modulesMode, modules: options.modules });
-  const passes = detection.modules ? ["script", "modules"] : ["script"];
-  if (options.clean !== false) {
-    const cleaned = await cleanOutDir(outDir, cwd);
-    stdout.write(`[wp-vite] cleaned ${cleaned}
-`);
-  }
-  stdout.write(
-    `[wp-vite] module pass ${detection.modules ? "enabled" : "disabled"} \u2014 ${detection.reason}; ${"building"} ${passes.join(" then ")} via ${bin}
-`
-  );
-  return { cwd, bin, modulesMode, passes, stdout, stderr };
-}
-function escapeRegExp(value) {
-  return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-}
-function readFileIfExists(filePath) {
-  try {
-    return readFileSync(filePath, "utf8");
-  } catch {
-    return null;
-  }
-}
-function readJson(filePath) {
-  const source = readFileIfExists(filePath);
-  if (source === null) return null;
-  try {
-    return JSON.parse(source);
-  } catch {
-    return null;
-  }
-}
-
-// src/build.ts
-async function build(options = {}) {
-  const { cwd, bin, modulesMode, passes, stdout, stderr } = await prepareRun(options);
-  let current;
-  let interrupted = false;
-  let interruptCode = 0;
-  const disposeSignals = options.handleSignals === false ? () => {
-  } : forwardSignals((signal) => {
-    if (interrupted) return;
-    interrupted = true;
-    interruptCode = signalExitCode(signal);
-    if (current && current.exitCode === null && current.signalCode === null) {
-      current.kill(signal);
-    }
-  });
-  try {
-    for (const [index, pass] of passes.entries()) {
-      if (interrupted) {
-        stderr.write(`[wp-vite] interrupted \u2014 skipping the ${pass} pass
-`);
-        return interruptCode;
-      }
-      const spawned = spawnPass({
-        pass,
-        runner: "build",
-        bin,
-        cwd,
-        argv: passArgs(
-          options.buildArgs ?? DEFAULT_BUILD_ARGS,
-          pass,
-          modulesMode,
-          options.args ?? []
-        ),
-        env: options.env,
-        stdout,
-        stderr
-      });
-      current = spawned.child;
-      const result = await spawned.result;
-      current = void 0;
-      const code = passExitCode(result);
-      if (code === 0) continue;
-      const skipped = passes.slice(index + 1);
-      stderr.write(
-        `[wp-vite] the ${pass} pass failed (${describeExit(result.code, result.signal)})` + (skipped.length > 0 ? ` \u2014 skipping the ${skipped.join(" and ")} pass` : "") + "\n"
-      );
-      return code;
-    }
-    stdout.write(
-      passes.length > 1 ? `[wp-vite] built ${passes.join(" + ")} into one dist
-` : `[wp-vite] built the ${passes[0]} pass
-`
-    );
-    return 0;
-  } finally {
-    disposeSignals();
-  }
-}
-
-export { BIN_CANDIDATES, DEFAULT_BUILD_ARGS, DEFAULT_WATCH_ARGS, build, cleanOutDir, createLinePrefixer, detectModulePass, parseCliArgs, resolveViteBin };
-//# sourceMappingURL=build.js.map
-//# sourceMappingURL=build.js.map