Fix Running Executables With Spaces (#44)

This commit adds support for running PHPCS
executables that have spaces in them. We break
the executable apart on spaces, with support
for quoted strings. The first segment is the
executable while the rest are arguments to pass.

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Fixed
+- `phpCodeSniffer.executable` options with spaces throwing errors.
 
 ## [1.5.0] - 2021-12-10
 ### Fixed

src/phpcs-report/__tests__/worker.spec.ts

@@ -192,4 +192,27 @@ describe('Worker', () => {
 		expect(onActiveChanged).toHaveBeenCalledTimes(2);
 		expect(onActiveChanged).toHaveBeenLastCalledWith(worker);
 	});
+
+	it('should support executables with spaces', async () => {
+		const worker = new Worker();
+
+		const request: Request<ReportType.Diagnostic> = {
+			type: ReportType.Diagnostic,
+			documentPath: 'Test.php',
+			documentContent: '<?php class Test {}',
+			options: {
+				workingDirectory: __dirname,
+				// Adding the PHP executable won't break the PHPCS script.
+				executable: '/usr/bin/env php ' + phpcsPath,
+				standard: StandardType.PSR12,
+			},
+			data: null,
+		};
+
+		const response = await worker.execute(request);
+
+		expect(response).toHaveProperty('type', ReportType.Diagnostic);
+		expect(response).toHaveProperty('report');
+		expect(response.report).not.toBeUndefined();
+	});
 });

src/phpcs-report/worker.ts

@@ -179,6 +179,24 @@ export class Worker {
 			'1',
 		];
 
+		// Since the executable may also include arguments, we need to break the given option
+		// apart and track the specific process and add the args to the array we will use
+		// to spawn the process. We will break on spaces but also support quoted strings.
+		const executableMatches = request.options.executable.match( /`((?:[^`\\]|\\`)*)`|'((?:[^'\\]|\\')*)'|"((?:[^"\\]|\\")*)"|([^\s"]+)/g );
+		if (!executableMatches) {
+			throw new Error('No executable was given.');
+		}
+
+		// The first segment will always be the executable.
+		const executable = executableMatches.shift();
+		if (!executable) {
+			throw new Error('No executable was given.');
+		}
+
+		// Any remaining matches will be arguments that we pass to the executable.
+		// Make sure to add them to the front so it runs PHPCS correctly.
+		processArguments.unshift(...executableMatches);
+
 		// Only set the standard when the user has selected one.
 		if (request.options.standard !== StandardType.Default) {
 			processArguments.push('--standard=' + request.options.standard);
@@ -203,7 +221,7 @@ export class Worker {
 
 		// Create a new process to fetch the report.
 		const phpcsProcess = spawn(
-			request.options.executable,
+			executable,
 			processArguments,
 			processOptions
 		);