Restore the ITransformer.close() method

Author: cedx

src/FastTransformer.ts

@@ -33,11 +33,20 @@ export class FastTransformer implements ITransformer {
 	}
 
 	/**
-	 * Closes this transformer and releases any resources associated with it.
+	 * Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+	 * Calls the {@link close} method.
 	 * @returns Resolves when the transformer is finally disposed.
 	 */
 	[Symbol.asyncDispose](): Promise<void> {
-		this.#process?.[Symbol.dispose]();
+		return this.close();
+	}
+
+	/**
+	 * Closes this transformer and releases any resources associated with it.
+	 * @returns Resolves when the transformer is finally disposed.
+	 */
+	close(): Promise<void> {
+		this.#process?.kill();
 		this.#process = null;
 		return Promise.resolve();
 	}

src/GulpPlugin.ts

@@ -33,8 +33,8 @@ export class GulpPlugin extends Transform {
 		this.#silent = options.silent ?? false;
 		this.#transformer = (options.mode ?? "safe") == "fast" ? new FastTransformer(binary) : new SafeTransformer(binary);
 
-		const dispose = async (): Promise<void> => { await this.#transformer[Symbol.asyncDispose](); };
-		this.on("end", dispose).on("error", dispose); // eslint-disable-line @typescript-eslint/no-misused-promises
+		const close = async (): Promise<void> => { await this.#transformer.close(); };
+		this.on("end", close).on("error", close); // eslint-disable-line @typescript-eslint/no-misused-promises
 	}
 
 	/**

src/ITransformer.ts

@@ -3,6 +3,12 @@
  */
 export interface ITransformer extends AsyncDisposable {
 
+	/**
+	 * 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.

src/SafeTransformer.ts

@@ -27,10 +27,19 @@ export class SafeTransformer implements ITransformer {
 	}
 
 	/**
-	 * Closes this transformer and releases any resources associated with it.
+	 * Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+	 * Calls the {@link close} method.
 	 * @returns Resolves when the transformer is finally disposed.
 	 */
 	[Symbol.asyncDispose](): Promise<void> {
+		return this.close();
+	}
+
+	/**
+	 * Closes this transformer and releases any resources associated with it.
+	 * @returns Resolves when the transformer is finally disposed.
+	 */
+	close(): Promise<void> {
 		return Promise.resolve();
 	}
 

test/FastTransformerTest.js

@@ -6,12 +6,12 @@ import {after, describe, it} from "node:test";
  * Tests the features of the {@link FastTransformer} class.
  */
 describe("FastTransformer", () => {
-	describe("asyncDispose()", () => {
+	describe("close()", () => {
 		it("should not reject, even if called several times", async () => {
 			const transformer = new FastTransformer;
 			await doesNotReject(transformer.listen());
-			await doesNotReject(transformer[Symbol.asyncDispose]());
-			await doesNotReject(transformer[Symbol.asyncDispose]());
+			await doesNotReject(transformer.close());
+			await doesNotReject(transformer.close());
 		});
 	});
 
@@ -32,7 +32,7 @@ describe("FastTransformer", () => {
 		]);
 
 		const transformer = new FastTransformer;
-		after(() => transformer[Symbol.asyncDispose]());
+		after(() => transformer.close());
 
 		for (const [key, value] of map) it(key, async () => {
       const output = await transformer.transform("res/Sample.php");

test/SafeTransformerTest.js

@@ -6,11 +6,11 @@ import {after, describe, it} from "node:test";
  * Tests the features of the {@link SafeTransformer} class.
  */
 describe("SafeTransformer", () => {
-	describe("asyncDispose()", () => {
+	describe("close()", () => {
 		it("should not reject, even if called several times", async () => {
 			const transformer = new SafeTransformer;
-			await doesNotReject(transformer[Symbol.asyncDispose]());
-			await doesNotReject(transformer[Symbol.asyncDispose]());
+			await doesNotReject(transformer.close());
+			await doesNotReject(transformer.close());
 		});
 	});
 
@@ -23,7 +23,7 @@ describe("SafeTransformer", () => {
 		]);
 
 		const transformer = new SafeTransformer;
-		after(() => transformer[Symbol.asyncDispose]());
+		after(() => transformer.close());
 
 		for (const [key, value] of map) it(key, async () => {
       const output = await transformer.transform("res/Sample.php");