Port the SafeTransformer class

Author: Cédric Belin

lib/index.d.ts

@@ -1,4 +1,6 @@
 import {Transform} from "node:stream";
+export * from "./safe_transformer.js";
+export * from "./transformer.js";
 
 /**
  * Defines the options of a {@link GulpPlugin} instance.

lib/safe_transformer.d.ts

@@ -0,0 +1,31 @@
+import {Transformer} from "./transformer.js";
+
+/**
+ * Removes comments and whitespace from a PHP script, by calling a PHP process.
+ */
+export class SafeTransformer implements Transformer {
+
+	/**
+	 * The path to the PHP executable.
+	 */
+	executable: string;
+
+	/**
+	 * Creates a new safe transformer.
+	 * @param executable The path to the PHP executable.
+	 */
+	constructor(executable?: string);
+
+	/**
+	 * Closes this transformer and releases any resources associated with it.
+	 * @returns Resolves when the transformer is finally disposed.
+	 */
+	close(): Promise<void>;
+
+	/**
+	 * Processes a PHP script.
+	 * @param file The path to the PHP script.
+	 * @returns The transformed script.
+	 */
+	transform(file: string): Promise<string>;
+}

lib/transformer.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Removes comments and whitespace from a PHP script.
+ */
+export interface Transformer {
+
+	/**
+	 * Closes this transformer and releases any resources associated with it.
+	 * @returns Resolves when the transformer is finally disposed.
+	 */
+	close(): Promise<void>;
+
+	/**
+	 * Processes a PHP script.
+	 * @param file The path to the PHP script.
+	 * @returns The transformed script.
+	 */
+	transform(file: string): Promise<string>;
+}

src/index.coffee

@@ -0,0 +1 @@
+export * from "./safe_transformer.js"

src/safe_transformer.coffee

@@ -0,0 +1,21 @@
+import {execFile} from "node:child_process"
+import {normalize, resolve} from "node:path"
+import {promisify} from "node:util"
+
+# Spawns a new process using the specified command.
+run = promisify execFile
+
+# Removes comments and whitespace from a PHP script, by calling a PHP process.
+export class SafeTransformer
+
+	# Creates a new safe transformer.
+	constructor: (executable = "php") ->
+
+		# The path to the PHP executable.
+		@executable = normalize executable
+
+	# Closes this transformer and releases any resources associated with it.
+	close: -> Promise.resolve()
+
+	# Processes a PHP script.
+	transform: (file) -> (await run @executable, ["-w", resolve file], maxBuffer: 20 * 1024 * 1024).stdout

test/safe_transformer_test.coffee

@@ -0,0 +1,27 @@
+import {SafeTransformer} from "@cedx/php-minifier"
+import {doesNotReject, ok} from "node:assert/strict"
+import {after, describe, it} from "node:test"
+
+# Tests the features of the `SafeTransformer` class.
+describe "SafeTransformer", ->
+	describe "close()", ->
+		it "should not reject, even if called several times", ->
+			transformer = new SafeTransformer
+			await doesNotReject transformer.close()
+			await doesNotReject transformer.close()
+
+	describe "transform()", ->
+		map = new Map([
+			["should remove the inline comments", "<?= 'Hello World!' ?>"]
+			["should remove the multi-line comments", "namespace dummy; class Dummy"]
+			["should remove the single-line comments", "$className = get_class($this); return $className;"]
+			["should remove the whitespace", "__construct() { $this->property"]
+		])
+
+		script = "res/sample.php"
+		transformer = new SafeTransformer
+		after -> transformer.close()
+
+		for [key, value] from map then it key, ->
+			output = await transformer.transform script
+			ok output.includes value