fix: escape spaces in executable path

for #1, #15

Author: Luke-zhang-04

.github/workflows/CI.yml

@@ -25,3 +25,6 @@ jobs:
 
       - name: check with prettier
         run: yarn prettier . --check
+
+      - name: test
+        run: yarn test

__tests__/index.js

@@ -0,0 +1,63 @@
+import {escapeExecutablePath} from "../src/utils/escapePath"
+
+describe("test path escape", () => {
+    it("should escape Windows path with space", () => {
+        const originalPath = "C:\\Program Files\\processing\\processing-java"
+
+        expect(escapeExecutablePath(originalPath)).toBe(
+            "C:\\Program` Files\\processing\\processing-java",
+        )
+    })
+
+    it("should escape Unix path with space", () => {
+        const originalPath = "/usr/bin/something else/processing-java"
+
+        expect(escapeExecutablePath(originalPath)).toBe(
+            "/usr/bin/something\\ else/processing-java",
+        )
+    })
+
+    it("should leave Windows path without spaces as is", () => {
+        const originalPath = ".\\processing\\processing-java"
+
+        expect(escapeExecutablePath(originalPath)).toBe(".\\processing\\processing-java")
+    })
+
+    it("should leave Unix path without spaces as is", () => {
+        const originalPath = "/usr/bin/processing-java"
+
+        expect(escapeExecutablePath(originalPath)).toBe("/usr/bin/processing-java")
+    })
+
+    it("should not escape already escaped spaces on Windows", () => {
+        const originalPath = "C:\\Program` Files\\processing\\processing java"
+
+        expect(escapeExecutablePath(originalPath)).toBe(
+            "C:\\Program` Files\\processing\\processing` java",
+        )
+    })
+
+    it("should not escape already escaped spaces on Unix", () => {
+        const originalPath = "/usr/bin/something else/processing\\ java"
+
+        expect(escapeExecutablePath(originalPath)).toBe(
+            "/usr/bin/something\\ else/processing\\ java",
+        )
+    })
+
+    it("should detect platform if no path seperators available", () => {
+        const originalPath = "processing java"
+
+        if (process.platform === "win32") {
+            expect(escapeExecutablePath(originalPath)).toBe("processing` java")
+        } else {
+            expect(escapeExecutablePath(originalPath)).toBe("processing\\ java")
+        }
+    })
+
+    it("should leave single path as is", () => {
+        const originalPath = "processing-java"
+
+        expect(escapeExecutablePath(originalPath)).toBe("processing-java")
+    })
+})

__tests__/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

jest.config.js

@@ -0,0 +1,7 @@
+/**
+ * @type {import("ts-jest/dist/types").InitialOptionsTsJest}
+ */
+module.exports = {
+    preset: "ts-jest",
+    testEnvironment: "node",
+}

package.json

@@ -15,6 +15,7 @@
     "vscode": "^1.48.0"
   },
   "scripts": {
+    "test": "node --experimental-vm-modules --experimental-specifier-resolution=node node_modules/.bin/jest",
     "build": "rollup -c rollup.config.js",
     "deploy": "vsce publish",
     "format": "prettier . --write && eslint --ext ts --fix --cache",
@@ -35,6 +36,7 @@
     "@rollup/plugin-node-resolve": "^13.0.0",
     "@rollup/plugin-typescript": "^8.2.1",
     "@types/glob": "^7.1.4",
+    "@types/jest": "^27.0.3",
     "@types/jsdom": "^16.2.13",
     "@types/node": "^16.3.1",
     "@types/node-fetch": "^2.5.11",
@@ -44,6 +46,7 @@
     "eslint": "^7.30.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "glob": "^7.1.7",
+    "jest": "^27.4.5",
     "jsdom": "^16.6.0",
     "node-fetch": "^2.6.1",
     "prettier": "^2.3.2",
@@ -52,6 +55,7 @@
     "rollup": "^2.53.0",
     "rollup-plugin-progress": "^1.1.2",
     "rollup-plugin-terser": "^7.0.2",
+    "ts-jest": "^27.1.2",
     "tslib": "^2.3.0",
     "typescript": "~4.3.5",
     "vsce": "^1.95.1",

src/config.ts

@@ -5,6 +5,7 @@
  */
 
 import vscode from "vscode"
+import {escapeExecutablePath} from "./utils"
 
 const getProcessingCommand = (): string => {
     // Look for processing.processingPath, then processing.path, then default to processing-java
@@ -23,7 +24,7 @@ const getProcessingCommand = (): string => {
         return "processing-java"
     }
 
-    return config
+    return escapeExecutablePath(config)
 }
 
 const getJavaCommand = (): string => {

src/utils/escapePath.ts

@@ -0,0 +1,24 @@
+/**
+ * Processing-vscode - Processing Language Support for VSCode
+ *
+ * @copyright (C) 2021 Luke Zhang
+ */
+
+export const escapeExecutablePath = (pathName: string): string => {
+    if (!/ /gu.test(pathName)) {
+        return pathName
+    }
+
+    let isWindowsPath = /[a-zA-Z]:[\\\/](?:[a-zA-Z0-9]+[\\\/])*([a-zA-Z0-9]+)/gu.test(pathName)
+
+    if (!/[\\/]/gu.test(pathName)) {
+        isWindowsPath = process.platform === "win32"
+    }
+
+    if (isWindowsPath) {
+        // Windows path
+        return pathName.replace(/(?<!`) /gu, "` ")
+    }
+
+    return pathName.replace(/(?<!\\) /gu, "\\ ")
+}

src/utils/index.ts

@@ -5,6 +5,7 @@
  */
 
 export * as search from "./search"
+export {escapeExecutablePath} from "./escapePath"
 
 export const isValidProcessingProject = (path?: string): boolean =>
     path !== undefined && /^[/_$a-z][/\w$]*$/iu.test(path)